ARCRegionswitch / Client / start_plan_execution

start_plan_execution

ARCRegionswitch.Client.start_plan_execution(**kwargs)

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

In PRACTICE mode, the execution simulates the steps without making actual changes to your application’s traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.

See also: AWS API Documentation

Request Syntax

response = client.start_plan_execution(
    planArn='string',
    targetRegion='string',
    action='activate'|'deactivate',
    mode='graceful'|'ungraceful',
    comment='string',
    latestVersion='string'
)
Parameters:

  • planArn (string) –

    [REQUIRED]

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

  • targetRegion (string) –

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

  • action (string) –

    [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).

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

  • comment (string) – An optional comment explaining why the plan execution is being started.

  • latestVersion (string) – A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

Return type:

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.

Exceptions

  • ARCRegionswitch.Client.exceptions.ResourceNotFoundException

  • ARCRegionswitch.Client.exceptions.IllegalStateException

  • ARCRegionswitch.Client.exceptions.AccessDeniedException

  • ARCRegionswitch.Client.exceptions.IllegalArgumentException