SageMaker / Client / create_model_card

create_model_card#

SageMaker.Client.create_model_card(**kwargs)#

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

See also: AWS API Documentation

Request Syntax

response = client.create_model_card(
    ModelCardName='string',
    SecurityConfig={
        'KmsKeyId': 'string'
    },
    Content='string',
    ModelCardStatus='Draft'|'PendingReview'|'Approved'|'Archived',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ModelCardName (string) –

    [REQUIRED]

    The unique name of the model card.

  • SecurityConfig (dict) –

    An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

    • KmsKeyId (string) –

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

  • Content (string) –

    [REQUIRED]

    The content of the model card. Content must be in model card JSON schema and provided as a string.

  • ModelCardStatus (string) –

    [REQUIRED]

    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.

  • Tags (list) –

    Key-value pairs used to manage metadata for model cards.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ModelCardArn': 'string'
}

Response Structure

  • (dict) –

    • ModelCardArn (string) –

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

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ConflictException