Skip to content

CreateLegalHoldInput

Source code in docs_src/capo_backup/types/create_legal_hold_input.py
class CreateLegalHoldInput(TypedDict, closed=True):
    title: "capo_backup.types.string.string"
    """<p>The title of the legal hold.</p>"""
    description: "capo_backup.types.string.string"
    """<p>The description of the legal hold.</p>"""
    idempotency_token: NotRequired["capo_backup.types.string.string"]
    """<p>This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.</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>"""
    tags: NotRequired["capo_backup.types.tags.Tags"]
    """<p>Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /. </p>"""
description: string

The description of the legal hold.

idempotency_token: NotRequired[string]

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

recovery_point_selection: NotRequired[RecoveryPointSelection]

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

tags: NotRequired[Tags]

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

title: string

The title of the legal hold.