DisableKeyRotation
Disables automatic rotation of the key material for a KMS key.
Description
The `DisableKeyRotation` operation disables automatic rotation of the key material for a symmetric customer managed KMS key. You cannot perform this operation on asymmetric KMS keys, KMS keys in custom key stores, or AWS managed keys.
note
- By default, automatic key rotation is disabled for customer managed KMS keys.
- When you disable key rotation, QKMS stops rotating the key material automatically.
- The KMS key that you use for this operation must be in a compatible key state.
- You cannot disable automatic rotation for AWS managed keys.
Request Syntax
Headers
| Name | Description | Required | Type |
|---|---|---|---|
| Content-Type | Must be "application/x-amz-json-1.1" | Yes | string |
| X-Amz-Target | Must be "TrentService.DisableKeyRotation" | Yes | string |
Request Body
| Name | Description | Required | Type |
|---|---|---|---|
| KeyId | The identifier of the KMS key whose key material will stop rotating automatically. This can be the key ID or key ARN of the KMS key. | Yes | string |
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: TrentService.DisableKeyRotation
{
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
}
Values in italics indicate user input and should be replaced with actual values.
Examples
Example 1: Disable automatic key rotation for a KMS key
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: TrentService.DisableKeyRotation
{
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
}
Values in italics indicate user input and should be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: application/x-amz-json-1.1
Values in italics indicate variable response values.
Response Elements
This operation returns no response data.
Special Errors
| Error Code | Description |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. |
| DisabledException | The request was rejected because the specified KMS key is disabled. |
| InvalidArnException | The key ARN provided is not valid. |
| KMSInternalException | An internal error occurred. |
| KMSInvalidStateException | The request was rejected because the key state is not valid for this operation. |
| NotFoundException | The request was rejected because the specified key was not found. |
| UnsupportedOperationException | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
Permissions
To use the `DisableKeyRotation` operation, you must have the following permissions:
- `kms:DisableKeyRotation` on the KMS key (specified in the policy)
Try It Out
Test DisableKeyRotation
Disable automatic key rotation for a KMS key.
Coming Soon
This feature is currently under development and will be available soon.