Provides detailed information about a KMS key. You can run describe_key
on a customer managed key or an Amazon Web Services managed key.
See https://www.paws-r-sdk.com/docs/kms_describe_key/ for full documentation.
kms_describe_key(KeyId, GrantTokens = NULL)
[required] Describes the specified KMS key.
If you specify a predefined Amazon Web Services alias (an Amazon Web
Services alias with no key ID), KMS associates the alias with an Amazon Web Services managed key
and returns its KeyId
and Arn
in the response.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use
list_keys
or describe_key
. To
get the alias name and alias ARN, use
list_aliases
.
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.