UpdateKeyDescription#

Description#

Updates the description of a KMS key.

Request Parameters#

  • Description — The new description of the KMS key.

    • Type: String

    • Required: Yes

    • Length constraints: From 0 to 8192 characters

  • KeyId — The ID of the KMS key.

    • Type: String

    • Required: Yes

Response Elements#

Response body is absent.

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.UpdateKeyDescription

{
    "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
    "Description": "Example description that explains what this KMS key is used for."
}

Sample Response#

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