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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey . You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide .

Creating a Request

cancelKeyDeletion #

Arguments

:: Text	`ckdKeyId`
-> CancelKeyDeletion

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

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

ckdKeyId - The unique identifier for the customer master key (CMK) for which to cancel deletion. 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 .

data CancelKeyDeletion #

See: cancelKeyDeletion smart constructor.

Instances

Eq CancelKeyDeletion #
Methods (==) :: CancelKeyDeletion -> CancelKeyDeletion -> Bool # (/=) :: CancelKeyDeletion -> CancelKeyDeletion -> Bool #
Data CancelKeyDeletion #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CancelKeyDeletion -> c CancelKeyDeletion # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CancelKeyDeletion # toConstr :: CancelKeyDeletion -> Constr # dataTypeOf :: CancelKeyDeletion -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CancelKeyDeletion) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CancelKeyDeletion) # gmapT :: (forall b. Data b => b -> b) -> CancelKeyDeletion -> CancelKeyDeletion # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CancelKeyDeletion -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CancelKeyDeletion -> r # gmapQ :: (forall d. Data d => d -> u) -> CancelKeyDeletion -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CancelKeyDeletion -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CancelKeyDeletion -> m CancelKeyDeletion # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelKeyDeletion -> m CancelKeyDeletion # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelKeyDeletion -> m CancelKeyDeletion #
Read CancelKeyDeletion #
Methods readsPrec :: Int -> ReadS CancelKeyDeletion # readList :: ReadS [CancelKeyDeletion] # readPrec :: ReadPrec CancelKeyDeletion # readListPrec :: ReadPrec [CancelKeyDeletion] #
Show CancelKeyDeletion #
Methods showsPrec :: Int -> CancelKeyDeletion -> ShowS # show :: CancelKeyDeletion -> String # showList :: [CancelKeyDeletion] -> ShowS #
Generic CancelKeyDeletion #
Associated Types type Rep CancelKeyDeletion :: * -> * # Methods from :: CancelKeyDeletion -> Rep CancelKeyDeletion x # to :: Rep CancelKeyDeletion x -> CancelKeyDeletion #
Hashable CancelKeyDeletion #
Methods hashWithSalt :: Int -> CancelKeyDeletion -> Int # hash :: CancelKeyDeletion -> Int #
ToJSON CancelKeyDeletion #
Methods toJSON :: CancelKeyDeletion -> Value # toEncoding :: CancelKeyDeletion -> Encoding # toJSONList :: [CancelKeyDeletion] -> Value # toEncodingList :: [CancelKeyDeletion] -> Encoding #
NFData CancelKeyDeletion #
Methods rnf :: CancelKeyDeletion -> () #
AWSRequest CancelKeyDeletion #
Associated Types type Rs CancelKeyDeletion :: * # Methods request :: CancelKeyDeletion -> Request CancelKeyDeletion # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CancelKeyDeletion -> ClientResponse -> m (Response CancelKeyDeletion) #
ToHeaders CancelKeyDeletion #
Methods toHeaders :: CancelKeyDeletion -> [Header] #
ToPath CancelKeyDeletion #
Methods toPath :: CancelKeyDeletion -> ByteString #
ToQuery CancelKeyDeletion #
Methods toQuery :: CancelKeyDeletion -> QueryString #
type Rep CancelKeyDeletion #
type Rep CancelKeyDeletion = D1 * (MetaData "CancelKeyDeletion" "Network.AWS.KMS.CancelKeyDeletion" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" True) (C1 * (MetaCons "CancelKeyDeletion'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ckdKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs CancelKeyDeletion #
type Rs CancelKeyDeletion = CancelKeyDeletionResponse

Request Lenses

ckdKeyId :: Lens' CancelKeyDeletion Text #

The unique identifier for the customer master key (CMK) for which to cancel deletion. 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 .

Destructuring the Response

cancelKeyDeletionResponse #

Arguments

:: Int	`ckdrsResponseStatus`
-> CancelKeyDeletionResponse

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

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

ckdrsKeyId - The unique identifier of the master key for which deletion is canceled.
ckdrsResponseStatus - -- | The response status code.

data CancelKeyDeletionResponse #

See: cancelKeyDeletionResponse smart constructor.

Instances

Eq CancelKeyDeletionResponse #
Methods (==) :: CancelKeyDeletionResponse -> CancelKeyDeletionResponse -> Bool # (/=) :: CancelKeyDeletionResponse -> CancelKeyDeletionResponse -> Bool #
Data CancelKeyDeletionResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CancelKeyDeletionResponse -> c CancelKeyDeletionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CancelKeyDeletionResponse # toConstr :: CancelKeyDeletionResponse -> Constr # dataTypeOf :: CancelKeyDeletionResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CancelKeyDeletionResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CancelKeyDeletionResponse) # gmapT :: (forall b. Data b => b -> b) -> CancelKeyDeletionResponse -> CancelKeyDeletionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CancelKeyDeletionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CancelKeyDeletionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CancelKeyDeletionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CancelKeyDeletionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CancelKeyDeletionResponse -> m CancelKeyDeletionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelKeyDeletionResponse -> m CancelKeyDeletionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelKeyDeletionResponse -> m CancelKeyDeletionResponse #
Read CancelKeyDeletionResponse #
Methods readsPrec :: Int -> ReadS CancelKeyDeletionResponse # readList :: ReadS [CancelKeyDeletionResponse] # readPrec :: ReadPrec CancelKeyDeletionResponse # readListPrec :: ReadPrec [CancelKeyDeletionResponse] #
Show CancelKeyDeletionResponse #
Methods showsPrec :: Int -> CancelKeyDeletionResponse -> ShowS # show :: CancelKeyDeletionResponse -> String # showList :: [CancelKeyDeletionResponse] -> ShowS #
Generic CancelKeyDeletionResponse #
Associated Types type Rep CancelKeyDeletionResponse :: * -> * # Methods from :: CancelKeyDeletionResponse -> Rep CancelKeyDeletionResponse x # to :: Rep CancelKeyDeletionResponse x -> CancelKeyDeletionResponse #
NFData CancelKeyDeletionResponse #
Methods rnf :: CancelKeyDeletionResponse -> () #
type Rep CancelKeyDeletionResponse #
type Rep CancelKeyDeletionResponse = D1 * (MetaData "CancelKeyDeletionResponse" "Network.AWS.KMS.CancelKeyDeletion" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" False) (C1 * (MetaCons "CancelKeyDeletionResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ckdrsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ckdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ckdrsKeyId :: Lens' CancelKeyDeletionResponse (Maybe Text) #

The unique identifier of the master key for which deletion is canceled.

ckdrsResponseStatus :: Lens' CancelKeyDeletionResponse Int #

- | The response status code.