Class: Aws::ECR::Types::DescribeImagesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecr/types.rb

Overview

Note:

When making an API call, you may pass DescribeImagesRequest data as a 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
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::DescribeImagesFilter

The filter key and value with which to filter your ‘DescribeImages` results.

Returns:



485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#image_ids ⇒ Array<Types::ImageIdentifier>

The list of image IDs for the requested repository.

Returns:



485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

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

Returns:

  • (Integer) 


485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#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.

Returns:

  • (String) 


485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#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.

Returns:

  • (String) 


485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end

#repository_name ⇒ String

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Returns:

  • (String) 


485
486
487
488
489
490
491
492
493
 
# File 'lib/aws-sdk-ecr/types.rb', line 485

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  include Aws::Structure
end