ECRPublic / Client / describe_image_tags

describe_image_tags#

ECRPublic.Client.describe_image_tags(**kwargs)#

Returns the image tag details for a repository in a public registry.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_tags(
    registryId='string',
    repositoryName='string',
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – The nextToken value that’s returned from a previous paginated DescribeImageTags request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null. If you specify images with imageIds, you can’t use this option.

  • maxResults (integer) – The maximum number of repository results that’s returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn’t used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can’t use this option.

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) –

      The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

Exceptions