DescribeImages¶

class ECRPublic.Paginator.DescribeImages¶

paginator = client.get_paginator('describe_images')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    registryId='string',
    repositoryName='string',
    imageIds=[
        {
            'imageDigest': 'string',
            'imageTag': '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 repository that contains the images to describe.
imageIds (list) --
The list of image IDs for the requested repository.
- (dict) --
  An object with identifying information for an Amazon ECR image.
  - imageDigest (string) --
    The sha256 digest of the image manifest.
  - imageTag (string) --
    The tag that's used for the image.
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

{
    'imageDetails': [
        {
            'registryId': 'string',
            'repositoryName': 'string',
            'imageDigest': 'string',
            'imageTags': [
                'string',
            ],
            'imageSizeInBytes': 123,
            'imagePushedAt': datetime(2015, 1, 1),
            'imageManifestMediaType': 'string',
            'artifactMediaType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- imageDetails (list) --
  
  A list of ImageDetail objects that contain data about the image.
  - (dict) --
    
    An object that describes an image that's returned by a DescribeImages operation.
    - registryId (string) --
      
      The Amazon Web Services account ID that's associated with the public registry where this image belongs.
    - repositoryName (string) --
      
      The name of the repository where this image belongs.
    - imageDigest (string) --
      
      The sha256 digest of the image manifest.
    - imageTags (list) --
      
      The list of tags that's associated with this image.
      - (string) --
    - 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, that the current image 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.

Table Of Contents

DescribeImages¶