You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ECR::Types::DescribeImagesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECR::Types::DescribeImagesRequest
- Defined in:
- (unknown)
Overview
When passing DescribeImagesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
registry_id: "RegistryId",
repository_name: "RepositoryName", # required
image_ids: [
{
image_digest: "ImageDigest",
image_tag: "ImageTag",
},
],
next_token: "NextToken",
max_results: 1,
filter: {
tag_status: "TAGGED", # accepts TAGGED, UNTAGGED, ANY
},
}
Instance Attribute Summary collapse
-
#filter ⇒ Types::DescribeImagesFilter
The filter key and value with which to filter your
DescribeImages
results. -
#image_ids ⇒ Array<Types::ImageIdentifier>
The list of image IDs for the requested repository.
-
#max_results ⇒ Integer
The maximum number of repository results returned by
DescribeImages
in paginated output. -
#next_token ⇒ String
The
nextToken
value returned from a previous paginatedDescribeImages
request wheremaxResults
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 describe images.
-
#repository_name ⇒ String
The repository that contains the images to describe.
Instance Attribute Details
#filter ⇒ Types::DescribeImagesFilter
The filter key and value with which to filter your DescribeImages
results.
#image_ids ⇒ Array<Types::ImageIdentifier>
The list of image IDs for the requested repository.
#max_results ⇒ Integer
The maximum number of repository results returned by DescribeImages
in
paginated output. When this parameter is used, DescribeImages
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 DescribeImages
request with the returned
nextToken
value. This value can be between 1 and 1000. If this
parameter is not used, then DescribeImages
returns up to 100 results
and a nextToken
value, if applicable. This option cannot be used when
you specify images with imageIds
.
#next_token ⇒ String
The nextToken
value returned from a previous paginated
DescribeImages
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 option cannot
be used when you specify images with imageIds
.
#registry_id ⇒ String
The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
#repository_name ⇒ String
The repository that contains the images to describe.