Skip to content

GetLegalHoldOutput

Source code in docs_src/capo_backup/types/get_legal_hold_output.py
class GetLegalHoldOutput(TypedDict, closed=True):
    title: NotRequired["capo_backup.types.string.string"]
    """<p>The title of the legal hold.</p>"""
    status: NotRequired["capo_backup.types.legal_hold_status.LegalHoldStatus"]
    """<p>The status of the legal hold.</p>"""
    description: NotRequired["capo_backup.types.string.string"]
    """<p>The description of the legal hold.</p>"""
    cancel_description: NotRequired["capo_backup.types.string.string"]
    """<p>The reason for removing the legal hold.</p>"""
    legal_hold_id: NotRequired["capo_backup.types.string.string"]
    """<p>The ID of the legal hold.</p>"""
    legal_hold_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.</p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The time when the legal hold was created.</p>"""
    cancellation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The time when the legal hold was cancelled.</p>"""
    retain_record_until: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time until which the legal hold record is retained.</p>"""
    recovery_point_selection: NotRequired[
        "capo_backup.types.recovery_point_selection.RecoveryPointSelection"
    ]
    """<p>The criteria to assign a set of resources, such as resource types or backup vaults.</p>"""
cancel_description: NotRequired[string]

The reason for removing the legal hold.

cancellation_date: NotRequired[timestamp]

The time when the legal hold was cancelled.

creation_date: NotRequired[timestamp]

The time when the legal hold was created.

description: NotRequired[string]

The description of the legal hold.

legal_hold_arn: NotRequired[ARN]

The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.

legal_hold_id: NotRequired[string]

The ID of the legal hold.

recovery_point_selection: NotRequired[RecoveryPointSelection]

The criteria to assign a set of resources, such as resource types or backup vaults.

retain_record_until: NotRequired[timestamp]

The date and time until which the legal hold record is retained.

status: NotRequired[LegalHoldStatus]

The status of the legal hold.

title: NotRequired[string]

The title of the legal hold.