You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass ListImagesRequest data as a hash:

{
  registry_id: "RegistryId",
  repository_name: "RepositoryName", # required
  next_token: "NextToken",
  max_results: 1,
  filter: {
    tag_status: "TAGGED", # accepts TAGGED, UNTAGGED
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::ListImagesFilter

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



1324
1325
1326
1327
1328
1329
1330
1331
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1324

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

#max_resultsInteger

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

Returns:

  • (Integer)


1324
1325
1326
1327
1328
1329
1330
1331
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1324

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

#next_tokenString

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.

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.

Returns:

  • (String)


1324
1325
1326
1327
1328
1329
1330
1331
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1324

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

#registry_idString

The AWS 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)


1324
1325
1326
1327
1328
1329
1330
1331
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1324

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

#repository_nameString

The repository with image IDs to be listed.

Returns:

  • (String)


1324
1325
1326
1327
1328
1329
1330
1331
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1324

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