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
/
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "repositoryName": "string",
    "catalogData": {
        "description": "string",
        "architectures": [],
        "operatingSystems": [],
        "logoImageBlob": "string",
        "aboutText": "string",
        "usageText": "string"
    },
    "tags": []
}'
Response Response Example
200 - Example 1
{
    "repository": {
        "repositoryArn": "string",
        "registryId": "string",
        "repositoryName": "string",
        "repositoryUri": "string",
        "createdAt": "string"
    },
    "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
repositoryName
string 
required
The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. The repository name can be specified on its own (for example nginx-web-app) or prepended with a namespace to group the repository into a category (for example project-a/nginx-web-app).
>= 2 characters<= 205 characters
Match pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
catalogData
object 
optional
The details about the repository that are 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
tags
array[object (Tag) {2}] 
optional
The metadata that you apply to each repository to help categorize and organize your repositories. Each tag consists of a key and an optional value. You define both of them. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
>= 0 items<= 200 items
Key
string 
optional
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
>= 1 characters<= 128 characters
Value
string 
optional
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
>= 0 characters<= 256 characters
Examples

Responses

🟢200Success
application/json
Body
repository
object 
optional
The repository that was created.
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.
catalogData
object (RepositoryCatalogData) 
optional
The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
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
🟠482InvalidTagParameterException
🟠483TooManyTagsException
🟠484RepositoryAlreadyExistsException
🟠485LimitExceededException
🟠486UnsupportedCommandException
Previous
/
Next
/
Built with