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

Description

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

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:UpdateKeyDescription (key policy)

Related operations

  • CreateKey
  • DescribeKey
Synopsis

Creating a Request

data UpdateKeyDescription Source #

See: newUpdateKeyDescription smart constructor.

Constructors

UpdateKeyDescription' 

Fields

  • keyId :: Text

    Updates the description of the specified KMS key.

    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.

  • description :: Text

    New description for the KMS key.

Instances

Instances details
ToJSON UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toJSON :: UpdateKeyDescription -> Value #

toEncoding :: UpdateKeyDescription -> Encoding #

toJSONList :: [UpdateKeyDescription] -> Value #

toEncodingList :: [UpdateKeyDescription] -> Encoding #

ToHeaders UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toHeaders :: UpdateKeyDescription -> [Header] #

ToPath UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toPath :: UpdateKeyDescription -> ByteString #

ToQuery UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toQuery :: UpdateKeyDescription -> QueryString #

AWSRequest UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type AWSResponse UpdateKeyDescription #

Methods

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

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

Generic UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type Rep UpdateKeyDescription :: Type -> Type #

Methods

from :: UpdateKeyDescription -> Rep UpdateKeyDescription x #

to :: Rep UpdateKeyDescription x -> UpdateKeyDescription #

Read UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

readsPrec :: Int -> ReadS UpdateKeyDescription #

readList :: ReadS [UpdateKeyDescription] #

readPrec :: ReadPrec UpdateKeyDescription #

readListPrec :: ReadPrec [UpdateKeyDescription] #

Show UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

showsPrec :: Int -> UpdateKeyDescription -> ShowS #

show :: UpdateKeyDescription -> String #

showList :: [UpdateKeyDescription] -> ShowS #

NFData UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

rnf :: UpdateKeyDescription -> () #

Eq UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

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

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

Hashable UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

hashWithSalt :: Int -> UpdateKeyDescription -> Int #

hash :: UpdateKeyDescription -> Int #

type AWSResponse UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

type AWSResponse UpdateKeyDescription = UpdateKeyDescriptionResponse
type Rep UpdateKeyDescription Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

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

newUpdateKeyDescription Source #

Arguments

:: Text

UpdateKeyDescription

-> Text

UpdateKeyDescription

-> UpdateKeyDescription 

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

UpdateKeyDescription, updateKeyDescription_keyId - Updates the description of the specified KMS key.

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.

UpdateKeyDescription, updateKeyDescription_description - New description for the KMS key.

Request Lenses

updateKeyDescription_keyId :: Lens' UpdateKeyDescription Text Source #

Updates the description of the specified KMS key.

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.

updateKeyDescription_description :: Lens' UpdateKeyDescription Text Source #

New description for the KMS key.

Destructuring the Response

data UpdateKeyDescriptionResponse Source #

See: newUpdateKeyDescriptionResponse smart constructor.

Constructors

UpdateKeyDescriptionResponse' 

Instances

Instances details
Generic UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type Rep UpdateKeyDescriptionResponse :: Type -> Type #

Methods

from :: UpdateKeyDescriptionResponse -> Rep UpdateKeyDescriptionResponse x #

to :: Rep UpdateKeyDescriptionResponse x -> UpdateKeyDescriptionResponse #

Read UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

readsPrec :: Int -> ReadS UpdateKeyDescriptionResponse #

readList :: ReadS [UpdateKeyDescriptionResponse] #

readPrec :: ReadPrec UpdateKeyDescriptionResponse #

readListPrec :: ReadPrec [UpdateKeyDescriptionResponse] #

Show UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

showsPrec :: Int -> UpdateKeyDescriptionResponse -> ShowS #

show :: UpdateKeyDescriptionResponse -> String #

showList :: [UpdateKeyDescriptionResponse] -> ShowS #

NFData UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

rnf :: UpdateKeyDescriptionResponse -> () #

Eq UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

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

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

type Rep UpdateKeyDescriptionResponse Source # 
Instance details

Defined in Amazonka.KMS.UpdateKeyDescription

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

newUpdateKeyDescriptionResponse :: UpdateKeyDescriptionResponse Source #

Create a value of UpdateKeyDescriptionResponse with all optional fields omitted.

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