Class: Aws::ECRPublic::Types::DescribeRepositoriesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecrpublic/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


547
548
549
550
551
552
553
554
# File 'lib/aws-sdk-ecrpublic/types.rb', line 547

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

#next_tokenString

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

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


547
548
549
550
551
552
553
554
# File 'lib/aws-sdk-ecrpublic/types.rb', line 547

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

#registry_idString

The Amazon Web Services account ID that’s associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.

Returns:

  • (String)


547
548
549
550
551
552
553
554
# File 'lib/aws-sdk-ecrpublic/types.rb', line 547

class DescribeRepositoriesRequest < Struct.new(
  :registry_id,
  :repository_names,
  :next_token,
  :max_results)
  SENSITIVE = []
  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>)


547
548
549
550
551
552
553
554
# File 'lib/aws-sdk-ecrpublic/types.rb', line 547

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