Amazonka.KMS.CancelKeyDeletion

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey.

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide.

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

Related operations: ScheduleKeyDeletion

Creating a Request

data CancelKeyDeletion

See: newCancelKeyDeletion smart constructor.

Constructors

CancelKeyDeletion'

Fields

• keyId :: Text

  Identifies the KMS key whose deletion is being canceled.

  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.

Instances

ToJSON CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toJSON :: CancelKeyDeletion -> Value

toEncoding :: CancelKeyDeletion -> Encoding

toJSONList :: [CancelKeyDeletion] -> Value

toEncodingList :: [CancelKeyDeletion] -> Encoding

ToHeaders CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toHeaders :: CancelKeyDeletion -> [Header]

ToPath CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toPath :: CancelKeyDeletion -> ByteString

ToQuery CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toQuery :: CancelKeyDeletion -> QueryString

AWSRequest CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type AWSResponse CancelKeyDeletion

Methods

request :: (Service -> Service) -> CancelKeyDeletion -> Request CancelKeyDeletion

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

Generic CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type Rep CancelKeyDeletion :: Type -> Type

Methods

from :: CancelKeyDeletion -> Rep CancelKeyDeletion x

to :: Rep CancelKeyDeletion x -> CancelKeyDeletion

Read CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

readsPrec :: Int -> ReadS CancelKeyDeletion

readList :: ReadS [CancelKeyDeletion]

readPrec :: ReadPrec CancelKeyDeletion

readListPrec :: ReadPrec [CancelKeyDeletion]

Show CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

showsPrec :: Int -> CancelKeyDeletion -> ShowS

show :: CancelKeyDeletion -> String

showList :: [CancelKeyDeletion] -> ShowS

NFData CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

rnf :: CancelKeyDeletion -> ()

Eq CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

(==) :: CancelKeyDeletion -> CancelKeyDeletion -> Bool

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

Hashable CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

hashWithSalt :: Int -> CancelKeyDeletion -> Int

hash :: CancelKeyDeletion -> Int

type AWSResponse CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

type AWSResponse CancelKeyDeletion = CancelKeyDeletionResponse

type Rep CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

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

newCancelKeyDeletion

Arguments

:: Text

CancelKeyDeletion

-> CancelKeyDeletion

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

CancelKeyDeletion, cancelKeyDeletion_keyId - Identifies the KMS key whose deletion is being canceled.

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.

Request Lenses

cancelKeyDeletion_keyId :: Lens' CancelKeyDeletion Text

Identifies the KMS key whose deletion is being canceled.

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.

Destructuring the Response

data CancelKeyDeletionResponse

See: newCancelKeyDeletionResponse smart constructor.

Constructors

CancelKeyDeletionResponse'

Fields

• keyId :: Maybe Text

  The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type Rep CancelKeyDeletionResponse :: Type -> Type

Methods

from :: CancelKeyDeletionResponse -> Rep CancelKeyDeletionResponse x

to :: Rep CancelKeyDeletionResponse x -> CancelKeyDeletionResponse

Read CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

readsPrec :: Int -> ReadS CancelKeyDeletionResponse

readList :: ReadS [CancelKeyDeletionResponse]

readPrec :: ReadPrec CancelKeyDeletionResponse

readListPrec :: ReadPrec [CancelKeyDeletionResponse]

Show CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

showsPrec :: Int -> CancelKeyDeletionResponse -> ShowS

show :: CancelKeyDeletionResponse -> String

showList :: [CancelKeyDeletionResponse] -> ShowS

NFData CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

rnf :: CancelKeyDeletionResponse -> ()

Eq CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

(==) :: CancelKeyDeletionResponse -> CancelKeyDeletionResponse -> Bool

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

type Rep CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

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

newCancelKeyDeletionResponse

Arguments

:: Int

$sel:httpStatus:CancelKeyDeletionResponse'

-> CancelKeyDeletionResponse

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

CancelKeyDeletion, cancelKeyDeletionResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

$sel:httpStatus:CancelKeyDeletionResponse', cancelKeyDeletionResponse_httpStatus - The response's http status code.

Response Lenses

cancelKeyDeletionResponse_keyId :: Lens' CancelKeyDeletionResponse (Maybe Text)

The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

cancelKeyDeletionResponse_httpStatus :: Lens' CancelKeyDeletionResponse Int

The response's http status code.