/

POST

Creates or updates the catalog data for a repository 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",
    "repositoryName": "string",
    "catalogData": {
        "description": "string",
        "architectures": [],
        "operatingSystems": [],
        "logoImageBlob": "string",
        "aboutText": "string",
        "usageText": "string"
    }
}'

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 public registry the repository is in. 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 create or update the catalog data for.

>= 2 characters<= 205 characters

Match pattern:

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

catalogData

object

required

An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

description

string

optional

A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.

<= 1024 characters

architectures

array[string]

optional

The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures appear as badges on the repository and are used as search filters.

ARM
ARM 64
x86
x86-64

<= 50 items

operatingSystems

array[string]

optional

The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems appear as badges on the repository and are used as search filters.

Linux
Windows

<= 50 items

logoImageBlob

string

optional

The base64-encoded repository logo payload.

>= 0 characters<= 512000 characters

aboutText

string

optional

A detailed description of the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.

<= 25600 characters

usageText

string

optional

Detailed information about how to use the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.

<= 25600 characters

Examples

Responses

🟢200Success

application/json

Body

catalogData

object

optional

The catalog data 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

🟠482RepositoryNotFoundException

🟠483UnsupportedCommandException