SageMaker / Client / list_model_card_versions

list_model_card_versions#

SageMaker.Client.list_model_card_versions(**kwargs)#

List existing versions of an Amazon SageMaker Model Card.

See also: AWS API Documentation

Request Syntax

response = client.list_model_card_versions(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    MaxResults=123,
    ModelCardName='string',
    ModelCardStatus='Draft'|'PendingReview'|'Approved'|'Archived',
    NextToken='string',
    SortBy='Version',
    SortOrder='Ascending'|'Descending'
)
Parameters:

  • CreationTimeAfter (datetime) – Only list model card versions that were created after the time specified.

  • CreationTimeBefore (datetime) – Only list model card versions that were created before the time specified.

  • MaxResults (integer) – The maximum number of model card versions to list.

  • ModelCardName (string) –

    [REQUIRED]

    List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

  • ModelCardStatus (string) – Only list model card versions with the specified approval status.

  • NextToken (string) – If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

  • SortBy (string) – Sort listed model card versions by version. Sorts by version by default.

  • SortOrder (string) – Sort model card versions by ascending or descending order.

Return type:

dict

Returns:

Response Syntax

{
    'ModelCardVersionSummaryList': [
        {
            'ModelCardName': 'string',
            'ModelCardArn': 'string',
            'ModelCardStatus': 'Draft'|'PendingReview'|'Approved'|'Archived',
            'ModelCardVersion': 123,
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ModelCardVersionSummaryList (list) –

      The summaries of the listed versions of the model card.

      • (dict) –

        A summary of a specific version of the model card.

        • ModelCardName (string) –

          The name of the model card.

        • ModelCardArn (string) –

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

        • ModelCardStatus (string) –

          The approval status of the model card version 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.

        • ModelCardVersion (integer) –

          A version of the model card.

        • CreationTime (datetime) –

          The date and time that the model card version was created.

        • LastModifiedTime (datetime) –

          The time date and time that the model card version was last modified.

    • NextToken (string) –

      If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound