Skip to content

Framework

Source code in docs_src/capo_backup/types/framework.py
class Framework(TypedDict, closed=True):
    framework_name: NotRequired["capo_backup.types.framework_name.FrameworkName"]
    """<p>The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>"""
    framework_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"""
    framework_description: NotRequired[
        "capo_backup.types.framework_description.FrameworkDescription"
    ]
    """<p>An optional description of the framework with a maximum 1,024 characters.</p>"""
    number_of_controls: "capo_backup.types.integer.integer"
    """<p>The number of controls contained by the framework.</p>"""
    creation_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>"""
    deployment_status: NotRequired["capo_backup.types.string.string"]
    """<p>The deployment status of a framework. The statuses are:</p> <p> <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code> </p>"""

creation_time instance-attribute

creation_time: NotRequired[timestamp]

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

deployment_status instance-attribute

deployment_status: NotRequired[string]

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

framework_arn instance-attribute

framework_arn: NotRequired[ARN]

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

framework_description instance-attribute

framework_description: NotRequired[FrameworkDescription]

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

framework_name instance-attribute

framework_name: NotRequired[FrameworkName]

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

number_of_controls instance-attribute

number_of_controls: integer

The number of controls contained by the framework.