ARCRegionswitch / Client / cancel_plan_execution

cancel_plan_execution¶

ARCRegionswitch.Client.cancel_plan_execution(**kwargs)¶

Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.

You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.

response = client.cancel_plan_execution(
    planArn='string',
    executionId='string',
    comment='string'
)

Parameters:

planArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the plan.
executionId (string) –
[REQUIRED]

The execution identifier of a plan execution.
comment (string) – A comment that you can enter about canceling a plan execution step.

Return type:

dict

Returns:

{}