AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Deletes a list of specified images within a specified repository. Images are specified with either 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.


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

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


public virtual BatchDeleteImageResponse BatchDeleteImage(
         BatchDeleteImageRequest request
Type: Amazon.ECR.Model.BatchDeleteImageRequest

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

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


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.


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 response = client.BatchDeleteImage(new BatchDeleteImageRequest 
    ImageIds = new List {
        new ImageIdentifier { ImageTag = "precise" }
    RepositoryName = "ubuntu"

List failures = response.Failures;
List imageIds = response.ImageIds;


Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also