You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECR::Types::ListImagesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListImagesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  registry_id: "RegistryId",
  repository_name: "RepositoryName", # required
  next_token: "NextToken",
  max_results: 1,
  filter: {
    tag_status: "TAGGED", # accepts TAGGED, UNTAGGED, ANY
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::ListImagesFilter

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

Returns:

#max_results ⇒ Integer

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 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

Returns:

  • (Integer) —

    The maximum number of image results returned by ListImages in paginated output.

#next_token ⇒ String

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.

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.

Returns:

  • (String) —

    The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter.

#registry_id ⇒ String

The AWS 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.

Returns:

  • (String) —

    The AWS account ID associated with the registry that contains the repository in which to list images.

#repository_name ⇒ String

The repository with image IDs to be listed.

Returns:

  • (String) —

    The repository with image IDs to be listed.