Class: Aws::ECR::Types::ListImagesRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECR::Types::ListImagesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecr/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter ⇒ Types::ListImagesFilter

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

• #max_results ⇒ Integer

  The maximum number of image results returned by ‘ListImages` in paginated output.

• #next_token ⇒ String

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

• #registry_id ⇒ String

  The Amazon Web Services account ID associated with the registry that contains the repository in which to list images.

• #repository_name ⇒ String

  The repository with image IDs to be listed.

Instance Attribute Details

#filter ⇒ Types::ListImagesFilter

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

Returns:

• (Types::ListImagesFilter)

# File 'lib/aws-sdk-ecr/types.rb', line 2787

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

#max_results ⇒ Integer

The maximum number of image results returned by ‘ListImages` in paginated output. When this parameter is used, `ListImages` 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 `ListImages` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter is not used, then `ListImages` returns up to 100 results and a `nextToken` value, if applicable.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecr/types.rb', line 2787

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

#next_token ⇒ String

The ‘nextToken` value returned from a previous paginated `ListImages` 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.

<note markdown=“1”> This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 2787

class ListImagesRequest < Struct.new(
  :registry_id,
  :repository_name,
  :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 list images. If you do not specify a registry, the default registry is assumed.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 2787

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

#repository_name ⇒ String

The repository with image IDs to be listed.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 2787

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