SageMaker / Paginator / ListImageVersions

ListImageVersions

class SageMaker.Paginator.ListImageVersions

paginator = client.get_paginator('list_image_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    ImageName='string',
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    SortBy='CREATION_TIME'|'LAST_MODIFIED_TIME'|'VERSION',
    SortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CreationTimeAfter (datetime) – A filter that returns only versions created on or after the specified time.

• CreationTimeBefore (datetime) – A filter that returns only versions created on or before the specified time.

• ImageName (string) –

  [REQUIRED]

  The name of the image to list the versions of.

• LastModifiedTimeAfter (datetime) – A filter that returns only versions modified on or after the specified time.

• LastModifiedTimeBefore (datetime) – A filter that returns only versions modified on or before the specified time.

• SortBy (string) – The property used to sort results. The default value is CREATION_TIME.

• SortOrder (string) – The sort order. The default value is DESCENDING.

• 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

{
    'ImageVersions': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': 'string',
            'ImageArn': 'string',
            'ImageVersionArn': 'string',
            'ImageVersionStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'LastModifiedTime': datetime(2015, 1, 1),
            'Version': 123
        },
    ],

}

Response Structure

• (dict) –

  • ImageVersions (list) –

    A list of versions and their properties.

    • (dict) –

      A version of a SageMaker AI Image. A version represents an existing container image.

      • CreationTime (datetime) –

        When the version was created.

      • FailureReason (string) –

        When a create or delete operation fails, the reason for the failure.

      • ImageArn (string) –

        The ARN of the image the version is based on.

      • ImageVersionArn (string) –

        The ARN of the version.

      • ImageVersionStatus (string) –

        The status of the version.

      • LastModifiedTime (datetime) –

        When the version was last modified.

      • Version (integer) –

        The version number.