amazonka-kms-2.0: Amazon Key Management Service 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.KMS.UntagResource

Description

Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

When it succeeds, the UntagResource operation doesn't return any output. Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.

For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:UntagResource (key policy)

Related operations

  • CreateKey
  • ListResourceTags
  • ReplicateKey
  • TagResource
Synopsis

Creating a Request

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource' 

Fields

  • keyId :: Text

    Identifies the KMS key from which you are removing tags.

    Specify the key ID or key ARN of the KMS key.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

  • tagKeys :: [Text]

    One or more tag keys. Specify only the tag keys, not the tag values.

Instances

Instances details
ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

toJSON :: UntagResource -> Value #

toEncoding :: UntagResource -> Encoding #

toJSONList :: [UntagResource] -> Value #

toEncodingList :: [UntagResource] -> Encoding #

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

toHeaders :: UntagResource -> [Header] #

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

toPath :: UntagResource -> ByteString #

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

toQuery :: UntagResource -> QueryString #

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Associated Types

type AWSResponse UntagResource #

Methods

request :: (Service -> Service) -> UntagResource -> Request UntagResource #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UntagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UntagResource))) #

Generic UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

Methods

from :: UntagResource -> Rep UntagResource x #

to :: Rep UntagResource x -> UntagResource #

Read UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

readsPrec :: Int -> ReadS UntagResource #

readList :: ReadS [UntagResource] #

readPrec :: ReadPrec UntagResource #

readListPrec :: ReadPrec [UntagResource] #

Show UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

showsPrec :: Int -> UntagResource -> ShowS #

show :: UntagResource -> String #

showList :: [UntagResource] -> ShowS #

NFData UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

rnf :: UntagResource -> () #

Eq UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

(==) :: UntagResource -> UntagResource -> Bool #

(/=) :: UntagResource -> UntagResource -> Bool #

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

hashWithSalt :: Int -> UntagResource -> Int #

hash :: UntagResource -> Int #

type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

type AWSResponse UntagResource = UntagResourceResponse
type Rep UntagResource Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.KMS.UntagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newUntagResource Source #

Arguments

:: Text

UntagResource

-> UntagResource 

Create a value of UntagResource 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:

UntagResource, untagResource_keyId - Identifies the KMS key from which you are removing tags.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:tagKeys:UntagResource', untagResource_tagKeys - One or more tag keys. Specify only the tag keys, not the tag values.

Request Lenses

untagResource_keyId :: Lens' UntagResource Text Source #

Identifies the KMS key from which you are removing tags.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

One or more tag keys. Specify only the tag keys, not the tag values.

Destructuring the Response

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Constructors

UntagResourceResponse' 

Instances

Instances details
Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

Methods

from :: UntagResourceResponse -> Rep UntagResourceResponse x #

to :: Rep UntagResourceResponse x -> UntagResourceResponse #

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

readsPrec :: Int -> ReadS UntagResourceResponse #

readList :: ReadS [UntagResourceResponse] #

readPrec :: ReadPrec UntagResourceResponse #

readListPrec :: ReadPrec [UntagResourceResponse] #

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

showsPrec :: Int -> UntagResourceResponse -> ShowS #

show :: UntagResourceResponse -> String #

showList :: [UntagResourceResponse] -> ShowS #

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

Methods

(==) :: UntagResourceResponse -> UntagResourceResponse -> Bool #

(/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool #

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.KMS.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.KMS.UntagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

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