Skip to content

/AWS1/CL_SGMDESCRMODELCARDRSP

DescribeModelCardResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_modelcardarn TYPE /AWS1/SGMMODELCARDARN /AWS1/SGMMODELCARDARN

The Amazon Resource Name (ARN) of the model card.

iv_modelcardname TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME

The name of the model card.

iv_modelcardversion TYPE /AWS1/SGMINTEGER /AWS1/SGMINTEGER

The version of the model card.

iv_content TYPE /AWS1/SGMMODELCARDCONTENT /AWS1/SGMMODELCARDCONTENT

The content of the model card. Content is provided as a string in the model card JSON schema.

When you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the complete Content, set IncludedData to AllData or omit the parameter.

iv_modelcardstatus TYPE /AWS1/SGMMODELCARDSTATUS /AWS1/SGMMODELCARDSTATUS

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

iv_creationtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The date and time the model card was created.

io_createdby TYPE REF TO /AWS1/CL_SGMUSERCONTEXT /AWS1/CL_SGMUSERCONTEXT

Information about the user who created or modified a SageMaker resource.

Optional arguments:

io_securityconfig TYPE REF TO /AWS1/CL_SGMMODELCARDSECCONFIG /AWS1/CL_SGMMODELCARDSECCONFIG

The security configuration used to protect model card content.

iv_lastmodifiedtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The date and time the model card was last modified.

io_lastmodifiedby TYPE REF TO /AWS1/CL_SGMUSERCONTEXT /AWS1/CL_SGMUSERCONTEXT

Information about the user who created or modified a SageMaker resource.

iv_modelcardprocessingstatus TYPE /AWS1/SGMMODELCARDPROCINGSTAT /AWS1/SGMMODELCARDPROCINGSTAT

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

Queryable Attributes

ModelCardArn

The Amazon Resource Name (ARN) of the model card.

Accessible with the following methods

Method Description
GET_MODELCARDARN() Getter for MODELCARDARN, with configurable default
ASK_MODELCARDARN() Getter for MODELCARDARN w/ exceptions if field has no value
HAS_MODELCARDARN() Determine if MODELCARDARN has a value

ModelCardName

The name of the model card.

Accessible with the following methods

Method Description
GET_MODELCARDNAME() Getter for MODELCARDNAME, with configurable default
ASK_MODELCARDNAME() Getter for MODELCARDNAME w/ exceptions if field has no value
HAS_MODELCARDNAME() Determine if MODELCARDNAME has a value

ModelCardVersion

The version of the model card.

Accessible with the following methods

Method Description
GET_MODELCARDVERSION() Getter for MODELCARDVERSION, with configurable default
ASK_MODELCARDVERSION() Getter for MODELCARDVERSION w/ exceptions if field has no va
HAS_MODELCARDVERSION() Determine if MODELCARDVERSION has a value

Content

The content of the model card. Content is provided as a string in the model card JSON schema.

When you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the complete Content, set IncludedData to AllData or omit the parameter.

Accessible with the following methods

Method Description
GET_CONTENT() Getter for CONTENT, with configurable default
ASK_CONTENT() Getter for CONTENT w/ exceptions if field has no value
HAS_CONTENT() Determine if CONTENT has a value

ModelCardStatus

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

Accessible with the following methods

Method Description
GET_MODELCARDSTATUS() Getter for MODELCARDSTATUS, with configurable default
ASK_MODELCARDSTATUS() Getter for MODELCARDSTATUS w/ exceptions if field has no val
HAS_MODELCARDSTATUS() Determine if MODELCARDSTATUS has a value

SecurityConfig

The security configuration used to protect model card content.

Accessible with the following methods

Method Description
GET_SECURITYCONFIG() Getter for SECURITYCONFIG

CreationTime

The date and time the model card was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

CreatedBy

Information about the user who created or modified a SageMaker resource.

Accessible with the following methods

Method Description
GET_CREATEDBY() Getter for CREATEDBY

LastModifiedTime

The date and time the model card was last modified.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDTIME() Getter for LASTMODIFIEDTIME, with configurable default
ASK_LASTMODIFIEDTIME() Getter for LASTMODIFIEDTIME w/ exceptions if field has no va
HAS_LASTMODIFIEDTIME() Determine if LASTMODIFIEDTIME has a value

LastModifiedBy

Information about the user who created or modified a SageMaker resource.

Accessible with the following methods

Method Description
GET_LASTMODIFIEDBY() Getter for LASTMODIFIEDBY

ModelCardProcessingStatus

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

Accessible with the following methods

Method Description
GET_MODELCARDPROCINGSTATUS() Getter for MODELCARDPROCESSINGSTATUS, with configurable defa
ASK_MODELCARDPROCINGSTATUS() Getter for MODELCARDPROCESSINGSTATUS w/ exceptions if field
HAS_MODELCARDPROCINGSTATUS() Determine if MODELCARDPROCESSINGSTATUS has a value