Amazon Elastic Container Registry Public API Reference API Version 2020-10-30

(1)

Amazon Elastic

Container Registry Public

API Reference

API Version 2020-10-30

(2)

Amazon Elastic Container Registry Public: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.

This document was last published on March 6, 2022.

(8)

Actions

The following actions are supported:

• BatchCheckLayerAvailability (p. 3)

• BatchDeleteImage (p. 6)

• CompleteLayerUpload (p. 9)

• CreateRepository (p. 13)

• DeleteRepository (p. 16)

• DeleteRepositoryPolicy (p. 19)

• DescribeImages (p. 22)

• DescribeImageTags (p. 26)

• DescribeRegistries (p. 29)

• DescribeRepositories (p. 32)

• GetAuthorizationToken (p. 35)

• GetRegistryCatalogData (p. 37)

• GetRepositoryCatalogData (p. 39)

• GetRepositoryPolicy (p. 42)

• InitiateLayerUpload (p. 45)

• ListTagsForResource (p. 48)

• PutImage (p. 50)

• PutRegistryCatalogData (p. 54)

• PutRepositoryCatalogData (p. 56)

• SetRepositoryPolicy (p. 59)

• TagResource (p. 62)

• UntagResource (p. 64)

• UploadLayerPart (p. 66)

(9)

BatchCheckLayerAvailability

Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.

NoteThis operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Request Syntax

{ "layerDigests": [ "string" ], "registryId": "string", "repositoryName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 95).

The request accepts the following data in JSON format.

layerDigests (p. 3)

The digests of the image layers to check.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: Yes registryId (p. 3)

The AWS account ID, or registry alias, associated with the public registry that contains the image layers to check. If you do not specify a registry, the default public registry is assumed.

Type: String

Required: No repositoryName (p. 3)

The name of the repository that's associated with the image layers to check.

Type: String

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

Required: Yes

(10)

Response Syntax

{

"failures": [ {

"failureCode": "string", "failureReason": "string", "layerDigest": "string"

} ],

"layers": [ {

"layerAvailability": "string", "layerDigest": "string", "layerSize": number, "mediaType": "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.

failures (p. 4)

Any failures associated with the call.

Type: Array of LayerFailure (p. 80) objects layers (p. 4)

A list of image layer objects that correspond to the image layer references in the request.

Type: Array of Layer (p. 79) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 97).

InvalidParameterException

The speciﬁed parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400 RegistryNotFoundException

The registry doesn't exist.

HTTP Status Code: 400 RepositoryNotFoundException

The speciﬁed repository can't be found. Check the spelling of the speciﬁed repository and ensure that you're performing operations on the correct registry.

HTTP Status Code: 400

(11)

See Also

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500 UnsupportedCommandException

The action isn't supported in this Region.

BatchDeleteImage

Deletes a list of speciﬁed images that are within a repository in a public registry. Images are speciﬁed with either an imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the digest of the image in your request.

Request Syntax

{ "imageIds": [ {

"imageDigest": "string", "imageTag": "string"

} ],

"registryId": "string", "repositoryName": "string"

}

Request Parameters

imageIds (p. 6)

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Type: Array of ImageIdentiﬁer (p. 77) objects

The AWS account ID that's associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

The repository in a public registry that contains the image to delete.

Type: String

(13)

Response Syntax

Required: Yes

Response Syntax

{ "failures": [ {

"failureCode": "string", "failureReason": "string", "imageId": {

} } ],

"imageIds": [ {

} ] }

Response Elements

failures (p. 7)

Any failures associated with the call.

Type: Array of ImageFailure (p. 76) objects imageIds (p. 7)

The image IDs of the deleted images.

Errors

(14)

See Also

HTTP Status Code: 400 ServerException

CompleteLayerUpload

Informs Amazon ECR that the image layer upload is complete for a speciﬁed public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

When an image is pushed, the CompleteLayerUpload API is called once for each new image layer to verify that the upload is complete.

Request Syntax

{ "layerDigests": [ "string" ], "registryId": "string", "repositoryName": "string", "uploadId": "string"

}

Request Parameters

layerDigests (p. 9)

The sha256 digest of the image layer.

Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+

The AWS account ID, or registry alias, associated with the registry where layers are uploaded. If you do not specify a registry, the default public registry is assumed.

Type: String

The name of the repository in a public registry to associate with the image layer.

Type: String

(16)

Response Syntax

Required: Yes uploadId (p. 9)

The upload ID from a previous InitiateLayerUpload (p. 45) operation to associate with the image layer.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA- F]{12}

Required: Yes

Response Syntax

{

"layerDigest": "string", "registryId": "string", "repositoryName": "string", "uploadId": "string"

}

Response Elements

layerDigest (p. 10)

The sha256 digest of the image layer.

Type: String

Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+

registryId (p. 10)

The public registry ID that's associated with the request.

Type: String

Pattern: [0-9]{12}

repositoryName (p. 10)

The repository name that's associated with the request.

Type: String

uploadId (p. 10)

The upload ID that's associated with the layer.

Type: String

(17)

Errors

EmptyUploadException

The speciﬁed layer upload doesn't contain any layer parts.

HTTP Status Code: 400 InvalidLayerException

The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest speciﬁed.

HTTP Status Code: 400 InvalidParameterException

HTTP Status Code: 400 LayerAlreadyExistsException

The image layer already exists in the associated repository.

HTTP Status Code: 400 LayerPartTooSmallException

Layer parts must be at least 5 MiB in size.

HTTP Status Code: 400 UploadNotFoundException

The upload can't be found, or the speciﬁed upload ID isn't valid for this repository.

(18)

See Also

CreateRepository

Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Request Syntax

{

"catalogData": {

"aboutText": "string",

"architectures": [ "string" ], "description": "string", "logoImageBlob": blob,

"operatingSystems": [ "string" ], "usageText": "string"

},

"repositoryName": "string", "tags": [

{

"Key": "string", "Value": "string"

} ] }

Request Parameters

catalogData (p. 13)

The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

Type: RepositoryCatalogDataInput (p. 92) object Required: No

The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. The repository name can be speciﬁed 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).

Type: String

Required: Yes tags (p. 13)

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 deﬁne 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.

(20)

Response Syntax

Type: Array of Tag (p. 94) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

{ "catalogData": {

"architectures": [ "string" ], "description": "string", "logoUrl": "string",

"marketplaceCertified": boolean, "operatingSystems": [ "string" ], "usageText": "string"

},

"repository": { "createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string"

} }

Response Elements

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

Type: RepositoryCatalogData (p. 90) object repository (p. 14)

The repository that was created.

Type: Repository (p. 88) object

Errors

HTTP Status Code: 400 InvalidTagParameterException

An invalid parameter has been speciﬁed. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

(21)

See Also

HTTP Status Code: 400 LimitExceededException

The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.

HTTP Status Code: 400 RepositoryAlreadyExistsException

The speciﬁed repository already exists in the speciﬁed registry.

HTTP Status Code: 500 TooManyTagsException

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

DeleteRepository

Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.

Request Syntax

{ "force": boolean, "registryId": "string", "repositoryName": "string"

}

Request Parameters

force (p. 16)

The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion.

Type: Boolean Required: No registryId (p. 16)

The AWS account ID that's associated with the public registry that contains the repository to delete.

If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

The name of the repository to delete.

Type: String

Required: Yes

Response Syntax

{

(23)

Response Elements

"repository": { "createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string"

}}

Response Elements

repository (p. 16)

The repository that was deleted.

Type: Repository (p. 88) object

Errors

HTTP Status Code: 400 RepositoryNotEmptyException

The speciﬁed repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

DeleteRepositoryPolicy

Deletes the repository policy that's associated with the speciﬁed repository.

Request Syntax

{ "registryId": "string", "repositoryName": "string"

}

Request Parameters

The AWS account ID that's associated with the public registry that contains the repository policy to delete. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

The name of the repository that's associated with the repository policy to delete.

Type: String

Required: Yes

Response Syntax

{ "policyText": "string", "registryId": "string", "repositoryName": "string"

}

Response Elements

(26)

Errors

policyText (p. 19)

The JSON repository policy that was deleted from the repository.

Type: String

The registry ID that's associated with the request.

Type: String

Pattern: [0-9]{12}

Type: String

Errors

RepositoryPolicyNotFoundException

The speciﬁed repository and registry combination doesn't have an associated repository policy.

DescribeImages

Returns metadata that's related to the images in a repository in a public registry.

NoteBeginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages (p. 22).

Request Syntax

{

"imageIds": [ {

} ],

"maxResults": number, "nextToken": "string", "registryId": "string", "repositoryName": "string"

}

Request Parameters

imageIds (p. 22)

The list of image IDs for the requested repository.

Required: No maxResults (p. 22)

The maximum number of repository results that's returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

(29)

Response Syntax

nextToken (p. 22)

The nextToken value that's returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

Type: String Required: No registryId (p. 22)

The AWS account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

The repository that contains the images to describe.

Type: String

Required: Yes

Response Syntax

{

"imageDetails": [ {

"artifactMediaType": "string", "imageDigest": "string",

"imageManifestMediaType": "string", "imagePushedAt": number,

"imageSizeInBytes": number, "imageTags": [ "string" ], "registryId": "string", "repositoryName": "string"

} ],

"nextToken": "string"

}

Response Elements

imageDetails (p. 23)

A list of ImageDetail (p. 74) objects that contain data about the image.

(30)

Errors

Type: Array of ImageDetail (p. 74) objects nextToken (p. 23)

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

Type: String

Errors

ImageNotFoundException

The image requested doesn't exist in the speciﬁed repository.

HTTP Status Code: 400 InvalidParameterException

DescribeImageTags

Returns the image tag details for a repository in a public registry.

Request Syntax

{

"maxResults": number, "nextToken": "string", "registryId": "string", "repositoryName": "string"

}

Request Parameters

maxResults (p. 26)

The maximum number of repository results that's returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then

DescribeImageTags returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

Type: Integer

Required: No nextToken (p. 26)

The nextToken value that's returned from a previous paginated DescribeImageTags request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

The AWS account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

(33)

Response Syntax

The name of the repository that contains the image tag details to describe.

Type: String

Required: Yes

Response Syntax

{ "imageTagDetails": [ {

"createdAt": number, "imageDetail": {

"artifactMediaType": "string", "imageDigest": "string",

"imageManifestMediaType": "string", "imagePushedAt": number,

"imageSizeInBytes": number },

"imageTag": "string"

} ],

"nextToken": "string"

}

Response Elements

imageTagDetails (p. 27)

The image tag details for the images in the requested repository.

Type: Array of ImageTagDetail (p. 78) objects nextToken (p. 27)

The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

Type: String

Errors

(34)

See Also

DescribeRegistries

Returns details for a public registry.

Request Syntax

{ "maxResults": number, "nextToken": "string"

}

Request Parameters

The maximum number of repository results that's returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

Type: Integer

The nextToken value that's returned from a previous paginated DescribeRegistries request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null.

NoteThis token should be treated as an opaque identiﬁer that is only used to retrieve the next items in a list and not for other programmatic purposes.

Type: String Required: No

Response Syntax

{

"nextToken": "string", "registries": [ {

"aliases": [ {

(36)

Response Elements

"defaultRegistryAlias": boolean, "name": "string",

"primaryRegistryAlias": boolean, "status": "string"

} ],

"registryArn": "string", "registryId": "string", "registryUri": "string", "verified": boolean }

]}

Response Elements

The nextToken value to include in a future DescribeRepositories request. If the results of a DescribeRepositories request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results, this value is null.

Type: String registries (p. 29)

An object that contains the details for a public registry.

Type: Array of Registry (p. 83) objects

Errors

DescribeRepositories

Describes repositories that are in a public registry.

Request Syntax

{ "maxResults": number, "nextToken": "string", "registryId": "string",

"repositoryNames": [ "string" ] }

Request Parameters

The maximum number of repository results that's returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. If you specify repositories with repositoryNames, you can't use this option.

Type: Integer

The nextToken value that's returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null. If you specify repositories with repositoryNames, you can't use this option.

NoteThis token should be treated as an opaque identiﬁer that is only used to retrieve the next items in a list and not for other programmatic purposes.

The AWS account ID that's associated with the registry that contains the repositories to be described.

Type: String

(39)

Response Syntax

Pattern: [0-9]{12}

Required: No repositoryNames (p. 32)

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Required: No

Response Syntax

{ "nextToken": "string", "repositories": [ {

"createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string"

} ]}

Response Elements

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. If there are no more results to return, this value is null.

Type: String repositories (p. 33)

A list of repository objects corresponding to valid repositories.

Type: Array of Repository (p. 88) objects

Errors

(40)

See Also

GetAuthorizationToken

Retrieves an authorization token. An authorization token represents your IAM authentication credentials.

You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and

sts:GetServiceBearerToken permissions.

Response Syntax

{ "authorizationData": {

"authorizationToken": "string", "expiresAt": number

} }

Response Elements

authorizationData (p. 35)

An authorization token data object that corresponds to a public registry.

Type: AuthorizationData (p. 71) object

Errors

GetRegistryCatalogData

Retrieves catalog metadata for a public registry.

Response Syntax

{ "registryCatalogData": { "displayName": "string"

} }

Response Elements

registryCatalogData (p. 37)

The catalog metadata for the public registry.

Type: RegistryCatalogData (p. 87) object

Errors

ServerException

GetRepositoryCatalogData

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

Request Syntax

}

Request Parameters

The AWS account ID that's associated with the registry that contains the repositories to be described.

Type: String

Pattern: [0-9]{12}

The name of the repository to retrieve the catalog metadata for.

Type: String

Required: Yes

Response Syntax

{

"catalogData": {

"architectures": [ "string" ], "description": "string", "logoUrl": "string",

"marketplaceCertified": boolean, "operatingSystems": [ "string" ], "usageText": "string"

}}

(46)

Response Elements

The catalog metadata for the repository.

Type: RepositoryCatalogData (p. 90) object

Errors

RepositoryCatalogDataNotFoundException The repository catalog data doesn't exist.

GetRepositoryPolicy

Retrieves the repository policy for the speciﬁed repository.

Request Syntax

}

Request Parameters

The AWS account ID that's associated with the public registry that contains the repository. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

The name of the repository with the policy to retrieve.

Type: String

Required: Yes

Response Syntax

{ "policyText": "string", "registryId": "string", "repositoryName": "string"

}

Response Elements

(49)

Errors

policyText (p. 42)

The repository policy text that's associated with the repository. The policy text will be in JSON format.

Type: String

The registry ID that's associated with the request.

Type: String

Pattern: [0-9]{12}

Type: String

Errors

RepositoryPolicyNotFoundException

The speciﬁed repository and registry combination doesn't have an associated repository policy.

(50)

See Also

InitiateLayerUpload

Notiﬁes Amazon ECR that you intend to upload an image layer.

When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.

Request Syntax

}

Request Parameters

The AWS account ID, or registry alias, that's associated with the registry to which you intend to upload layers. If you do not specify a registry, the default public registry is assumed.

Type: String

The name of the repository that you want to upload layers to.

Type: String

Required: Yes

Response Syntax

{

"partSize": number, "uploadId": "string"

}

(52)

Response Elements

partSize (p. 45)

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

Type: Long

Valid Range: Minimum value of 0.

uploadId (p. 45)

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart (p. 66) and CompleteLayerUpload (p. 9) operations.

Type: String

Errors

ListTagsForResource

List the tags for an Amazon ECR Public resource.

Request Syntax

{

"resourceArn": "string"

}

Request Parameters

resourceArn (p. 48)

The Amazon Resource Name (ARN) that identiﬁes the resource to list the tags for. Currently, the supported resource is an Amazon ECR Public repository.

Type: String

Required: Yes

Response Syntax

{ "tags": [ {

"Key": "string", "Value": "string"

} ] }

Response Elements

tags (p. 48)

The tags for the resource.

Type: Array of Tag (p. 94) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

(55)

Errors

PutImage

Creates or updates the image manifest and tags that are associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.

Request Syntax

{ "imageDigest": "string", "imageManifest": "string",

"imageManifestMediaType": "string", "imageTag": "string",

"registryId": "string", "repositoryName": "string"

}

Request Parameters

imageDigest (p. 50)

The image digest of the image manifest that corresponds to the image.

Type: String Required: No imageManifest (p. 50)

The image manifest that corresponds to the image to be uploaded.

Type: String

Required: Yes

imageManifestMediaType (p. 50)

The media type of the image manifest. If you push an image manifest that doesn't contain the mediaType ﬁeld, you must specify the imageManifestMediaType in the request.

Type: String Required: No imageTag (p. 50)

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

(57)

Response Syntax

Type: String

Required: No registryId (p. 50)

The AWS account ID, or registry alias, that's associated with the public registry that contains the repository where the image is put. If you do not specify a registry, the default public registry is assumed.

Type: String

The name of the repository where the image is put.

Type: String

Required: Yes

Response Syntax

{ "image": { "imageId": {

},

"imageManifest": "string",

"imageManifestMediaType": "string", "registryId": "string",

"repositoryName": "string"

}}

Response Elements

image (p. 51)

Details of the image uploaded.

Type: Image (p. 72) object

Amazon Elastic Container Registry Public API Reference API Version 2020-10-30

Amazon Elastic

Container Registry Public

API Reference

API Version 2020-10-30

Amazon Elastic Container Registry Public: API Reference

Table of Contents

Welcome

Actions

BatchCheckLayerAvailability

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

BatchDeleteImage

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CompleteLayerUpload

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateRepository

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DeleteRepository

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DeleteRepositoryPolicy

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeImages

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeImageTags

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeRegistries

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeRepositories

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

GetAuthorizationToken