ECRPublic / Paginator / DescribeImageTags

DescribeImageTags#

class ECRPublic.Paginator.DescribeImageTags#
paginator = client.get_paginator('describe_image_tags')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ECRPublic.Client.describe_image_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registryId='string',
    repositoryName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID that’s associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

  • repositoryName (string) –

    [REQUIRED]

    The name of the repository that contains the image tag details to describe.

  • 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

{
    'imageTagDetails': [
        {
            'imageTag': 'string',
            'createdAt': datetime(2015, 1, 1),
            'imageDetail': {
                'imageDigest': 'string',
                'imageSizeInBytes': 123,
                'imagePushedAt': datetime(2015, 1, 1),
                'imageManifestMediaType': 'string',
                'artifactMediaType': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • imageTagDetails (list) –

      The image tag details for the images in the requested repository.

      • (dict) –

        An object that represents the image tag details for an image.

        • imageTag (string) –

          The tag that’s associated with the image.

        • createdAt (datetime) –

          The time stamp that indicates when the image tag was created.

        • imageDetail (dict) –

          An object that describes the details of an image.

          • imageDigest (string) –

            The sha256 digest of the image manifest.

          • imageSizeInBytes (integer) –

            The size, in bytes, of the image in the repository.

            If the image is a manifest list, this is the max size of all manifests in the list.

            Note

            Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it might return a larger image size than the image sizes that are returned by DescribeImages.

          • imagePushedAt (datetime) –

            The date and time, expressed in standard JavaScript date format, which the current image tag was pushed to the repository at.

          • imageManifestMediaType (string) –

            The media type of the image manifest.

          • artifactMediaType (string) –

            The artifact media type of the image.

    • NextToken (string) –

      A token to resume pagination.