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

Inherits:

Struct

• Object
• Struct
• Aws::ECRPublic::Types::DescribeImagesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecrpublic/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #image_ids ⇒ Array<Types::ImageIdentifier>

  The list of image IDs for the requested repository.

• #max_results ⇒ Integer

  The maximum number of repository results that’s returned by ‘DescribeImages` in paginated output.

• #next_token ⇒ String

  The ‘nextToken` value that’s returned from a previous paginated ‘DescribeImages` request where `maxResults` was used and the results exceeded the value of that parameter.

• #registry_id ⇒ String

  The Amazon Web Services account ID that’s associated with the public registry that contains the repository where images are described.

• #repository_name ⇒ String

  The repository that contains the images to describe.

Instance Attribute Details

#image_ids ⇒ Array<Types::ImageIdentifier>

The list of image IDs for the requested repository.

Returns:

• (Array<Types::ImageIdentifier>)

# File 'lib/aws-sdk-ecrpublic/types.rb', line 419

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

#max_results ⇒ Integer

The maximum number of repository results that’s 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. You can see the remaining results of the initial request by sending another `DescribeImages` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter isn’t used, then ‘DescribeImages` returns up to 100 results and a `nextToken` value, if applicable. If you specify images with `imageIds`, you can’t use this option.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecrpublic/types.rb', line 419

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

#next_token ⇒ String

The ‘nextToken` value that’s 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. If there are no more results to return, this value is `null`. If you specify images with `imageIds`, you can’t use this option.

Returns:

• (String)

# File 'lib/aws-sdk-ecrpublic/types.rb', line 419

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

#registry_id ⇒ String

The Amazon Web Services account ID that’s associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

Returns:

• (String)

# File 'lib/aws-sdk-ecrpublic/types.rb', line 419

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

#repository_name ⇒ String

The repository that contains the images to describe.

Returns:

• (String)

# File 'lib/aws-sdk-ecrpublic/types.rb', line 419

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