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

********************
list_plan_executions
********************



.. py:method:: ARCRegionswitch.Client.list_plan_executions(**kwargs)

  

  Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

  

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


  **Request Syntax**
  ::

    response = client.list_plan_executions(
        planArn='string',
        maxResults=123,
        nextToken='string',
        state='inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth'
    )
    
  :type planArn: string
  :param planArn: **[REQUIRED]** 

    The ARN for the plan.

    

  
  :type maxResults: integer
  :param maxResults: 

    The number of objects that you want to return with this call.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  :type state: string
  :param state: 

    The state of the plan execution. For example, the plan execution might be In Progress.

    

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

    
    ::

      {
          'items': [
              {
                  'planArn': 'string',
                  'executionId': 'string',
                  'version': 'string',
                  'updatedAt': datetime(2015, 1, 1),
                  'comment': 'string',
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1),
                  'mode': 'graceful'|'ungraceful',
                  'executionState': 'inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth',
                  'executionAction': 'activate'|'deactivate',
                  'executionRegion': 'string',
                  'actualRecoveryTime': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        The items in the plan execution to return.

        
        

        - *(dict) --* 

          A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

          
          

          - **planArn** *(string) --* 

            The Amazon Resource Name (ARN) of the plan.

            
          

          - **executionId** *(string) --* 

            The execution identifier of a plan execution.

            
          

          - **version** *(string) --* 

            The version for the plan.

            
          

          - **updatedAt** *(datetime) --* 

            The timestamp when the plan execution was last updated.

            
          

          - **comment** *(string) --* 

            An optional comment about the plan execution.

            
          

          - **startTime** *(datetime) --* 

            The timestamp when the plan execution was started.

            
          

          - **endTime** *(datetime) --* 

            The timestamp when the plan execution was ended.

            
          

          - **mode** *(string) --* 

            The plan execution mode. Valid values are ``graceful``, for graceful executions, or ``ungraceful``, for ungraceful executions.

            
          

          - **executionState** *(string) --* 

            The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

            
          

          - **executionAction** *(string) --* 

            The plan execution action. Valid values are ``activate``, to activate an Amazon Web Services Region, or ``deactivate``, to deactivate a Region.

            
          

          - **executionRegion** *(string) --* 

            The Amazon Web Services Region for a plan execution.

            
          

          - **actualRecoveryTime** *(string) --* 

            The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

            
      
    
      

      - **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.

        
  
  **Exceptions**
  
  *   :py:class:`ARCRegionswitch.Client.exceptions.ResourceNotFoundException`

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

  