Amazon Elastic Container Registry API Reference API Version 2015-09-21

(1)

Amazon Elastic Container Registry

API Reference

API Version 2015-09-21

(2)

Amazon Elastic Container Registry: 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 (Amazon ECR) is a managed container image registry service.

Customers can use the familiar Docker CLI, or their 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 private repositories with resource-based permissions using IAM so that speciﬁc users or Amazon EC2 instances can access repositories and images.

Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the AWS General Reference.

This document was last published on March 6, 2022.

(12)

Actions

The following actions are supported:

• BatchCheckLayerAvailability (p. 4)

• BatchDeleteImage (p. 8)

• BatchGetImage (p. 13)

• BatchGetRepositoryScanningConﬁguration (p. 17)

• CompleteLayerUpload (p. 20)

• CreatePullThroughCacheRule (p. 24)

• CreateRepository (p. 27)

• DeleteLifecyclePolicy (p. 32)

• DeletePullThroughCacheRule (p. 36)

• DeleteRegistryPolicy (p. 39)

• DeleteRepository (p. 41)

• DeleteRepositoryPolicy (p. 45)

• DescribeImageReplicationStatus (p. 49)

• DescribeImages (p. 52)

• DescribeImageScanFindings (p. 58)

• DescribePullThroughCacheRules (p. 65)

• DescribeRegistry (p. 68)

• DescribeRepositories (p. 70)

• GetAuthorizationToken (p. 74)

• GetDownloadUrlForLayer (p. 77)

• GetLifecyclePolicy (p. 80)

• GetLifecyclePolicyPreview (p. 84)

• GetRegistryPolicy (p. 89)

• GetRegistryScanningConﬁguration (p. 91)

• GetRepositoryPolicy (p. 93)

• InitiateLayerUpload (p. 97)

• ListImages (p. 100)

• ListTagsForResource (p. 104)

• PutImage (p. 107)

• PutImageScanningConﬁguration (p. 112)

• PutImageTagMutability (p. 115)

• PutLifecyclePolicy (p. 119)

• PutRegistryPolicy (p. 123)

• PutRegistryScanningConﬁguration (p. 125)

• PutReplicationConﬁguration (p. 128)

• SetRepositoryPolicy (p. 131)

• StartImageScan (p. 135)

• StartLifecyclePolicyPreview (p. 139)

• TagResource (p. 143)

• UntagResource (p. 145)

(13)

• UploadLayerPart (p. 147)

(14)

BatchCheckLayerAvailability

Checks the availability of one or more image layers in a repository.

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. 210).

The request accepts the following data in JSON format.

layerDigests (p. 4)

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. 4)

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

Type: String

Pattern: [0-9]{12}

Required: No repositoryName (p. 4)

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

Type: String

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

(15)

Response Syntax

Required: Yes

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. 5)

Any failures associated with the call.

Type: Array of LayerFailure (p. 180) objects layers (p. 5)

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

Type: Array of Layer (p. 179) objects

Errors

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

InvalidParameterException

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

HTTP Status Code: 400 RepositoryNotFoundException

The speciﬁed repository could not be found. Check the spelling of the speciﬁed repository and ensure that you are performing operations on the correct registry.

HTTP Status Code: 400 ServerException

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

(16)

Examples

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example checks the availability of an image layer in the amazonlinux repository.

Sample Request

POST / HTTP/1.1

Host: ecr.us-west-2.amazonaws.com Accept-Encoding: identity

Content-Length: 126

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailability X-Amz-Date: 20161216T195733Zc

User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.3.0 botocore/1.4.79 Content-Type: application/x-amz-json-1.1

Authorization: AUTHPARAMS { "layerDigests": [

"sha256:8e3fa21c4cc40232e835a6761332d225c7af3235c5755f44ada2ed9d0e4ab7e8"

], "repositoryName": "amazonlinux"

}

Sample Response

HTTP/1.1 200 OK Server: Server

Date: Fri, 16 Dec 2016 19:57:33 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 233

Connection: keep-alive

x-amzn-RequestId: e2422faf-c3c9-11e6-a3ee-63b3b5dcf3b9 { "failures": [],

"layers": [ {

"layerAvailability": "AVAILABLE", "layerDigest":

"sha256:8e3fa21c4cc40232e835a6761332d225c7af3235c5755f44ada2ed9d0e4ab7e8", "layerSize": 91768077,

"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip"

} ]}

(17)

See Also

BatchDeleteImage

Deletes a list of speciﬁed images within a repository. 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 image's digest in your request.

Request Syntax

{ "imageIds": [ {

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

} ],

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

}

Request Parameters

imageIds (p. 8)

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. 172) objects

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

Type: String

Pattern: [0-9]{12}

The repository that contains the image to delete.

Type: String

(19)

Response Syntax

Required: Yes

Response Syntax

{

"failures": [ {

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

} } ],

"imageIds": [ {

} ]}

Response Elements

failures (p. 9)

Type: Array of ImageFailure (p. 171) objects imageIds (p. 9)

The image IDs of the deleted images.

Errors

(20)

Examples

ServerException

Examples

Example

This example deletes an image in the ubuntu repository with the imageTag value of xenial.

Sample Request

POST / HTTP/1.1

Content-Length: 66

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.BatchDeleteImage X-Amz-Date: 20161216T193711Z

Authorization: AUTHPARAMS { "repositoryName": "ubuntu", "imageIds": [

{

"imageTag": "xenial"

} ]}

Sample Response

x-amzn-RequestId: 09cc7023-c3c7-11e6-8acf-61b7dd8abe56 { "failures": [],

"imageIds": [ {

"imageDigest":

"sha256:7a64bc9c8843b0a8c8b8a7e4715b7615e4e1b0d8ca3c7e7a76ec8250899c397a", "imageTag": "xenial"

(21)

See Also

} ]}

Example

This example deletes an image (and all of its tags) in the ubuntu repository with the imageDigest value of sha256:7a64bc9c8843b0a8c8b8a7e4715b7615e4e1b0d8ca3c7e7a76ec8250899c397a.

Sample Request

POST / HTTP/1.1

Content-Length: 134

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.BatchDeleteImage X-Amz-Date: 20161216T194250Z

Authorization: AUTHPARAMS {

"repositoryName": "ubuntu", "imageIds": [

{

"imageDigest":

"sha256:7a64bc9c8843b0a8c8b8a7e4715b7615e4e1b0d8ca3c7e7a76ec8250899c397a"

} ]}

Sample Response

x-amzn-RequestId: d441a9f6-c3c7-11e6-8acf-61b7dd8abe56 { "failures": [],

"imageIds": [ {

"imageDigest":

"sha256:7a64bc9c8843b0a8c8b8a7e4715b7615e4e1b0d8ca3c7e7a76ec8250899c397a", "imageTag": "xenial"

}, {

"imageDigest":

"sha256:7a64bc9c8843b0a8c8b8a7e4715b7615e4e1b0d8ca3c7e7a76ec8250899c397a", "imageTag": "latest"

} ]}

BatchGetImage

Gets detailed information for an image. Images are speciﬁed with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Request Syntax

{ "acceptedMediaTypes": [ "string" ], "imageIds": [

{

} ],

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

}

Request Parameters

acceptedMediaTypes (p. 13)

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/

vnd.oci.image.manifest.v1+json Type: Array of strings

Required: No imageIds (p. 13)

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

The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

Type: String

(24)

Response Syntax

Pattern: [0-9]{12}

The repository that contains the images to describe.

Type: String

Required: Yes

Response Syntax

{ "failures": [ {

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

} } ],

"images": [ {

"imageId": {

},

"imageManifest": "string",

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

"repositoryName": "string"

} ] }

Response Elements

failures (p. 14)

Type: Array of ImageFailure (p. 171) objects images (p. 14)

A list of image objects corresponding to the image references in the request.

Type: Array of Image (p. 166) objects

(25)

Errors

Examples

Example

This example describes an image in the amazonlinux repository with the imageTag value of latest.

Sample Request

POST / HTTP/1.1

Content-Length: 71

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.BatchGetImage X-Amz-Date: 20161216T195356Z

Authorization: AUTHPARAMS

{ "repositoryName": "amazonlinux", "imageIds": [

{

"imageTag": "latest"

} ]}

(26)

See Also

Sample Response

x-amzn-RequestId: 60dc1ea1-c3c9-11e6-aa04-25c3a5fb1b54 { "failures": [],

"images": [ {

"imageId": { "imageDigest":

"sha256:f1d4ae3f7261a72e98c6ebefe9985cf10a0ea5bd762585a43e0700ed99863807", "imageTag": "latest"

},

"imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/

vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\":

\"application/vnd.docker.container.image.v1+json\",\n \"size\": 1486,\n

\"digest\": \"sha256:5b52b314511a611975c2c65e695d920acdf8ae8848fe0ef00b7d018d1f118b64\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/

vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 91768077,\n \"digest

\": \"sha256:8e3fa21c4cc40232e835a6761332d225c7af3235c5755f44ada2ed9d0e4ab7e8\"\n }\n ]\n}",

"registryId": "012345678910", "repositoryName": "amazonlinux"

} ]}

BatchGetRepositoryScanningConﬁguration

Gets the scanning conﬁguration for one or more repositories.

Request Syntax

{ "repositoryNames": [ "string" ] }

Request Parameters

repositoryNames (p. 17)

One or more repository names to get the scanning conﬁguration for.

Required: Yes

Response Syntax

{ "failures": [ {

"failureCode": "string", "failureReason": "string", "repositoryName": "string"

} ],

"scanningConfigurations": [ {

"appliedScanFilters": [ {

"filter": "string", "filterType": "string"

} ],

"repositoryArn": "string", "repositoryName": "string", "scanFrequency": "string", "scanOnPush": boolean }

]}

(28)

Response Elements

failures (p. 17)

Type: Array of RepositoryScanningConﬁgurationFailure (p. 202) objects scanningConﬁgurations (p. 17)

The scanning conﬁguration for the requested repositories.

Type: Array of RepositoryScanningConﬁguration (p. 200) objects

Errors

HTTP Status Code: 500 ValidationException

There was an exception validating this request.

CompleteLayerUpload

Informs Amazon ECR that the image layer upload has completed for a speciﬁed 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 per each new image layer to verify that the upload has completed.

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", "uploadId": "string"

}

Request Parameters

layerDigests (p. 20)

The sha256 digest of the image layer.

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

The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

The name of the repository to associate with the image layer.

Type: String

(31)

Response Syntax

Required: Yes uploadId (p. 20)

The upload ID from a previous InitiateLayerUpload (p. 97) 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. 21)

The sha256 digest of the image layer.

Type: String

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

registryId (p. 21)

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

repositoryName (p. 21)

The repository name associated with the request.

Type: String

uploadId (p. 21)

The upload ID associated with the layer.

(32)

Errors

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}

Errors

EmptyUploadException

The speciﬁed layer upload does not contain any layer parts.

HTTP Status Code: 400 InvalidLayerException

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest speciﬁed.

HTTP Status Code: 400 InvalidParameterException

HTTP Status Code: 400 KmsException

The operation failed due to a KMS exception.

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: 500 UploadNotFoundException

The upload could not be found, or the speciﬁed upload ID is not valid for this repository.

(33)

See Also

CreatePullThroughCacheRule

Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.

Request Syntax

{ "ecrRepositoryPrefix": "string", "registryId": "string",

"upstreamRegistryUrl": "string"

}

Request Parameters

ecrRepositoryPreﬁx (p. 24)

The repository name preﬁx to use when caching images from the source registry.

Type: String

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

The AWS account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

upstreamRegistryUrl (p. 24)

The registry URL of the upstream public registry to use as the source for the pull through cache rule.

Type: String Required: Yes

Response Syntax

{ "createdAt": number,

"ecrRepositoryPrefix": "string", "registryId": "string",

(35)

Response Elements

}

Response Elements

createdAt (p. 24)

The date and time, in JavaScript date format, when the pull through cache rule was created.

Type: Timestamp ecrRepositoryPreﬁx (p. 24)

The Amazon ECR repository preﬁx associated with the pull through cache rule.

Type: String

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

Type: String

Pattern: [0-9]{12}

The upstream registry URL associated with the pull through cache rule.

Type: String

Errors

HTTP Status Code: 400 LimitExceededException

The operation did not 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.

PullThroughCacheRuleAlreadyExistsException

A pull through cache rule with these settings already exists for the private registry.

(36)

See Also

ServerException

UnsupportedUpstreamRegistryException

The speciﬁed upstream registry isn't supported.

CreateRepository

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

Request Syntax

{ "encryptionConfiguration": { "encryptionType": "string", "kmsKey": "string"

},

"imageScanningConfiguration": { "scanOnPush": boolean

},

"imageTagMutability": "string", "registryId": "string",

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

{

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

} ]}

Request Parameters

encryptionConﬁguration (p. 27)

The encryption conﬁguration for the repository. This determines how the contents of your repository are encrypted at rest.

Type: EncryptionConﬁguration (p. 161) object Required: No

imageScanningConﬁguration (p. 27)

The image scanning conﬁguration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

Type: ImageScanningConﬁguration (p. 177) object Required: No

imageTagMutability (p. 27)

The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is speciﬁed, all image tags within the repository will be immutable which will prevent them from being overwritten.

Type: String

Valid Values: MUTABLE | IMMUTABLE

(38)

Response Syntax

Required: No registryId (p. 27)

The AWS account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

The name to use for the repository. The repository name may be speciﬁed on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

Type: String

Required: Yes tags (p. 27)

The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you deﬁne. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Type: Array of Tag (p. 207) objects Required: No

Response Syntax

{

"repository": { "createdAt": number,

"encryptionConfiguration": { "encryptionType": "string", "kmsKey": "string"

},

"repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string"

} }

Response Elements

(39)

Errors

repository (p. 28)

The repository that was created.

Type: Repository (p. 197) 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.

HTTP Status Code: 400 LimitExceededException

The operation did not 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.

Examples

(40)

See Also

Example

This example creates a repository called sample-repo in the default registry for an account.

Sample Request

POST / HTTP/1.1

Host: api.ecr.us-west-2.amazonaws.com Accept-Encoding: identity

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.CreateRepository Content-Type: application/x-amz-json-1.1

User-Agent: aws-cli/1.16.190 Python/3.6.1 Darwin/16.7.0 botocore/1.12.180 X-Amz-Date: 20190715T204735Z

Authorization: AUTHPARAMS Content-Length: 33

{

"repositoryName": "sample-repo"

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f Content-Type: application/x-amz-json-1.1

Content-Length: 339 Connection: keep-alive { "repository":{

"repositoryArn":"arn:aws:ecr:us-west-2:012345678910:repository/sample-repo", "registryId":"012345678910",

"repositoryName":"sample-repo",

"repositoryUri":"012345678910.dkr.ecr.us-west-2.amazonaws.com/sample-repo", "createdAt":1.563223656E9,

"imageTagMutability":"MUTABLE", "imageScanningConfiguration": { "scanOnPush": false }

} }

DeleteLifecyclePolicy

Deletes the lifecycle policy associated with the speciﬁed repository.

Request Syntax

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

}

Request Parameters

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

Type: String

Pattern: [0-9]{12}

The name of the repository.

Type: String

Required: Yes

Response Syntax

{ "lastEvaluatedAt": number, "lifecyclePolicyText": "string", "registryId": "string",

"repositoryName": "string"

}

Response Elements

(43)

Errors

lastEvaluatedAt (p. 32)

The time stamp of the last time that the lifecycle policy was run.

Type: Timestamp lifecyclePolicyText (p. 32)

The JSON lifecycle policy text.

Type: String

Pattern: [0-9]{12}

repositoryName (p. 32)

The repository name associated with the request.

Type: String

Errors

LifecyclePolicyNotFoundException

The lifecycle policy could not be found, and no policy is set to the repository.

(44)

Examples

Example

This example deletes a lifecycle policy for a repository called project-a/amazon-ecs-sample in the default registry for an account.

Sample Request

POST / HTTP/1.1

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.DeleteLifecyclePolicy Content-Type: application/x-amz-json-1.1

{ "repositoryName": "project-a/amazon-ecs-sample", }

Sample Response

Date: Fri, 01 Sep 2017 19:42:18 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 340

x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "lastEvaluatedAt":1.504295007E9,

"lifecyclePolicyText":"{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":

\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":

\"expire\"}}]}",

"registryId":"012345678910",

"repositoryName":"project-a/amazon-ecs-sample"

}

DeletePullThroughCacheRule

Deletes a pull through cache rule.

Request Syntax

{ "ecrRepositoryPrefix": "string", "registryId": "string"

}

Request Parameters

ecrRepositoryPreﬁx (p. 36)

The Amazon ECR repository preﬁx associated with the pull through cache rule to delete.

Type: String

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

The AWS account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

Response Syntax

{ "createdAt": number,

"ecrRepositoryPrefix": "string", "registryId": "string",

}

Response Elements

(47)

Errors

createdAt (p. 36)

The timestamp associated with the pull through cache rule.

Type: Timestamp ecrRepositoryPreﬁx (p. 36)

The Amazon ECR repository preﬁx associated with the request.

Type: String

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

Type: String

Pattern: [0-9]{12}

The upstream registry URL associated with the pull through cache rule.

Type: String

Errors

PullThroughCacheRuleNotFoundException

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.

DeleteRegistryPolicy

Deletes the registry permissions policy.

Response Syntax

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

}

Response Elements

policyText (p. 39)

The contents of the registry permissions policy that was deleted.

Type: String

Pattern: [0-9]{12}

Errors

HTTP Status Code: 400 RegistryPolicyNotFoundException

The registry doesn't have an associated registry policy.

(50)

See Also

DeleteRepository

Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.

Request Syntax

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

}

Request Parameters

force (p. 41)

If a repository contains images, forces the deletion.

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

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

Type: String

Pattern: [0-9]{12}

The name of the repository to delete.

Type: String

Required: Yes

Response Syntax

{

"repository": { "createdAt": number,

(52)

Response Elements

"encryptionConfiguration": { "encryptionType": "string", "kmsKey": "string"

},

"repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string"

}}

Response Elements

repository (p. 41)

The repository that was deleted.

Type: Repository (p. 197) 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.

(53)

Examples

Example

This example deletes a repository named ubuntu in the default registry for an account.

Sample Request

POST / HTTP/1.1

Host: api.ecr.us-west-2.amazonaws.com Accept-Encoding: identity

X-Amz-Target: AmazonEC2ContainerRegistry_V20150921.DeleteRepository Content-Type: application/x-amz-json-1.1

{ "repositoryName":"sample-repo"

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f Content-Type: application/x-amz-json-1.1

Content-Length: 252 Connection: keep-alive { "repository":{

"createdAt":1.563223656E9, "registryId":"012345678910",

"repositoryArn":"arn:aws:ecr:us-west-2:012345678910:repository/sample-repo", "repositoryName":"sample-repo",

"repositoryUri":"012345678910.dkr.ecr.us-west-2.amazonaws.com/sample-repo"

}}

Amazon Elastic Container Registry API Reference API Version 2015-09-21

Amazon Elastic Container Registry

API Reference

API Version 2015-09-21

Amazon Elastic Container Registry: API Reference

Table of Contents

Welcome

Actions

BatchCheckLayerAvailability

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchDeleteImage

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

Example

Sample Request

Sample Response

See Also

BatchGetImage

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

BatchGetRepositoryScanningConﬁguration

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CompleteLayerUpload

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreatePullThroughCacheRule

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateRepository

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

DeleteLifecyclePolicy

Request Syntax

Request Parameters

Response Syntax