libZSservicesZSamazonka-ecrZSamazonka-ecr
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECR.BatchDeleteImage

Description

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.

Synopsis

Creating a Request

data BatchDeleteImage Source #

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

See: newBatchDeleteImage smart constructor.

Constructors

BatchDeleteImage' 

Fields

  • registryId :: Maybe Text

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

    The repository that contains the image to delete.

  • imageIds :: [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.ECR.BatchDeleteImage

Read BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Show BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Generic BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Associated Types

type Rep BatchDeleteImage :: Type -> Type #

NFData BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Methods

rnf :: BatchDeleteImage -> () #

Hashable BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

ToJSON BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

AWSRequest BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Associated Types

type AWSResponse BatchDeleteImage #

ToHeaders BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

ToPath BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

ToQuery BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

type Rep BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

type Rep BatchDeleteImage = D1 ('MetaData "BatchDeleteImage" "Amazonka.ECR.BatchDeleteImage" "libZSservicesZSamazonka-ecrZSamazonka-ecr" '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 [ImageIdentifier]))))
type AWSResponse BatchDeleteImage Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

newBatchDeleteImage Source #

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

$sel:repositoryName:BatchDeleteImage', batchDeleteImage_repositoryName - The repository 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 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.

batchDeleteImage_repositoryName :: Lens' BatchDeleteImage Text Source #

The repository that contains the image to delete.

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

data BatchDeleteImageResponse Source #

See: newBatchDeleteImageResponse smart constructor.

Constructors

BatchDeleteImageResponse' 

Fields

Instances

Instances details
Eq BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Read BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Show BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Generic BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

Associated Types

type Rep BatchDeleteImageResponse :: Type -> Type #

NFData BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

type Rep BatchDeleteImageResponse Source # 
Instance details

Defined in Amazonka.ECR.BatchDeleteImage

type Rep BatchDeleteImageResponse = D1 ('MetaData "BatchDeleteImageResponse" "Amazonka.ECR.BatchDeleteImage" "libZSservicesZSamazonka-ecrZSamazonka-ecr" '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 [ImageIdentifier])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchDeleteImageResponse Source #

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