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

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginBatchDeleteImage and EndBatchDeleteImage.

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

Syntax

C#
public abstract Task<BatchDeleteImageResponse> BatchDeleteImageAsync(
         BatchDeleteImageRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ECR.Model.BatchDeleteImageRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also