ARC - Region switch

{'clientToken': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.start_plan_execution(
    planArn='string',
    targetRegion='string',
    action='activate'|'deactivate'|'postRecovery',
    mode='graceful'|'ungraceful',
    comment='string',
    latestVersion='string',
    recoveryExecutionId='string',
    clientToken='string'
)

type planArn:

string

param planArn:

[REQUIRED]

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

type targetRegion:

string

param targetRegion:

[REQUIRED]

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

type action:

string

param action:

[REQUIRED]

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 mode:

string

param 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 comment:

string

param comment:

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

type latestVersion:

string

param 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 recoveryExecutionId:

string

param 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 clientToken:

string

param 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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'executionId': 'string',
    'plan': 'string',
    'planVersion': 'string',
    'activateRegion': 'string',
    'deactivateRegion': 'string'
}

Response Structure

• (dict) --

  • executionId (string) --

    The execution identifier of a plan execution.

  • plan (string) --

    The details of the Region switch plan.

  • planVersion (string) --

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

  • activateRegion (string) --

    The Amazon Web Services Region to activate.

  • deactivateRegion (string) --

    The Amazon Web Services Region to deactivate.