Skip to content

GetKeyRotationStatusResponse

Source code in docs_src/capo_kms/types/get_key_rotation_status_response.py
class GetKeyRotationStatusResponse(TypedDict, closed=True):
    key_rotation_enabled: "capo_kms.types.boolean_type.BooleanType"
    """<p>A Boolean value that specifies whether key rotation is enabled.</p>"""
    key_id: NotRequired["capo_kms.types.key_id_type.KeyIdType"]
    """<p>Identifies the specified symmetric encryption KMS key.</p>"""
    rotation_period_in_days: NotRequired[
        "capo_kms.types.rotation_period_in_days_type.RotationPeriodInDaysType"
    ]
    """<p>The number of days between each automatic rotation. The default value is 365 days.</p>"""
    next_rotation_date: NotRequired["capo_kms.types.date_type.DateType"]
    """<p>The next date that KMS will automatically rotate the key material.</p>"""
    on_demand_rotation_start_date: NotRequired["capo_kms.types.date_type.DateType"]
    """<p>Identifies the date and time that an in progress on-demand rotation was initiated.</p> <p>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 <a>ListKeyRotations</a> to view the details of the completed on-demand rotation.</p>"""

key_id instance-attribute

key_id: NotRequired[KeyIdType]

Identifies the specified symmetric encryption KMS key.

key_rotation_enabled instance-attribute

key_rotation_enabled: BooleanType

A Boolean value that specifies whether key rotation is enabled.

next_rotation_date instance-attribute

next_rotation_date: NotRequired[DateType]

The next date that KMS will automatically rotate the key material.

on_demand_rotation_start_date instance-attribute

on_demand_rotation_start_date: NotRequired[DateType]

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.

rotation_period_in_days instance-attribute

rotation_period_in_days: NotRequired[RotationPeriodInDaysType]

The number of days between each automatic rotation. The default value is 365 days.