/

POST

Describes repositories that are in a public registry.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "registryId": "string",
    "repositoryNames": [],
    "nextToken": "string",
    "maxResults": 0
}'

Response Example

200 - Example 1

{
    "repositories": [],
    "nextToken": "string"
}

Request

Query Params

maxResults

string

optional

Pagination limit

nextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

registryId

string

optional

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.

Match pattern:

[0-9]{12}

repositoryNames

array[string]

optional

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

>= 1 items<= 100 items

nextToken

string

optional

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.

maxResults

integer

optional

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.

>= 1<= 1000

Examples

Responses

🟢200Success

application/json

Body

repositories

array[object (Repository) {5}]

optional

A list of repository objects corresponding to valid repositories.

repositoryArn

string

optional

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

>= 1 characters<= 2048 characters

registryId

string

optional

The Amazon Web Services account ID that's associated with the public registry that contains the repository.

Match pattern:

[0-9]{12}

repositoryName

string

optional

The name of the repository.

>= 2 characters<= 205 characters

Match pattern:

(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

repositoryUri

string

optional

The URI for the repository. You can use this URI for container image push and pull operations.

createdAt

string <date-time>

optional

The date and time, in JavaScript date format, when the repository was created.

nextToken

string

optional

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. If there are no more results to return, this value is null.

🟠480ServerException

🟠481InvalidParameterException

🟠482RepositoryNotFoundException

🟠483UnsupportedCommandException

Modified at 2023-08-15 05:55:25