:doc:`ARCRegionswitch <../../arc-region-switch>` / Paginator / ListPlanExecutions

******************
ListPlanExecutions
******************



.. py:class:: ARCRegionswitch.Paginator.ListPlanExecutions

  ::

    
    paginator = client.get_paginator('list_plan_executions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ARCRegionswitch.Client.list_plan_executions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          planArn='string',
          state='inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type planArn: string
    :param planArn: **[REQUIRED]** 

      The ARN for the plan.

      

    
    :type state: string
    :param state: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    