amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DeleteTags

Description

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

Synopsis

Creating a Request

data DeleteTags Source #

See: newDeleteTags smart constructor.

Constructors

DeleteTags' 

Fields

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • tags :: Maybe [Tag]

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

    Constraints: Up to 1000 tags.

  • resources :: [Text]

    The IDs of the resources, separated by spaces.

    Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

Instances

Instances details
ToHeaders DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Methods

toHeaders :: DeleteTags -> [Header] #

ToPath DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

ToQuery DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

AWSRequest DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Associated Types

type AWSResponse DeleteTags #

Generic DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Associated Types

type Rep DeleteTags :: Type -> Type #

Read DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Show DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

NFData DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Methods

rnf :: DeleteTags -> () #

Eq DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Hashable DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

type AWSResponse DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

type Rep DeleteTags Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

type Rep DeleteTags = D1 ('MetaData "DeleteTags" "Amazonka.EC2.DeleteTags" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeleteTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newDeleteTags :: DeleteTags Source #

Create a value of DeleteTags 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:dryRun:DeleteTags', deleteTags_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DeleteTags, deleteTags_tags - The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

DeleteTags, deleteTags_resources - The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

Request Lenses

deleteTags_dryRun :: Lens' DeleteTags (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

deleteTags_tags :: Lens' DeleteTags (Maybe [Tag]) Source #

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

deleteTags_resources :: Lens' DeleteTags [Text] Source #

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

Destructuring the Response

data DeleteTagsResponse Source #

See: newDeleteTagsResponse smart constructor.

Constructors

DeleteTagsResponse' 

Instances

Instances details
Generic DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Associated Types

type Rep DeleteTagsResponse :: Type -> Type #

Read DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Show DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

NFData DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

Methods

rnf :: DeleteTagsResponse -> () #

Eq DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

type Rep DeleteTagsResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteTags

type Rep DeleteTagsResponse = D1 ('MetaData "DeleteTagsResponse" "Amazonka.EC2.DeleteTags" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeleteTagsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteTagsResponse :: DeleteTagsResponse Source #

Create a value of DeleteTagsResponse with all optional fields omitted.

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