GetRepositoryCatalogData
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
Request Syntax
{
"registryId": "string
",
"repositoryName": "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.
- registryId
-
The Amazon 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
- repositoryName
-
The name of the repository to retrieve the catalog metadata for.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Required: Yes
Response Syntax
{
"catalogData": {
"aboutText": "string",
"architectures": [ "string" ],
"description": "string",
"logoUrl": "string",
"marketplaceCertified": boolean,
"operatingSystems": [ "string" ],
"usageText": "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.
- catalogData
-
The catalog metadata for the repository.
Type: RepositoryCatalogData object
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
- RepositoryCatalogDataNotFoundException
-
The repository catalog data doesn't exist.
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 Amazon SDKs, see the following: