DescribeRepositories
Describes repositories that are in a public registry.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"registryId": "string",
"repositoryNames": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of repository results that's returned by
DescribeRepositoriesin paginated output. When this parameter is used,DescribeRepositoriesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherDescribeRepositoriesrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter isn't used, thenDescribeRepositoriesreturns up to 100 results and anextTokenvalue, if applicable. If you specify repositories withrepositoryNames, you can't use this option.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
The
nextTokenvalue that's returned from a previous paginatedDescribeRepositoriesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. If there are no more results to return, this value isnull. If you specify repositories withrepositoryNames, you can't use this option.Note
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.
Type: String
Required: No
- registryId
-
The AWS 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.
Type: String
Pattern:
[0-9]{12}Required: No
- repositoryNames
-
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*Required: No
Response Syntax
{
"nextToken": "string",
"repositories": [
{
"createdAt": number,
"registryId": "string",
"repositoryArn": "string",
"repositoryName": "string",
"repositoryUri": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The
nextTokenvalue to include in a futureDescribeRepositoriesrequest. When the results of aDescribeRepositoriesrequest exceedmaxResults, this value can be used to retrieve the next page of results. If there are no more results to return, this value isnull.Type: String
- repositories
-
A list of repository objects corresponding to valid repositories.
Type: Array of Repository objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- RepositoryNotFoundException
-
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnsupportedCommandException
-
The action isn't supported in this Region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
