Skip to content

GetPlanExecutionResponse

Source code in docs_src/capo_arc_region_switch/types/get_plan_execution_response.py
class GetPlanExecutionResponse(TypedDict, closed=True):
    plan_arn: "capo_arc_region_switch.types.plan_arn.PlanArn"
    """<p>The Amazon Resource Name (ARN) of the plan.</p>"""
    execution_id: "capo_arc_region_switch.types.execution_id.ExecutionId"
    """<p>The execution identifier of a plan execution.</p>"""
    version: NotRequired["str"]
    """<p>The version for the plan.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the plan execution was last updated.</p>"""
    comment: NotRequired["str"]
    """<p>A comment included on the plan execution.</p>"""
    start_time: "datetime.datetime"
    """<p>The time (UTC) when the plan execution started.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The time (UTC) when the plan execution ended.</p>"""
    mode: "capo_arc_region_switch.types.execution_mode.ExecutionMode"
    """<p>The plan execution mode. Valid values are <code>graceful</code>, for graceful executions, or <code>ungraceful</code>, for ungraceful executions.</p>"""
    execution_state: "capo_arc_region_switch.types.execution_state.ExecutionState"
    """<p>The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.</p>"""
    execution_action: "capo_arc_region_switch.types.execution_action.ExecutionAction"
    """<p>The plan execution action. Valid values are <code>activate</code>, to activate an Amazon Web Services Region, or <code>deactivate</code>, to deactivate a Region.</p>"""
    execution_region: "str"
    """<p>The Amazon Web Services Region for a plan execution.</p>"""
    recovery_execution_id: NotRequired["str"]
    """<p>The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.</p>"""
    step_states: NotRequired["capo_arc_region_switch.types.step_states.StepStates"]
    """<p>The states of the steps in the plan execution.</p>"""
    plan: NotRequired["capo_arc_region_switch.types.plan.Plan"]
    """<p>The details of the Region switch plan.</p>"""
    actual_recovery_time: NotRequired["capo_arc_region_switch.types.duration.Duration"]
    """<p>The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.</p>"""
    generated_report_details: NotRequired[
        "capo_arc_region_switch.types.generated_report_details.GeneratedReportDetails"
    ]
    """<p>Information about the location of a generated report, or the cause of its failure.</p>"""
    next_token: NotRequired["str"]
    """<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>"""

actual_recovery_time instance-attribute

actual_recovery_time: NotRequired[Duration]

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

comment instance-attribute

comment: NotRequired[str]

A comment included on the plan execution.

end_time instance-attribute

end_time: NotRequired[datetime]

The time (UTC) when the plan execution ended.

execution_action instance-attribute

execution_action: ExecutionAction

The plan execution action. Valid values are activate, to activate an Amazon Web Services Region, or deactivate, to deactivate a Region.

execution_id instance-attribute

execution_id: ExecutionId

The execution identifier of a plan execution.

execution_region instance-attribute

execution_region: str

The Amazon Web Services Region for a plan execution.

execution_state instance-attribute

execution_state: ExecutionState

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

generated_report_details instance-attribute

generated_report_details: NotRequired[GeneratedReportDetails]

Information about the location of a generated report, or the cause of its failure.

mode instance-attribute

The plan execution mode. Valid values are graceful, for graceful executions, or ungraceful, for ungraceful executions.

next_token instance-attribute

next_token: NotRequired[str]

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

plan instance-attribute

plan: NotRequired[Plan]

The details of the Region switch plan.

plan_arn instance-attribute

plan_arn: PlanArn

The Amazon Resource Name (ARN) of the plan.

recovery_execution_id instance-attribute

recovery_execution_id: NotRequired[str]

The unique identifier of the most recent recovery execution. Required when starting a post-recovery execution.

start_time instance-attribute

start_time: datetime

The time (UTC) when the plan execution started.

step_states instance-attribute

step_states: NotRequired[StepStates]

The states of the steps in the plan execution.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The timestamp when the plan execution was last updated.

version instance-attribute

version: NotRequired[str]

The version for the plan.