AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Provides detailed information about a KMS key. You can run DescribeKey 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, DescribeKey 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.
DescribeKey does not return the following information:
Aliases associated with the KMS key. To get this information, use ListAliases.
Whether automatic key rotation is enabled on the KMS key. To get this information, use GetKeyRotationStatus. 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 ListResourceTags.
Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants.
In general, DescribeKey is a non-mutating operation. It returns data about
KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey
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:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeKeyAsync.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual DescribeKeyResponse DescribeKey( String keyId )
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 ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
| Exception | Condition |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. You can retry the request. |
| InvalidArnException | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
| NotFoundException | The request was rejected because the specified entity or resource could not be found. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5