describe_key¶
Operation¶
describe_key
async
¶
describe_key(request: DescribeKeyInput | DescribeKeyInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeKeyOutput
describe_key(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeKeyInputDict]) -> DescribeKeyOutput
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 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:
-
GetKeyPolicy
-
GetKeyRotationStatus
-
ListAliases
-
ListGrants
-
ListKeys
-
ListResourceTags
-
ListRetirableGrants
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeKeyOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeKeyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeKeyInput structure.
Attributes¶
grant_tokens
class-attribute
instance-attribute
¶
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.
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
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.
Dictionaries¶
DescribeKeyInputDict
¶
Bases: TypedDict
Dictionary form of DescribeKeyInput.
Attributes¶
grant_tokens
instance-attribute
¶
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.
key_id
instance-attribute
¶
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.
Output¶
DescribeKeyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeKeyOutput structure.
Attributes¶
key_metadata
class-attribute
instance-attribute
¶
key_metadata: KeyMetadata | None = ...
Metadata associated with the key.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.