| Copyright | (c) 2013-2021 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 |
Amazonka.KMS.CancelKeyDeletion
Description
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 state: Effect on your KMS key 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
Synopsis
- data CancelKeyDeletion = CancelKeyDeletion' {}
- newCancelKeyDeletion :: Text -> CancelKeyDeletion
- cancelKeyDeletion_keyId :: Lens' CancelKeyDeletion Text
- data CancelKeyDeletionResponse = CancelKeyDeletionResponse' {
- keyId :: Maybe Text
- httpStatus :: Int
- newCancelKeyDeletionResponse :: Int -> CancelKeyDeletionResponse
- cancelKeyDeletionResponse_keyId :: Lens' CancelKeyDeletionResponse (Maybe Text)
- cancelKeyDeletionResponse_httpStatus :: Lens' CancelKeyDeletionResponse Int
Creating a Request
data CancelKeyDeletion Source #
See: newCancelKeyDeletion smart constructor.
Constructors
| CancelKeyDeletion' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:
$sel:keyId: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 Source #
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 Source #
See: newCancelKeyDeletionResponse smart constructor.
Constructors
| CancelKeyDeletionResponse' | |
Instances
newCancelKeyDeletionResponse Source #
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:
$sel:keyId: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) Source #
The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.
cancelKeyDeletionResponse_httpStatus :: Lens' CancelKeyDeletionResponse Int Source #
The response's http status code.