Class: Aws::ECRPublic::Types::DescribeImagesRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#image_idsArray<Types::ImageIdentifier>

The list of image IDs for the requested repository.

Returns:



413
414
415
416
417
418
419
420
421
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 413

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

#max_resultsInteger

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)


413
414
415
416
417
418
419
420
421
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 413

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

#next_tokenString

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)


413
414
415
416
417
418
419
420
421
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 413

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

#registry_idString

The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.

Returns:

  • (String)


413
414
415
416
417
418
419
420
421
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 413

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

#repository_nameString

The repository that contains the images to describe.

Returns:

  • (String)


413
414
415
416
417
418
419
420
421
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 413

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