AmazonKeyManagementServiceClient.DisableKeyRotation Method (DisableKeyRotationRequest) | AWS SDK for .NET V3 (original) (raw)
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.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public virtual DisableKeyRotationResponse DisableKeyRotation( DisableKeyRotationRequest request )
Parameters
request
Type: Amazon.KeyManagementService.Model.DisableKeyRotationRequest
Container for the necessary parameters to execute the DisableKeyRotation service method.
Return Value
The response from the DisableKeyRotation service method, as returned by KeyManagementService.
Exceptions
| Exception | Condition |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. You can retry the request. |
| DisabledException | The request was rejected because the specified KMS key is not enabled. |
| InvalidArnException | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following: The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide. For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception. |
| NotFoundException | The request was rejected because the specified entity or resource could not be found. |
| UnsupportedOperationException | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
Examples
The following example disables automatic annual rotation of the key material for the specified KMS key.
To disable automatic rotation of key material
var client = new AmazonKeyManagementServiceClient(); var response = client.DisableKeyRotation(new DisableKeyRotationRequest { KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. });
Version Information
.NET Framework:
Supported in: 4.5 and newer, 3.5