Copyright	(c) 2013-2021 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

Amazonka.ECRPublic.BatchDeleteImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a list of specified images within a repository in a public registry. 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.

Synopsis

data BatchDeleteImage = BatchDeleteImage' {
- registryId :: Maybe Text
- repositoryName :: Text
- imageIds :: NonEmpty ImageIdentifier
}
newBatchDeleteImage :: Text -> NonEmpty ImageIdentifier -> BatchDeleteImage
batchDeleteImage_registryId :: Lens' BatchDeleteImage (Maybe Text)
batchDeleteImage_repositoryName :: Lens' BatchDeleteImage Text
batchDeleteImage_imageIds :: Lens' BatchDeleteImage (NonEmpty ImageIdentifier)
data BatchDeleteImageResponse = BatchDeleteImageResponse' {
- failures :: Maybe [ImageFailure]
- imageIds :: Maybe (NonEmpty ImageIdentifier)
- httpStatus :: Int
}
newBatchDeleteImageResponse :: Int -> BatchDeleteImageResponse
batchDeleteImageResponse_failures :: Lens' BatchDeleteImageResponse (Maybe [ImageFailure])
batchDeleteImageResponse_imageIds :: Lens' BatchDeleteImageResponse (Maybe (NonEmpty ImageIdentifier))
batchDeleteImageResponse_httpStatus :: Lens' BatchDeleteImageResponse Int

Creating a Request

data BatchDeleteImage Source #

See: newBatchDeleteImage smart constructor.

Constructors

BatchDeleteImage'

Fields

registryId :: Maybe Text
The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed.
repositoryName :: Text
The repository in a public registry that contains the image to delete.
imageIds :: NonEmpty ImageIdentifier
A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Instances

Instances details

Eq BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods (==) :: BatchDeleteImage -> BatchDeleteImage -> Bool # (/=) :: BatchDeleteImage -> BatchDeleteImage -> Bool #
Read BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods readsPrec :: Int -> ReadS BatchDeleteImage # readList :: ReadS [BatchDeleteImage] # readPrec :: ReadPrec BatchDeleteImage # readListPrec :: ReadPrec [BatchDeleteImage] #
Show BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods showsPrec :: Int -> BatchDeleteImage -> ShowS # show :: BatchDeleteImage -> String # showList :: [BatchDeleteImage] -> ShowS #
Generic BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Associated Types type Rep BatchDeleteImage :: Type -> Type # Methods from :: BatchDeleteImage -> Rep BatchDeleteImage x # to :: Rep BatchDeleteImage x -> BatchDeleteImage #
NFData BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods rnf :: BatchDeleteImage -> () #
Hashable BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods hashWithSalt :: Int -> BatchDeleteImage -> Int # hash :: BatchDeleteImage -> Int #
ToJSON BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods toJSON :: BatchDeleteImage -> Value # toEncoding :: BatchDeleteImage -> Encoding # toJSONList :: [BatchDeleteImage] -> Value # toEncodingList :: [BatchDeleteImage] -> Encoding #
AWSRequest BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Associated Types type AWSResponse BatchDeleteImage # Methods request :: BatchDeleteImage -> Request BatchDeleteImage # response :: MonadResource m => Logger -> Service -> Proxy BatchDeleteImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchDeleteImage))) #
ToHeaders BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods toHeaders :: BatchDeleteImage -> [Header] #
ToPath BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods toPath :: BatchDeleteImage -> ByteString #
ToQuery BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods toQuery :: BatchDeleteImage -> QueryString #
type Rep BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage type Rep BatchDeleteImage = D1 ('MetaData "BatchDeleteImage" "Amazonka.ECRPublic.BatchDeleteImage" "libZSservicesZSamazonka-ecr-publicZSamazonka-ecr-public" 'False) (C1 ('MetaCons "BatchDeleteImage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ImageIdentifier)))))
type AWSResponse BatchDeleteImage Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage type AWSResponse BatchDeleteImage = BatchDeleteImageResponse

newBatchDeleteImage Source #

Arguments

:: Text	`$sel:repositoryName:BatchDeleteImage'`
-> NonEmpty ImageIdentifier	`$sel:imageIds:BatchDeleteImage'`
-> BatchDeleteImage

Create a value of BatchDeleteImage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:registryId:BatchDeleteImage', batchDeleteImage_registryId - The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed.

$sel:repositoryName:BatchDeleteImage', batchDeleteImage_repositoryName - The repository in a public registry that contains the image to delete.

$sel:imageIds:BatchDeleteImage', batchDeleteImage_imageIds - A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Request Lenses

batchDeleteImage_registryId :: 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 public registry is assumed.

batchDeleteImage_repositoryName :: Lens' BatchDeleteImage Text Source #

The repository in a public registry that contains the image to delete.

batchDeleteImage_imageIds :: Lens' BatchDeleteImage (NonEmpty 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

data BatchDeleteImageResponse Source #

See: newBatchDeleteImageResponse smart constructor.

Constructors

BatchDeleteImageResponse'
Fields failures :: Maybe [ImageFailure] Any failures associated with the call. imageIds :: Maybe (NonEmpty ImageIdentifier) The image IDs of the deleted images. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods (==) :: BatchDeleteImageResponse -> BatchDeleteImageResponse -> Bool # (/=) :: BatchDeleteImageResponse -> BatchDeleteImageResponse -> Bool #
Read BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods readsPrec :: Int -> ReadS BatchDeleteImageResponse # readList :: ReadS [BatchDeleteImageResponse] # readPrec :: ReadPrec BatchDeleteImageResponse # readListPrec :: ReadPrec [BatchDeleteImageResponse] #
Show BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods showsPrec :: Int -> BatchDeleteImageResponse -> ShowS # show :: BatchDeleteImageResponse -> String # showList :: [BatchDeleteImageResponse] -> ShowS #
Generic BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Associated Types type Rep BatchDeleteImageResponse :: Type -> Type # Methods from :: BatchDeleteImageResponse -> Rep BatchDeleteImageResponse x # to :: Rep BatchDeleteImageResponse x -> BatchDeleteImageResponse #
NFData BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage Methods rnf :: BatchDeleteImageResponse -> () #
type Rep BatchDeleteImageResponse Source #
Instance details Defined in Amazonka.ECRPublic.BatchDeleteImage type Rep BatchDeleteImageResponse = D1 ('MetaData "BatchDeleteImageResponse" "Amazonka.ECRPublic.BatchDeleteImage" "libZSservicesZSamazonka-ecr-publicZSamazonka-ecr-public" 'False) (C1 ('MetaCons "BatchDeleteImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageFailure])) :: (S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ImageIdentifier))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchDeleteImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchDeleteImageResponse'`
-> BatchDeleteImageResponse

Create a value of BatchDeleteImageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failures:BatchDeleteImageResponse', batchDeleteImageResponse_failures - Any failures associated with the call.

$sel:imageIds:BatchDeleteImage', batchDeleteImageResponse_imageIds - The image IDs of the deleted images.

$sel:httpStatus:BatchDeleteImageResponse', batchDeleteImageResponse_httpStatus - The response's http status code.

Response Lenses

batchDeleteImageResponse_failures :: Lens' BatchDeleteImageResponse (Maybe [ImageFailure]) Source #

Any failures associated with the call.

batchDeleteImageResponse_imageIds :: Lens' BatchDeleteImageResponse (Maybe (NonEmpty ImageIdentifier)) Source #

The image IDs of the deleted images.

batchDeleteImageResponse_httpStatus :: Lens' BatchDeleteImageResponse Int Source #

The response's http status code.