DescribeFrameworkOutput
¶
Source code in docs_src/capo_backup/types/describe_framework_output.py
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_controls
instance-attribute
¶
framework_controls: NotRequired[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.
framework_name
instance-attribute
¶
framework_name: NotRequired[FrameworkName]
The unique name of a framework.
framework_status
instance-attribute
¶
framework_status: NotRequired[string]
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
-
ACTIVEwhen recording is turned on for all resources governed by the framework. -
PARTIALLY_ACTIVEwhen recording is turned off for at least one resource governed by the framework. -
INACTIVEwhen recording is turned off for all resources governed by the framework. -
UNAVAILABLEwhen Backup is unable to validate recording status at this time.
idempotency_token
instance-attribute
¶
idempotency_token: NotRequired[string]
A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.