GetKeyRotationStatus#

Description#

Provides information about the rotation status of a KMS key.

Request Parameters#

  • KeyId — The ID of the KMS key.

    • Type: String

    • Required: Yes

Response Elements#

  • KeyRotationEnabled — Indicates whether rotation of the KMS key is enabled.

    • Type: Boolean

  • NextRotationDate — The date and time of the next automatic rotation of the KMS key.

    • Type: Timestamp

  • RotationPeriodInDays — The automatic rotation period of the KMS key in days.

    • Type: Integer

    • Range: From 90 to 2560

Examples#

Sample Request#

POST / HTTP/1.1
Host: kms.<region>.<domain>
Content-Length: <PayloadSizeBytes>
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: TrentService.GetKeyRotationStatus

{
    "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
}

Sample Response#

HTTP/1.1 200 OK
Content-Type: application/x-amz-json-1.1

{
    "KeyRotationEnabled": true,
    "NextRotationDate": 1805964072.694000,
    "RotationPeriodInDays": 365
}