rotate_key_on_demand¶
Operation¶
rotate_key_on_demand
¶
rotate_key_on_demand(request: RotateKeyOnDemandInput | RotateKeyOnDemandInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RotateKeyOnDemandInputDict]) -> RotateKeyOnDemandOutput
Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.
You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.
Note
You can perform on-demand key rotation a maximum of 25 times per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.
You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
On-demand key rotation is supported only on symmetric encryption KMS
keys. You cannot perform on-demand rotation of asymmetric KMS
keys,
HMAC KMS
keys,
or KMS keys in a custom key
store.
When you initiate on-demand key rotation on a symmetric encryption KMS
key with imported key material, you must have already imported new key
material
and that key material's state should be PENDING_ROTATION. Use the
ListKeyRotations operation to check the state of all key materials
associated with a KMS key. To perform on-demand rotation of a set of
related multi-Region
keys,
import new key material in the primary Region key, import the same key
material in each replica Region key, and invoke the on-demand rotation
on the primary Region key.
You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
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.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:RotateKeyOnDemand (key policy)
Related operations:
-
EnableKeyRotation
-
DisableKeyRotation
-
GetKeyRotationStatus
-
ImportKeyMaterial
-
ListKeyRotations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RotateKeyOnDemandInput | RotateKeyOnDemandInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[RotateKeyOnDemandInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RotateKeyOnDemandOutput
|
An instance of |
rotate_key_on_demand
async
¶
rotate_key_on_demand(request: RotateKeyOnDemandInput | RotateKeyOnDemandInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RotateKeyOnDemandInputDict]) -> RotateKeyOnDemandOutput
Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.
You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.
Note
You can perform on-demand key rotation a maximum of 25 times per KMS key. You can use the KMS console to view the number of remaining on-demand rotations available for a KMS key.
You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to identify the date that completed on-demand rotations were performed. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.
On-demand key rotation is supported only on symmetric encryption KMS
keys. You cannot perform on-demand rotation of asymmetric KMS
keys,
HMAC KMS
keys,
or KMS keys in a custom key
store.
When you initiate on-demand key rotation on a symmetric encryption KMS
key with imported key material, you must have already imported new key
material
and that key material's state should be PENDING_ROTATION. Use the
ListKeyRotations operation to check the state of all key materials
associated with a KMS key. To perform on-demand rotation of a set of
related multi-Region
keys,
import new key material in the primary Region key, import the same key
material in each replica Region key, and invoke the on-demand rotation
on the primary Region key.
You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys is managed by the Amazon Web Services service that owns the key.
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.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:RotateKeyOnDemand (key policy)
Related operations:
-
EnableKeyRotation
-
DisableKeyRotation
-
GetKeyRotationStatus
-
ImportKeyMaterial
-
ListKeyRotations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RotateKeyOnDemandInput | RotateKeyOnDemandInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[RotateKeyOnDemandInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RotateKeyOnDemandOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
RotateKeyOnDemandInputDict
¶
Bases: TypedDict
Dictionary form of RotateKeyOnDemandInput.
Attributes¶
key_id
instance-attribute
¶
Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, multi-Region KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
Specify the key ID or key ARN of the KMS key.
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.
RotateKeyOnDemandInput
dataclass
¶
Bases: _SerdeShape
Dataclass for RotateKeyOnDemandInput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Identifies a symmetric encryption KMS key. You cannot perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, multi-Region KMS keys with imported key material, or KMS keys in a custom key store. To perform on-demand rotation of a set of related multi-Region keys, invoke the on-demand rotation on the primary key.
Specify the key ID or key ARN of the KMS key.
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¶
RotateKeyOnDemandOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for RotateKeyOnDemandOutput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Identifies the symmetric encryption KMS key that you initiated on-demand rotation on.
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.