DESCRIBEMODELCARD()`¶

About DescribeModelCard¶

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

To retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model card Content and requires kms:Decrypt permission when a customer-managed key is configured.

Method Signature¶

METHODS /AWS1/IF_SGM~DESCRIBEMODELCARD
  IMPORTING
    !IV_MODELCARDNAME TYPE /AWS1/SGMMODELCARDNAMEORARN OPTIONAL
    !IV_MODELCARDVERSION TYPE /AWS1/SGMINTEGER OPTIONAL
    !IV_INCLUDEDDATA TYPE /AWS1/SGMINCLUDEDDATA OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmdescrmodelcardrsp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_modelcardname` `TYPE /AWS1/SGMMODELCARDNAMEORARN` `/AWS1/SGMMODELCARDNAMEORARN`¶

The name or Amazon Resource Name (ARN) of the model card to describe.

Optional arguments:¶

`iv_modelcardversion` `TYPE /AWS1/SGMINTEGER` `/AWS1/SGMINTEGER`¶

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

`iv_includeddata` `TYPE /AWS1/SGMINCLUDEDDATA` `/AWS1/SGMINCLUDEDDATA`¶

Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

If you don't specify a value, SageMaker returns AllData.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmdescrmodelcardrsp` `/AWS1/CL_SGMDESCRMODELCARDRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describemodelcard(
  iv_includeddata = |string|
  iv_modelcardname = |string|
  iv_modelcardversion = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_modelcardarn = lo_result->get_modelcardarn( ).
  lv_entityname = lo_result->get_modelcardname( ).
  lv_integer = lo_result->get_modelcardversion( ).
  lv_modelcardcontent = lo_result->get_content( ).
  lv_modelcardstatus = lo_result->get_modelcardstatus( ).
  lo_modelcardsecurityconfig = lo_result->get_securityconfig( ).
  IF lo_modelcardsecurityconfig IS NOT INITIAL.
    lv_kmskeyid = lo_modelcardsecurityconfig->get_kmskeyid( ).
  ENDIF.
  lv_timestamp = lo_result->get_creationtime( ).
  lo_usercontext = lo_result->get_createdby( ).
  IF lo_usercontext IS NOT INITIAL.
    lv_string = lo_usercontext->get_userprofilearn( ).
    lv_string = lo_usercontext->get_userprofilename( ).
    lv_string = lo_usercontext->get_domainid( ).
    lo_iamidentity = lo_usercontext->get_iamidentity( ).
    IF lo_iamidentity IS NOT INITIAL.
      lv_string = lo_iamidentity->get_arn( ).
      lv_string = lo_iamidentity->get_principalid( ).
      lv_string = lo_iamidentity->get_sourceidentity( ).
    ENDIF.
  ENDIF.
  lv_timestamp = lo_result->get_lastmodifiedtime( ).
  lo_usercontext = lo_result->get_lastmodifiedby( ).
  IF lo_usercontext IS NOT INITIAL.
    lv_string = lo_usercontext->get_userprofilearn( ).
    lv_string = lo_usercontext->get_userprofilename( ).
    lv_string = lo_usercontext->get_domainid( ).
    lo_iamidentity = lo_usercontext->get_iamidentity( ).
    IF lo_iamidentity IS NOT INITIAL.
      lv_string = lo_iamidentity->get_arn( ).
      lv_string = lo_iamidentity->get_principalid( ).
      lv_string = lo_iamidentity->get_sourceidentity( ).
    ENDIF.
  ENDIF.
  lv_modelcardprocessingstat = lo_result->get_modelcardprocingstatus( ).
ENDIF.

/AWS1/IF_SGM=>DESCRIBEMODELCARD()¶