Request Parameters Response Elements Errors See Also

StartPlanExecution

Starts the execution of a Region switch plan. You can execute a plan in either graceful or ungraceful mode.

Specifing ungraceful mode either changes the behavior of the execution blocks in a workflow or skips specific execution blocks.

Request Parameters

action

The action to perform. Valid values are activate (to shift traffic to the target Region) or deactivate (to shift traffic away from the target Region).

Type: String

Valid Values: activate | deactivate | postRecovery

Required: Yes

clientToken

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request and returns the result of the original successful request. If you don't provide a client token, the service automatically generates one. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]+

Required: No

comment

An optional comment explaining why the plan execution is being started.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

latestVersion

A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

Type: String

Required: No

mode

The plan execution mode. Valid values are graceful, for starting the execution in graceful mode, or ungraceful, for starting the execution in ungraceful mode.

Type: String

Valid Values: graceful | ungraceful

Required: No

planArn

The Amazon Resource Name (ARN) of the plan to execute.

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

recoveryExecutionId

The execution identifier of the recovery execution that ran in the opposite region post-recovery is ran in. Required when starting a post-recovery execution.

Type: String

Pattern: [a-z]{2}(-[a-z]+)+-[0-9]+/[0-9a-fA-F]{16}

Required: No

targetRegion

The AWS Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

activateRegion

The AWS Region to activate.

Type: String

deactivateRegion

The AWS Region to deactivate.

Type: String

executionId

The execution identifier of a plan execution.

Type: String

plan

The details of the Region switch 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})

planVersion

The version of the plan, a unique number generated by Region switch.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The client token was already used with different request parameters. A client token must map to the same parameters for every request. To retry this operation, provide a new client token.

resourceId: The identifier of the resource involved in the client token conflict.
resourceType: The type of the resource involved in the client token conflict.

HTTP Status Code: 409

IllegalArgumentException

The request processing has an invalid argument.

HTTP Status Code: 400

IllegalStateException

The operation failed because the current state of the resource doesn't allow the operation to proceed.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404