AmazonECRClient.BatchDeleteImage Method (BatchDeleteImageRequest)

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to BatchDeleteImageAsync.

Namespace: Amazon.ECR
Assembly: AWSSDK.ECR.dll
Version: 3.x.y.z

Syntax

public virtual BatchDeleteImageResponse BatchDeleteImage(
         BatchDeleteImageRequest request
)

Parameters

request: Type: Amazon.ECR.Model.BatchDeleteImageRequest

Container for the necessary parameters to execute the BatchDeleteImage service method.

Return Value

Type: BatchDeleteImageResponse

The response from the BatchDeleteImage service method, as returned by ECR.

Exceptions

Exception	Condition
InvalidParameterException	The specified parameter is invalid. Review the available parameters for the API request.
RepositoryNotFoundException	The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
ServerException	These errors are usually caused by a server-side issue.

Examples

This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.

To delete multiple images


var client = new AmazonECRClient();
var response = client.BatchDeleteImage(new BatchDeleteImageRequest 
{
    ImageIds = new List<ImageIdentifier> {
        new ImageIdentifier { ImageTag = "precise" }
    },
    RepositoryName = "ubuntu"
});

List<ImageFailure> failures = response.Failures;
List<ImageIdentifier> imageIds = response.ImageIds;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonECRClient.BatchDeleteImage (BatchDeleteImageRequest)

Method