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

Class: Aws::ECR::Types::DescribeRepositoriesRequest

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 DescribeRepositoriesRequest data as a hash:

{
  registry_id: "RegistryId",
  repository_names: ["RepositoryName"],
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


618
619
620
621
622
623
624
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 618

class DescribeRepositoriesRequest < Struct.new(
  :registry_id,
  :repository_names,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The nextToken value returned from a previous paginated DescribeRepositories 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)


618
619
620
621
622
623
624
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 618

class DescribeRepositoriesRequest < Struct.new(
  :registry_id,
  :repository_names,
  :next_token,
  :max_results)
  include Aws::Structure
end

#registry_idString

The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

Returns:

  • (String)


618
619
620
621
622
623
624
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 618

class DescribeRepositoriesRequest < Struct.new(
  :registry_id,
  :repository_names,
  :next_token,
  :max_results)
  include Aws::Structure
end

#repository_namesArray<String>

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Returns:

  • (Array<String>)


618
619
620
621
622
623
624
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 618

class DescribeRepositoriesRequest < Struct.new(
  :registry_id,
  :repository_names,
  :next_token,
  :max_results)
  include Aws::Structure
end