:doc:`IoTThingsGraph <../../iotthingsgraph>` / Paginator / ListFlowExecutionMessages

*************************
ListFlowExecutionMessages
*************************



.. py:class:: IoTThingsGraph.Paginator.ListFlowExecutionMessages

  ::

    
    paginator = client.get_paginator('list_flow_execution_messages')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTThingsGraph.Client.list_flow_execution_messages`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/ListFlowExecutionMessages>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          flowExecutionId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type flowExecutionId: string
    :param flowExecutionId: **[REQUIRED]** 

      The ID of the flow execution.

      

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

      
      ::

        {
            'messages': [
                {
                    'messageId': 'string',
                    'eventType': 'EXECUTION_STARTED'|'EXECUTION_FAILED'|'EXECUTION_ABORTED'|'EXECUTION_SUCCEEDED'|'STEP_STARTED'|'STEP_FAILED'|'STEP_SUCCEEDED'|'ACTIVITY_SCHEDULED'|'ACTIVITY_STARTED'|'ACTIVITY_FAILED'|'ACTIVITY_SUCCEEDED'|'START_FLOW_EXECUTION_TASK'|'SCHEDULE_NEXT_READY_STEPS_TASK'|'THING_ACTION_TASK'|'THING_ACTION_TASK_FAILED'|'THING_ACTION_TASK_SUCCEEDED'|'ACKNOWLEDGE_TASK_MESSAGE',
                    'timestamp': datetime(2015, 1, 1),
                    'payload': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **messages** *(list) --* 

          A list of objects that contain information about events in the specified flow execution.

          
          

          - *(dict) --* 

            An object that contains information about a flow event.

            
            

            - **messageId** *(string) --* 

              The unique identifier of the message.

              
            

            - **eventType** *(string) --* 

              The type of flow event .

              
            

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

              The date and time when the message was last updated.

              
            

            - **payload** *(string) --* 

              A string containing information about the flow event.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    