Amazon Elastic Container Registry Public
  1. Root
Amazon Elastic Container Registry Public
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "registryId": "string",
    "repositoryName": "string"
}'
Response Response Example
200 - Example 1
{
    "catalogData": {
        "description": "string",
        "architectures": [],
        "operatingSystems": [],
        "logoUrl": "string",
        "aboutText": "string",
        "usageText": "string",
        "marketplaceCertified": true
    }
}

Request

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}
repositoryName
string 
required
The name of the repository to retrieve the catalog metadata for.
>= 2 characters<= 205 characters
Match pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Examples

Responses

🟢200Success
application/json
Body
catalogData
object 
optional
The catalog metadata for the repository.
description
string 
optional
The short description of the repository.
<= 1024 characters
architectures
array[string]
optional
The architecture tags that are associated with the repository.
<= 50 items
operatingSystems
array[string]
optional
The operating system tags that are associated with the repository.
<= 50 items
logoUrl
string 
optional
The URL that contains the logo that's associated with the repository.
<= 2048 characters
aboutText
string 
optional
The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.
<= 25600 characters
usageText
string 
optional
The longform usage details of the contents of the repository. The usage text provides context for users of the repository.
<= 25600 characters
marketplaceCertified
boolean 
optional
Indicates whether the repository is certified by Amazon Web Services Marketplace.
🟠480ServerException
🟠481InvalidParameterException
🟠482RepositoryCatalogDataNotFoundException
🟠483RepositoryNotFoundException
🟠484UnsupportedCommandException
Modified at 2023-08-15 05:55:25
Previous
/
Next
/
Built with