amazonka-kms-1.4.5: Amazon Key Management Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KMS.CancelKeyDeletion

Contents

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 .

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

Synopsis

Creating a Request

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. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey .

data CancelKeyDeletion #

See: cancelKeyDeletion smart constructor.

Instances

Eq CancelKeyDeletion # 
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 # 
Show CancelKeyDeletion # 
Generic CancelKeyDeletion # 
Hashable CancelKeyDeletion # 
ToJSON CancelKeyDeletion # 
NFData CancelKeyDeletion # 

Methods

rnf :: CancelKeyDeletion -> () #

AWSRequest CancelKeyDeletion # 
ToQuery CancelKeyDeletion # 
ToPath CancelKeyDeletion # 
ToHeaders CancelKeyDeletion # 
type Rep CancelKeyDeletion # 
type Rep CancelKeyDeletion = D1 (MetaData "CancelKeyDeletion" "Network.AWS.KMS.CancelKeyDeletion" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" True) (C1 (MetaCons "CancelKeyDeletion'" PrefixI True) (S1 (MetaSel (Just Symbol "_ckdKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs CancelKeyDeletion # 

Request Lenses

ckdKeyId :: Lens' CancelKeyDeletion Text #

The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey .

Destructuring the Response

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:

data CancelKeyDeletionResponse #

See: cancelKeyDeletionResponse smart constructor.

Instances

Eq CancelKeyDeletionResponse # 
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 # 
Show CancelKeyDeletionResponse # 
Generic CancelKeyDeletionResponse # 
NFData CancelKeyDeletionResponse # 
type Rep CancelKeyDeletionResponse # 
type Rep CancelKeyDeletionResponse = D1 (MetaData "CancelKeyDeletionResponse" "Network.AWS.KMS.CancelKeyDeletion" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "CancelKeyDeletionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ckdrsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ckdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.