Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- batchDeleteImage :: Text -> BatchDeleteImage
- data BatchDeleteImage
- bdiRegistryId :: Lens' BatchDeleteImage (Maybe Text)
- bdiRepositoryName :: Lens' BatchDeleteImage Text
- bdiImageIds :: Lens' BatchDeleteImage [ImageIdentifier]
- batchDeleteImageResponse :: Int -> BatchDeleteImageResponse
- data BatchDeleteImageResponse
- bdirsFailures :: Lens' BatchDeleteImageResponse [ImageFailure]
- bdirsImageIds :: Lens' BatchDeleteImageResponse [ImageIdentifier]
- bdirsResponseStatus :: Lens' BatchDeleteImageResponse Int
Creating a Request
Creates a value of BatchDeleteImage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdiRegistryId
- The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.bdiRepositoryName
- The repository that contains the image to delete.bdiImageIds
- A list of image ID references that correspond to images to delete. The format of theimageIds
reference isimageTag=tag
orimageDigest=digest
.
data BatchDeleteImage Source #
Deletes specified images within a specified repository. Images are specified with either the imageTag
or imageDigest
.
See: batchDeleteImage
smart constructor.
Request Lenses
bdiRegistryId :: Lens' BatchDeleteImage (Maybe Text) Source #
The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
bdiRepositoryName :: Lens' BatchDeleteImage Text Source #
The repository that contains the image to delete.
bdiImageIds :: Lens' BatchDeleteImage [ImageIdentifier] Source #
A list of image ID references that correspond to images to delete. The format of the imageIds
reference is imageTag=tag
or imageDigest=digest
.
Destructuring the Response
batchDeleteImageResponse Source #
Creates a value of BatchDeleteImageResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdirsFailures
- Any failures associated with the call.bdirsImageIds
- The image IDs of the deleted images.bdirsResponseStatus
- -- | The response status code.
data BatchDeleteImageResponse Source #
See: batchDeleteImageResponse
smart constructor.
Response Lenses
bdirsFailures :: Lens' BatchDeleteImageResponse [ImageFailure] Source #
Any failures associated with the call.
bdirsImageIds :: Lens' BatchDeleteImageResponse [ImageIdentifier] Source #
The image IDs of the deleted images.
bdirsResponseStatus :: Lens' BatchDeleteImageResponse Int Source #
- - | The response status code.