DescribeKey#

Description#

Provides information about a KMS key.

Request Parameters#

  • KeyId — The ID of the KMS key. You can specify an alias name with the alias/ prefix as the identifier.

    • Type: String

    • Required: Yes

Response Elements#

  • KeyMetadata — The KMS key metadata.

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

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

Sample Response#

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

{
    "KeyMetadata": {
        "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
        "CreationDate": 1774428072.694000,
        "Enabled": true,
        "Description": "",
        "KeyState": "Enabled",
        "KeySpec": "SYMMETRIC_DEFAULT"
    }
}