This is the response object from the ScheduleKeyDeletion operation.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceResponse
Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ScheduleKeyDeletionResponse : AmazonWebServiceResponse
The ScheduleKeyDeletionResponse type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ScheduleKeyDeletionResponse() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
DeletionDate | System.DateTime |
Gets and sets the property DeletionDate. The date and time after which KMS deletes the KMS key. If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted. |
|
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
KeyId | System.String |
Gets and sets the property KeyId. The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled. |
|
|
KeyState | Amazon.KeyManagementService.KeyState |
Gets and sets the property KeyState. The current status of the KMS key. For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide. |
|
|
PendingWindowInDays | System.Int32 |
Gets and sets the property PendingWindowInDays. The waiting period before the KMS key is deleted. If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately. |
|
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
Examples
The following example schedules the specified KMS key for deletion.
To schedule a KMS key for deletion
var client = new AmazonKeyManagementServiceClient();
var response = client.ScheduleKeyDeletion(new ScheduleKeyDeletionRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
PendingWindowInDays = 7 // The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
});
DateTime deletionDate = response.DeletionDate; // The date and time after which KMS deletes the KMS key.
string keyId = response.KeyId; // The ARN of the KMS key that is scheduled for deletion.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5