Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.KMS.UpdateKeyDescription

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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.

Synopsis

updateKeyDescription :: Text -> Text -> UpdateKeyDescription
data UpdateKeyDescription
ukdKeyId :: Lens' UpdateKeyDescription Text
ukdDescription :: Lens' UpdateKeyDescription Text
updateKeyDescriptionResponse :: UpdateKeyDescriptionResponse
data UpdateKeyDescriptionResponse

Creating a Request

updateKeyDescription Source #

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 Source #

See: updateKeyDescription smart constructor.

Instances

Eq UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods (==) :: UpdateKeyDescription -> UpdateKeyDescription -> Bool # (/=) :: UpdateKeyDescription -> UpdateKeyDescription -> Bool #
Data UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.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 Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods readsPrec :: Int -> ReadS UpdateKeyDescription # readList :: ReadS [UpdateKeyDescription] # readPrec :: ReadPrec UpdateKeyDescription # readListPrec :: ReadPrec [UpdateKeyDescription] #
Show UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods showsPrec :: Int -> UpdateKeyDescription -> ShowS # show :: UpdateKeyDescription -> String # showList :: [UpdateKeyDescription] -> ShowS #
Generic UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Associated Types type Rep UpdateKeyDescription :: Type -> Type # Methods from :: UpdateKeyDescription -> Rep UpdateKeyDescription x # to :: Rep UpdateKeyDescription x -> UpdateKeyDescription #
Hashable UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods hashWithSalt :: Int -> UpdateKeyDescription -> Int # hash :: UpdateKeyDescription -> Int #
ToJSON UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods toJSON :: UpdateKeyDescription -> Value # toEncoding :: UpdateKeyDescription -> Encoding # toJSONList :: [UpdateKeyDescription] -> Value # toEncodingList :: [UpdateKeyDescription] -> Encoding #
AWSRequest UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Associated Types type Rs UpdateKeyDescription :: Type # Methods request :: UpdateKeyDescription -> Request UpdateKeyDescription # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateKeyDescription -> ClientResponse -> m (Response UpdateKeyDescription) #
ToHeaders UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods toHeaders :: UpdateKeyDescription -> [Header] #
ToPath UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods toPath :: UpdateKeyDescription -> ByteString #
ToQuery UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods toQuery :: UpdateKeyDescription -> QueryString #
NFData UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods rnf :: UpdateKeyDescription -> () #
type Rep UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription type Rep UpdateKeyDescription = D1 (MetaData "UpdateKeyDescription" "Network.AWS.KMS.UpdateKeyDescription" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "UpdateKeyDescription'" PrefixI True) (S1 (MetaSel (Just "_ukdKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ukdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs UpdateKeyDescription Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription type Rs UpdateKeyDescription = UpdateKeyDescriptionResponse

Request Lenses

ukdKeyId :: Lens' UpdateKeyDescription Text Source #

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 Source #

New description for the CMK.

Destructuring the Response

updateKeyDescriptionResponse :: UpdateKeyDescriptionResponse Source #

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

data UpdateKeyDescriptionResponse Source #

See: updateKeyDescriptionResponse smart constructor.

Instances

Eq UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods (==) :: UpdateKeyDescriptionResponse -> UpdateKeyDescriptionResponse -> Bool # (/=) :: UpdateKeyDescriptionResponse -> UpdateKeyDescriptionResponse -> Bool #
Data UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription 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 Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods readsPrec :: Int -> ReadS UpdateKeyDescriptionResponse # readList :: ReadS [UpdateKeyDescriptionResponse] # readPrec :: ReadPrec UpdateKeyDescriptionResponse # readListPrec :: ReadPrec [UpdateKeyDescriptionResponse] #
Show UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods showsPrec :: Int -> UpdateKeyDescriptionResponse -> ShowS # show :: UpdateKeyDescriptionResponse -> String # showList :: [UpdateKeyDescriptionResponse] -> ShowS #
Generic UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Associated Types type Rep UpdateKeyDescriptionResponse :: Type -> Type # Methods from :: UpdateKeyDescriptionResponse -> Rep UpdateKeyDescriptionResponse x # to :: Rep UpdateKeyDescriptionResponse x -> UpdateKeyDescriptionResponse #
NFData UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription Methods rnf :: UpdateKeyDescriptionResponse -> () #
type Rep UpdateKeyDescriptionResponse Source #
Instance details Defined in Network.AWS.KMS.UpdateKeyDescription type Rep UpdateKeyDescriptionResponse = D1 (MetaData "UpdateKeyDescriptionResponse" "Network.AWS.KMS.UpdateKeyDescription" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "UpdateKeyDescriptionResponse'" PrefixI False) (U1 :: Type -> Type))