/ - Amazon Elastic Container Registry Public

Deletes a list of specified images that are within a repository in a public registry. Images are specified 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.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "registryId": "string", "repositoryName": "string", "imageIds": [] }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

registryId

string

optional

The Amazon Web Services account ID, or registry alias, 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.

>= 2 characters<= 50 characters

repositoryName

string

required

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

>= 2 characters<= 205 characters

Match pattern:

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

imageIds

array[object (ImageIdentifier) {2}]

required

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

>= 1 items<= 100 items

imageDigest

string

optional

The sha256 digest of the image manifest.

imageTag

string

optional

The tag that's used for the image.

>= 1 characters<= 300 characters

Examples

Responses

🟢200Success

application/json

Body

imageIds

array[object (ImageIdentifier) {2}]

optional

The image IDs of the deleted images.

>= 1 items<= 100 items

imageDigest

string

optional

The sha256 digest of the image manifest.

imageTag

string

optional

The tag that's used for the image.

>= 1 characters<= 300 characters

failures

array[object (ImageFailure) {3}]

optional

Any failures associated with the call.

imageId

object

optional

The image ID that's associated with the failure.

failureCode

enum<string>

optional

The code that's associated with the failure.

Allowed values:

InvalidImageDigestInvalidImageTagImageTagDoesNotMatchDigestImageNotFoundMissingDigestAndTagImageReferencedByManifestListKmsError

failureReason

string

optional

The reason for the failure.

🟠480ServerException

🟠481InvalidParameterException

🟠482RepositoryNotFoundException

🟠483UnsupportedCommandException