SageMaker / Paginator / ListModelCardVersions

ListModelCardVersions

class SageMaker.Paginator.ListModelCardVersions

paginator = client.get_paginator('list_model_card_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_model_card_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    ModelCardName='string',
    ModelCardStatus='Draft'|'PendingReview'|'Approved'|'Archived',
    SortBy='Version',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

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

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.