describe-model-card¶

Description¶

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

Warning

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.

Synopsis¶

  describe-model-card
--model-card-name <value>
[--model-card-version <value>]
[--included-data <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--model-card-name (string) [required]

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

Constraints:

min: 1

max: 256

pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

--model-card-version (integer)

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

--included-data (string)

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 .

Possible values:

AllData

MetadataOnly

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

ModelCardArn -> (string)

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

Constraints:

min: 0

max: 256

pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

ModelCardName -> (string)

The name of the model card.

Constraints:

min: 1

max: 63

pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

ModelCardVersion -> (integer)

The version of the model card.

Content -> (string)

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.

Constraints:

min: 0

max: 100000

pattern: .*

ModelCardStatus -> (string)

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.

Possible values:

Draft

PendingReview

Approved

Archived

SecurityConfig -> (structure)

The security configuration used to protect model card content.

KmsKeyId -> (string)

A Key Management Service key ID to use for encrypting a model card.

Constraints:

min: 0

max: 2048

pattern: [a-zA-Z0-9:/_-]*

CreationTime -> (timestamp)

The date and time the model card was created.

CreatedBy -> (structure)

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

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.

IamIdentity -> (structure)

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

Arn -> (string)

The Amazon Resource Name (ARN) of the IAM identity.

PrincipalId -> (string)

The ID of the principal that assumes the IAM identity.

SourceIdentity -> (string)

The person or application which assumes the IAM identity.

LastModifiedTime -> (timestamp)

The date and time the model card was last modified.

LastModifiedBy -> (structure)

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

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.

IamIdentity -> (structure)

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

Arn -> (string)

The Amazon Resource Name (ARN) of the IAM identity.

PrincipalId -> (string)

The ID of the principal that assumes the IAM identity.

SourceIdentity -> (string)

The person or application which assumes the IAM identity.

ModelCardProcessingStatus -> (string)

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.

Possible values:

DeleteInProgress

DeletePending

ContentDeleted

ExportJobsDeleted

DeleteCompleted

DeleteFailed

Table of Contents

Feedback

User Guide