Amazon EC2 Container Registry

{'filter': {'tagStatus': 'TAGGED | UNTAGGED'}}

Lists all the image IDs for a given repository.

Request Syntax

client.list_images(
    registryId='string',
    repositoryName='string',
    nextToken='string',
    maxResults=123,
    filter={
        'tagStatus': 'TAGGED'|'UNTAGGED'
    }
)

type registryId:

string

param registryId:

The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.

type repositoryName:

string

param repositoryName:

[REQUIRED]

The repository whose image IDs are to be listed.

type nextToken:

string

param nextToken:

The nextToken value returned from a previous paginated ListImages 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. This value is null when there are no more results to return.

type maxResults:

integer

param maxResults:

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

type filter:

dict

param filter:

• tagStatus (string) --

rtype:

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 Amazon ECR image.

      • imageDigest (string) --

        The sha256 digest of the image manifest.

      • imageTag (string) --

        The tag used for the image.

  • nextToken (string) --

    The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.