SageMaker / Client / update_model_card

update_model_card#

SageMaker.Client.update_model_card(**kwargs)#

Update an Amazon SageMaker Model Card.

Warning

You cannot update both model card content and model card status in a single call.

See also: AWS API Documentation

Request Syntax

response = client.update_model_card(
    ModelCardName='string',
    Content='string',
    ModelCardStatus='Draft'|'PendingReview'|'Approved'|'Archived'
)
Parameters:

  • ModelCardName (string) –

    [REQUIRED]

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

  • Content (string) –

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

    When updating model card content, be sure to include the full content and not just updated content.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'ModelCardArn': 'string'
}

Response Structure

  • (dict) –

    • ModelCardArn (string) –

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ConflictException