:doc:`ARCRegionswitch <../../arc-region-switch>` / Client / cancel_plan_execution

*********************
cancel_plan_execution
*********************



.. py:method:: 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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/arc-region-switch-2022-07-26/CancelPlanExecution>`_  


  **Request Syntax**
  ::

    response = client.cancel_plan_execution(
        planArn='string',
        executionId='string',
        comment='string'
    )
    
  :type planArn: string
  :param planArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the plan.

    

  
  :type executionId: string
  :param executionId: **[REQUIRED]** 

    The execution identifier of a plan execution.

    

  
  :type comment: string
  :param comment: 

    A comment that you can enter about canceling a plan execution step.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`ARCRegionswitch.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ARCRegionswitch.Client.exceptions.AccessDeniedException`

  