Network.AWS.KMS.UpdateKeyDescription

Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey .

You cannot perform this operation on a CMK in a different AWS account.

Creating a Request

updateKeyDescription

Arguments

:: Text

ukdKeyId

-> Text

ukdDescription

-> UpdateKeyDescription

Creates a value of UpdateKeyDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ukdKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. 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 CMK, use ListKeys or DescribeKey .
• ukdDescription - New description for the CMK.

data UpdateKeyDescription

See: updateKeyDescription smart constructor.

Instances

Eq UpdateKeyDescription

Methods

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

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

Data UpdateKeyDescription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateKeyDescription -> c UpdateKeyDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateKeyDescription

toConstr :: UpdateKeyDescription -> Constr

dataTypeOf :: UpdateKeyDescription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateKeyDescription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateKeyDescription)

gmapT :: (forall b. Data b => b -> b) -> UpdateKeyDescription -> UpdateKeyDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateKeyDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateKeyDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateKeyDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateKeyDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateKeyDescription -> m UpdateKeyDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateKeyDescription -> m UpdateKeyDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateKeyDescription -> m UpdateKeyDescription

Read UpdateKeyDescription

Methods

readsPrec :: Int -> ReadS UpdateKeyDescription

readList :: ReadS [UpdateKeyDescription]

readPrec :: ReadPrec UpdateKeyDescription

readListPrec :: ReadPrec [UpdateKeyDescription]

Show UpdateKeyDescription

Methods

showsPrec :: Int -> UpdateKeyDescription -> ShowS

show :: UpdateKeyDescription -> String

showList :: [UpdateKeyDescription] -> ShowS

Generic UpdateKeyDescription

Associated Types

type Rep UpdateKeyDescription :: * -> *

Methods

from :: UpdateKeyDescription -> Rep UpdateKeyDescription x

to :: Rep UpdateKeyDescription x -> UpdateKeyDescription

Hashable UpdateKeyDescription

Methods

hashWithSalt :: Int -> UpdateKeyDescription -> Int

hash :: UpdateKeyDescription -> Int

ToJSON UpdateKeyDescription

Methods

toJSON :: UpdateKeyDescription -> Value

toEncoding :: UpdateKeyDescription -> Encoding

toJSONList :: [UpdateKeyDescription] -> Value

toEncodingList :: [UpdateKeyDescription] -> Encoding

NFData UpdateKeyDescription

Methods

rnf :: UpdateKeyDescription -> ()

AWSRequest UpdateKeyDescription

Associated Types

type Rs UpdateKeyDescription :: *

Methods

request :: UpdateKeyDescription -> Request UpdateKeyDescription

response :: MonadResource m => Logger -> Service -> Proxy * UpdateKeyDescription -> ClientResponse -> m (Response UpdateKeyDescription)

ToQuery UpdateKeyDescription

Methods

toQuery :: UpdateKeyDescription -> QueryString

ToPath UpdateKeyDescription

Methods

toPath :: UpdateKeyDescription -> ByteString

ToHeaders UpdateKeyDescription

Methods

toHeaders :: UpdateKeyDescription -> [Header]

type Rep UpdateKeyDescription

type Rep UpdateKeyDescription = D1 (MetaData "UpdateKeyDescription" "Network.AWS.KMS.UpdateKeyDescription" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" False) (C1 (MetaCons "UpdateKeyDescription'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ukdKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ukdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateKeyDescription

type Rs UpdateKeyDescription = UpdateKeyDescriptionResponse

Request Lenses

ukdKeyId :: Lens' UpdateKeyDescription Text

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. 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 CMK, use ListKeys or DescribeKey .

ukdDescription :: Lens' UpdateKeyDescription Text

New description for the CMK.

Destructuring the Response

updateKeyDescriptionResponse :: UpdateKeyDescriptionResponse

Creates a value of UpdateKeyDescriptionResponse with the minimum fields required to make a request.

data UpdateKeyDescriptionResponse

See: updateKeyDescriptionResponse smart constructor.

Instances

Eq UpdateKeyDescriptionResponse

Methods

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

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

Data UpdateKeyDescriptionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateKeyDescriptionResponse -> c UpdateKeyDescriptionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateKeyDescriptionResponse

toConstr :: UpdateKeyDescriptionResponse -> Constr

dataTypeOf :: UpdateKeyDescriptionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateKeyDescriptionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateKeyDescriptionResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateKeyDescriptionResponse -> UpdateKeyDescriptionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateKeyDescriptionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateKeyDescriptionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateKeyDescriptionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateKeyDescriptionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateKeyDescriptionResponse -> m UpdateKeyDescriptionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateKeyDescriptionResponse -> m UpdateKeyDescriptionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateKeyDescriptionResponse -> m UpdateKeyDescriptionResponse

Read UpdateKeyDescriptionResponse

Methods

readsPrec :: Int -> ReadS UpdateKeyDescriptionResponse

readList :: ReadS [UpdateKeyDescriptionResponse]

readPrec :: ReadPrec UpdateKeyDescriptionResponse

readListPrec :: ReadPrec [UpdateKeyDescriptionResponse]

Show UpdateKeyDescriptionResponse

Methods

showsPrec :: Int -> UpdateKeyDescriptionResponse -> ShowS

show :: UpdateKeyDescriptionResponse -> String

showList :: [UpdateKeyDescriptionResponse] -> ShowS

Generic UpdateKeyDescriptionResponse

Associated Types

type Rep UpdateKeyDescriptionResponse :: * -> *

Methods

from :: UpdateKeyDescriptionResponse -> Rep UpdateKeyDescriptionResponse x

to :: Rep UpdateKeyDescriptionResponse x -> UpdateKeyDescriptionResponse

NFData UpdateKeyDescriptionResponse

Methods

rnf :: UpdateKeyDescriptionResponse -> ()

type Rep UpdateKeyDescriptionResponse

type Rep UpdateKeyDescriptionResponse = D1 (MetaData "UpdateKeyDescriptionResponse" "Network.AWS.KMS.UpdateKeyDescription" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" False) (C1 (MetaCons "UpdateKeyDescriptionResponse'" PrefixI False) U1)