AbbreviatedExecution - Amazon Application Recovery Controller

AbbreviatedExecution

A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

Contents

executionAction

The plan execution action. Valid values are Activate, to activate an AWS Region, or Deactivate, to deactivate a Region.

Type: String

Valid Values: activate | deactivate

Required: Yes

executionId

The execution identifier of a plan execution.

Type: String

Required: Yes

executionRegion

The AWS Region for a plan execution.

Type: String

Required: Yes

executionState

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

Type: String

Valid Values: inProgress | pausedByFailedStep | pausedByOperator | completed | completedWithExceptions | canceled | planExecutionTimedOut | pendingManualApproval | failed | pending | completedMonitoringApplicationHealth

Required: Yes

mode

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

Type: String

Valid Values: graceful | ungraceful

Required: Yes

planArn

The Amazon Resource Name (ARN) of the plan.

Type: String

Pattern: arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})

Required: Yes

startTime

The timestamp when the plan execution was started.

Type: Timestamp

Required: Yes

actualRecoveryTime

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.

Type: String

Pattern: P(?!$)(\d+Y)?(\d+M)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?

Required: No

comment

An optional comment about the plan execution.

Type: String

Required: No

endTime

The timestamp when the plan execution was ended.

Type: Timestamp

Required: No

updatedAt

The timestamp when the plan execution was last updated.

Type: Timestamp

Required: No

version

The version for the plan.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: