SageMaker / Paginator / ListImages

ListImages

class SageMaker.Paginator.ListImages

paginator = client.get_paginator('list_images')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

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

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

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

• NameContains (string) – A filter that returns only images whose name contains the specified string.

• 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

{
    'Images': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'Description': 'string',
            'DisplayName': 'string',
            'FailureReason': 'string',
            'ImageArn': 'string',
            'ImageName': 'string',
            'ImageStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Images (list) –

    A list of images and their properties.

    • (dict) –

      A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

      • CreationTime (datetime) –

        When the image was created.

      • Description (string) –

        The description of the image.

      • DisplayName (string) –

        The name of the image as displayed.

      • FailureReason (string) –

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

      • ImageArn (string) –

        The ARN of the image.

      • ImageName (string) –

        The name of the image.

      • ImageStatus (string) –

        The status of the image.

      • LastModifiedTime (datetime) –

        When the image was last modified.