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

Inherits:

Struct

• Object
• Struct
• Aws::ECR::Types::DescribeRepositoriesRequest

Includes:

Structure

Defined in:

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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of repository results returned by ‘DescribeRepositories` in paginated output.

• #next_token ⇒ String

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

• #registry_id ⇒ String

  The AWS account ID associated with the registry that contains the repositories to be described.

• #repository_names ⇒ Array<String>

  A list of repositories to describe.

Instance Attribute Details

#max_results ⇒ Integer

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)

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

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

#next_token ⇒ String

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.

<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 565

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

#registry_id ⇒ String

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)

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

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

#repository_names ⇒ Array<String>

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

Returns:

• (Array<String>)

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

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