CancelPlanExecution
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.
Request Parameters
- comment
-
A comment that you can enter about canceling a plan execution step.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- executionId
-
The execution identifier of a plan execution.
Type: String
Required: Yes
- planArn
-
The Amazon Resource Name (ARN) of the 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})Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: