get_key_rotation_status¶
Operation¶
get_key_rotation_status
async
¶
get_key_rotation_status(request: GetKeyRotationStatusInput | GetKeyRotationStatusInputDict, /, *, plugins: list[Plugin] | None = None) -> GetKeyRotationStatusOutput
get_key_rotation_status(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKeyRotationStatusInputDict]) -> GetKeyRotationStatusOutput
Provides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation
(DisableKeyRotation) of the key material in customer managed KMS keys.
Key material rotation of Amazon Web Services managed KMS
keys
is not configurable. KMS always rotates the key material in Amazon Web
Services managed KMS keys every year. The key rotation status for Amazon
Web Services managed KMS keys is always true.
You can perform on-demand (RotateKeyOnDemand) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use ListKeyRotations to view the details of completed rotations.
Note
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
-
Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
-
Pending deletion: While a KMS key is pending deletion, its key rotation status is
falseand KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns totrue.
Cross-account use: Yes. To perform this operation on a KMS key in a
different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter.
Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
-
DisableKeyRotation
-
EnableKeyRotation
-
ListKeyRotations
-
RotateKeyOnDemand
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 |
|---|---|
GetKeyRotationStatusOutput
|
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¶
GetKeyRotationStatusInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetKeyRotationStatusInput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Dictionaries¶
GetKeyRotationStatusInputDict
¶
Bases: TypedDict
Dictionary form of GetKeyRotationStatusInput.
Attributes¶
key_id
instance-attribute
¶
Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Output¶
GetKeyRotationStatusOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetKeyRotationStatusOutput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Identifies the specified symmetric encryption KMS key.
key_rotation_enabled
class-attribute
instance-attribute
¶
key_rotation_enabled: bool = ...
A Boolean value that specifies whether key rotation is enabled.
next_rotation_date
class-attribute
instance-attribute
¶
next_rotation_date: datetime | None = ...
The next date that KMS will automatically rotate the key material.
on_demand_rotation_start_date
class-attribute
instance-attribute
¶
on_demand_rotation_start_date: datetime | None = ...
Identifies the date and time that an in progress on-demand rotation was initiated.
KMS uses a background process to perform rotations. As a result, there might be a slight delay between initiating on-demand key rotation and the rotation's completion. Once the on-demand rotation is complete, KMS removes this field from the response. You can use ListKeyRotations to view the details of the completed on-demand rotation.
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.