Metadata associated with the key.
AWSAccountId (string) –
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
KeyId (string) –
The globally unique identifier for the KMS key.
Arn (string) –
The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
CreationDate (datetime) –
The date and time when the KMS key was created.
Enabled (boolean) –
Specifies whether the KMS key is enabled. When KeyState
is Enabled
this value is true, otherwise it is false.
Description (string) –
The description of the KMS key.
KeyUsage (string) –
The cryptographic operations for which you can use the KMS key.
KeyState (string) –
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
DeletionDate (datetime) –
The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState
is PendingDeletion
.
When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion
and the length of its waiting period is displayed in the PendingDeletionWindowInDays
field.
ValidTo (datetime) –
The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin
is EXTERNAL
and whose ExpirationModel
is KEY_MATERIAL_EXPIRES
, otherwise this value is omitted.
Origin (string) –
The source of the key material for the KMS key. When this value is AWS_KMS
, KMS created the key material. When this value is EXTERNAL
, the key material was imported or the KMS key doesn’t have any key material. When this value is AWS_CLOUDHSM
, the key material was created in the CloudHSM cluster associated with a custom key store.
CustomKeyStoreId (string) –
A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
CloudHsmClusterId (string) –
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
ExpirationModel (string) –
Specifies whether the KMS key’s key material expires. This value is present only when Origin
is EXTERNAL
, otherwise this value is omitted.
KeyManager (string) –
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
CustomerMasterKeySpec (string) –
Instead, use the KeySpec
field.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We recommend that you use the KeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields.
KeySpec (string) –
Describes the type of key material in the KMS key.
EncryptionAlgorithms (list) –
The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage
of the KMS key is ENCRYPT_DECRYPT
.
(string) –
SigningAlgorithms (list) –
The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
This field appears only when the KeyUsage
of the KMS key is SIGN_VERIFY
.
(string) –
MultiRegion (boolean) –
Indicates whether the KMS key is a multi-Region ( True
) or regional ( False
) key. This value is True
for multi-Region primary and replica keys and False
for regional KMS keys.
For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
MultiRegionConfiguration (dict) –
Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion
field is True
.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyType
indicates whether the KMS key is aPRIMARY
orREPLICA
key.PrimaryKey
displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.ReplicaKeys
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
MultiRegionKeyType (string) –
Indicates whether the KMS key is a
PRIMARY
orREPLICA
key.PrimaryKey (dict) –
Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.
ReplicaKeys (list) –
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
PendingDeletionWindowInDays (integer) –
The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState
of the KMS key is PendingReplicaDeletion
. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate
field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn’t begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState
of the scheduled primary key changes from PendingReplicaDeletion
to PendingDeletion
and the deletion date appears in the DeletionDate
field.
MacAlgorithms (list) –
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
This value is present only when the KeyUsage
of the KMS key is GENERATE_VERIFY_MAC
.
(string) –
XksKeyConfiguration (dict) –
Information about the external key that is associated with a KMS key in an external key store.
For more information, see External key in the Key Management Service Developer Guide.
ncG1vNJzZmian6m8dHrAppizp56WxLR6wqikaK5hZLGwr9SmnKeskam2sLqOmqeiZ5yWwaa%2F02ipnp6Vp7Kvr8Roqp6qpp6wpr%2BOpKSsZ5Ohtqa602ibnquTp7ajsb6knLJmmKm6rQ%3D%3D