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

**************************
list_plan_execution_events
**************************



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

  

  Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

  

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


  **Request Syntax**
  ::

    response = client.list_plan_execution_events(
        planArn='string',
        executionId='string',
        maxResults=123,
        nextToken='string',
        name='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 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 name: string
  :param name: 

    The name of the plan execution event.

    

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

    
    ::

      {
          'items': [
              {
                  'timestamp': datetime(2015, 1, 1),
                  'type': 'unknown'|'executionPending'|'executionStarted'|'executionSucceeded'|'executionFailed'|'executionPausing'|'executionPaused'|'executionCanceling'|'executionCanceled'|'executionPendingApproval'|'executionBehaviorChangedToUngraceful'|'executionBehaviorChangedToGraceful'|'executionPendingChildPlanManualApproval'|'executionSuccessMonitoringApplicationHealth'|'stepStarted'|'stepUpdate'|'stepSucceeded'|'stepFailed'|'stepSkipped'|'stepPausedByError'|'stepPausedByOperator'|'stepCanceled'|'stepPendingApproval'|'stepExecutionBehaviorChangedToUngraceful'|'stepPendingApplicationHealthMonitor'|'planEvaluationWarning',
                  'stepName': 'string',
                  'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck'|'DocumentDb',
                  'resources': [
                      'string',
                  ],
                  'error': 'string',
                  'description': 'string',
                  'eventId': 'string',
                  'previousEventId': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The items in the plan execution event.

        
        

        - *(dict) --* 

          Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

          
          

          - **timestamp** *(datetime) --* 

            The timestamp for an execution event.

            
          

          - **type** *(string) --* 

            The type of an execution event.

            
          

          - **stepName** *(string) --* 

            The step name for an execution event.

            
          

          - **executionBlockType** *(string) --* 

            The execution block type for an execution event.

            
          

          - **resources** *(list) --* 

            The resources for an execution event.

            
            

            - *(string) --* 
        
          

          - **error** *(string) --* 

            Errors for an execution event.

            
          

          - **description** *(string) --* 

            The description for an execution event.

            
          

          - **eventId** *(string) --* 

            The event ID for an execution event.

            
          

          - **previousEventId** *(string) --* 

            The event ID of the previous execution event.

            
      
    
      

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

  