Container for the parameters to the BatchDeleteImage operation.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ECR.AmazonECRRequest
Amazon.ECR.Model.BatchDeleteImageRequest
Namespace: Amazon.ECR.Model
Assembly: AWSSDK.ECR.dll
Version: 3.x.y.z
Syntax
public class BatchDeleteImageRequest : AmazonECRRequest IAmazonWebServiceRequest
The BatchDeleteImageRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
BatchDeleteImageRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ImageIds | System.Collections.Generic.List<Amazon.ECR.Model.ImageIdentifier> |
Gets and sets the property ImageIds.
A list of image ID references that correspond to images to delete. The format of the
|
|
|
RegistryId | System.String |
Gets and sets the property RegistryId. The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed. |
|
|
RepositoryName | System.String |
Gets and sets the property RepositoryName. The repository that contains the image to delete. |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5