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

Description¶

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.

Usage¶

sagemaker_describe_model_card(ModelCardName, ModelCardVersion,
  IncludedData)

Arguments¶

• ModelCardName

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

• ModelCardVersion

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

• IncludedData

  Specifies the level of model card data to include in the response. Use this parameter to call describe_model_card 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.

Value¶

A list with the following syntax:

list(
  ModelCardArn = "string",
  ModelCardName = "string",
  ModelCardVersion = 123,
  Content = "string",
  ModelCardStatus = "Draft"|"PendingReview"|"Approved"|"Archived",
  SecurityConfig = list(
    KmsKeyId = "string"
  ),
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedBy = list(
    UserProfileArn = "string",
    UserProfileName = "string",
    DomainId = "string",
    IamIdentity = list(
      Arn = "string",
      PrincipalId = "string",
      SourceIdentity = "string"
    )
  ),
  ModelCardProcessingStatus = "DeleteInProgress"|"DeletePending"|"ContentDeleted"|"ExportJobsDeleted"|"DeleteCompleted"|"DeleteFailed"
)

Request syntax¶

svc$describe_model_card(
  ModelCardName = "string",
  ModelCardVersion = 123,
  IncludedData = "AllData"|"MetadataOnly"
)