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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::DescribeImagesFilter

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

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

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

#image_ids ⇒ Array<Types::ImageIdentifier>

The list of image IDs for the requested repository.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  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 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.

Returns:

  • (Integer) 


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

class DescribeImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :image_ids,
  :next_token,
  :max_results,
  :filter)
  SENSITIVE = []
  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. This option cannot be used when you specify images with imageIds.

Returns:

  • (String) 


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

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

#registry_id ⇒ String

The Amazon Web Services 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) 


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

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

#repository_name ⇒ String

The repository that contains the images to describe.

Returns:

  • (String) 


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1123

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