Skip to content

CreateFrameworkInput

Source code in docs_src/capo_backup/types/create_framework_input.py
class CreateFrameworkInput(TypedDict, closed=True):
    framework_name: "capo_backup.types.framework_name.FrameworkName"
    """<p>The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>"""
    framework_description: NotRequired[
        "capo_backup.types.framework_description.FrameworkDescription"
    ]
    """<p>An optional description of the framework with a maximum of 1,024 characters.</p>"""
    framework_controls: "capo_backup.types.framework_controls.FrameworkControls"
    """<p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>"""
    idempotency_token: NotRequired["capo_backup.types.string.string"]
    """<p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateFrameworkInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>"""
    framework_tags: NotRequired["capo_backup.types.string_map.stringMap"]
    """<p>The tags to assign to the framework.</p>"""

framework_controls instance-attribute

framework_controls: FrameworkControls

The controls that make up the framework. Each control in the list has a name, input parameters, and scope.

framework_description instance-attribute

framework_description: NotRequired[FrameworkDescription]

An optional description of the framework with a maximum of 1,024 characters.

framework_name instance-attribute

framework_name: FrameworkName

The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

framework_tags instance-attribute

framework_tags: NotRequired[stringMap]

The tags to assign to the framework.

idempotency_token instance-attribute

idempotency_token: NotRequired[string]

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.