# CancelPlanExecution
<a name="API_CancelPlanExecution"></a>

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
<a name="API_CancelPlanExecution_RequestParameters"></a>

 ** 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
<a name="API_CancelPlanExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CancelPlanExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/arc-region-switch-2022-07-26/CancelPlanExecution) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/arc-region-switch-2022-07-26/CancelPlanExecution)