List Images

ecr_list_images

R Documentation

Lists all the image IDs for the specified repository¶

Description¶

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a batch_delete_image operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Usage¶

ecr_list_images(registryId, repositoryName, nextToken, maxResults,
  filter)

Arguments¶

registryId

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

[required] The repository with image IDs to be listed.

nextToken

The nextToken value returned from a previous paginated list_images 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

The maximum number of image results returned by list_images in paginated output. When this parameter is used, list_images 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 list_images request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then list_images returns up to 100 results and a nextToken value, if applicable.

filter

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

Value¶

A list with the following syntax:

list(
  imageIds = list(
    list(
      imageDigest = "string",
      imageTag = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_images(
  registryId = "string",
  repositoryName = "string",
  nextToken = "string",
  maxResults = 123,
  filter = list(
    tagStatus = "TAGGED"|"UNTAGGED"|"ANY"
  )
)

Examples¶

## Not run: 
# This example lists all of the images in the repository named ubuntu in
# the default registry in the current account.
svc$list_images(
  repositoryName = "ubuntu"
)

## End(Not run)