AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CancelKeyDeletion operation.
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
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public class CancelKeyDeletionRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The CancelKeyDeletionRequest type exposes the following members
Name | Description | |
---|---|---|
CancelKeyDeletionRequest() |
Name | Type | Description | |
---|---|---|---|
KeyId | System.String |
Gets and sets the property KeyId. Identifies the KMS key whose deletion is being canceled. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
The following example cancels deletion of the specified KMS key.
var client = new AmazonKeyManagementServiceClient(); var response = client.CancelKeyDeletion(new CancelKeyDeletionRequest { KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. }); string keyId = response.KeyId; // The ARN of the KMS key whose deletion you canceled.
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5