Describe Registries

ecrpublic_describe_registries

R Documentation

Returns details for a public registry¶

Description¶

Returns details for a public registry.

Usage¶

ecrpublic_describe_registries(nextToken, maxResults)

Arguments¶

nextToken

The nextToken value that's returned from a previous paginated describe_registries 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.

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.

maxResults

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

Value¶

A list with the following syntax:

list(
  registries = list(
    list(
      registryId = "string",
      registryArn = "string",
      registryUri = "string",
      verified = TRUE|FALSE,
      aliases = list(
        list(
          name = "string",
          status = "ACTIVE"|"PENDING"|"REJECTED",
          primaryRegistryAlias = TRUE|FALSE,
          defaultRegistryAlias = TRUE|FALSE
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_registries(
  nextToken = "string",
  maxResults = 123
)