ECR / Paginator / ListImages

ListImages

class ECR.Paginator.ListImages

paginator = client.get_paginator('list_images')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registryId='string',
    repositoryName='string',
    filter={
        'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• registryId (string) – The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

• repositoryName (string) –

  [REQUIRED]

  The repository with image IDs to be listed.

• filter (dict) –

  The filter key and value with which to filter your ListImages results.

  • tagStatus (string) –

    The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

• 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

{
    'imageIds': [
        {
            'imageDigest': 'string',
            'imageTag': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • imageIds (list) –

    The list of image IDs for the requested repository.

    • (dict) –

      An object with identifying information for an image in an Amazon ECR repository.

      • imageDigest (string) –

        The sha256 digest of the image manifest.

      • imageTag (string) –

        The tag used for the image.

  • NextToken (string) –

    A token to resume pagination.