BatchDeleteImage
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.
Request Syntax
{
"imageIds": [
{
"imageDigest": "string",
"imageTag": "string"
}
],
"registryId": "string",
"repositoryName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- imageIds
-
A list of image ID references that correspond to images to delete. The format of the
imageIdsreference isimageTag=tagorimageDigest=digest.Type: Array of ImageIdentifier objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
- registryId
-
The AWS 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.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 50.
Required: No
- repositoryName
-
The repository in a public registry that contains the image to delete.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*Required: Yes
Response Syntax
{
"failures": [
{
"failureCode": "string",
"failureReason": "string",
"imageId": {
"imageDigest": "string",
"imageTag": "string"
}
}
],
"imageIds": [
{
"imageDigest": "string",
"imageTag": "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
-
Any failures associated with the call.
Type: Array of ImageFailure objects
- imageIds
-
The image IDs of the deleted images.
Type: Array of ImageIdentifier objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- RepositoryNotFoundException
-
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnsupportedCommandException
-
The action isn't supported in this Region.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
