Describe Repositories

ecr_describe_repositories

R Documentation

Describes image repositories in a registry

Description

Describes image repositories in a registry.

Usage

ecr_describe_repositories(registryId, repositoryNames, nextToken,
  maxResults)

Arguments

registryId

The Amazon Web Services 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.

repositoryNames

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

nextToken

The nextToken value returned from a previous paginated describe_repositories 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 option cannot be used when you specify repositories with repositoryNames.

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 returned by describe_repositories in paginated output. When this parameter is used, describe_repositories 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_repositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then describe_repositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

Value

A list with the following syntax:

list(
  repositories = list(
    list(
      repositoryArn = "string",
      registryId = "string",
      repositoryName = "string",
      repositoryUri = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      imageTagMutability = "MUTABLE"|"IMMUTABLE",
      imageScanningConfiguration = list(
        scanOnPush = TRUE|FALSE
      ),
      encryptionConfiguration = list(
        encryptionType = "AES256"|"KMS",
        kmsKey = "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_repositories(
  registryId = "string",
  repositoryNames = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123
)

Examples

## Not run: 
# The following example obtains a list and description of all repositories
# in the default registry to which the current user has access.
svc$describe_repositories()

## End(Not run)