Describe Key

kms_describe_key

R Documentation

Provides detailed information about a KMS key¶

Description¶

Provides detailed information about a KMS key. You can run describe_key on a customer managed key or an Amazon Web Services managed key.

This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. It includes fields, like KeySpec, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports.

For multi-Region keys, describe_key displays the primary key and all related replica keys. For KMS keys in CloudHSM key stores, it includes information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in external key stores, it includes the custom key store ID and the ID of the external key.

describe_key does not return the following information:

Aliases associated with the KMS key. To get this information, use list_aliases.
Whether automatic key rotation is enabled on the KMS key. To get this information, use get_key_rotation_status. Also, some key states prevent a KMS key from being automatically rotated. For details, see How Automatic Key Rotation Works in the Key Management Service Developer Guide.
Tags on the KMS key. To get this information, use list_resource_tags.
Key policies and grants on the KMS key. To get this information, use get_key_policy and list_grants.

In general, describe_key is a non-mutating operation. It returns data about KMS keys, but doesn't change them. However, Amazon Web Services services use describe_key to create Amazon Web Services managed keys from a predefined Amazon Web Services alias with no key ID.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:DescribeKey (key policy)

Related operations:

get_key_policy
get_key_rotation_status
list_aliases
list_grants
list_keys
list_resource_tags
list_retirable_grants

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage¶

kms_describe_key(KeyId, GrantTokens)

Arguments¶

KeyId

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

GrantTokens

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.

Value¶

A list with the following syntax:

Request syntax¶

svc$describe_key(
  KeyId = "string",
  GrantTokens = list(
    "string"
  )
)

Examples¶

## Not run: 
# The following example gets metadata for a symmetric encryption KMS key.
svc$describe_key(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

# The following example gets metadata for an asymmetric RSA KMS key used
# for signing and verification.
svc$describe_key(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

# The following example gets metadata for a multi-Region replica key. This
# multi-Region key is a symmetric encryption key. DescribeKey returns
# information about the primary key and all of its replicas.
svc$describe_key(
  KeyId = "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab"
)

# The following example gets the metadata of an HMAC KMS key.
svc$describe_key(
  KeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
)

# The following example gets the metadata of a KMS key in an AWS CloudHSM
# key store.
svc$describe_key(
  KeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
)

# The following example gets the metadata of a KMS key in an external key
# store.
svc$describe_key(
  KeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
)

## End(Not run)