ARCRegionswitch / Waiter / PlanExecutionCompleted

PlanExecutionCompleted

class ARCRegionswitch.Waiter.PlanExecutionCompleted
waiter = client.get_waiter('plan_execution_completed')
wait(**kwargs)

Polls ARCRegionswitch.Client.get_plan_execution() every 30 seconds until a successful state is reached. An error is raised after 5 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    planArn='string',
    executionId='string',
    maxResults=123,
    nextToken='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • planArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the plan with the execution to retrieve.

  • executionId (string) –

    [REQUIRED]

    The execution identifier of a plan execution.

  • maxResults (integer) – The number of objects that you want to return with this call.

  • nextToken (string) – 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.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 5

Returns:

None