IoTThingsGraph / Client / list_flow_execution_messages

list_flow_execution_messages#

IoTThingsGraph.Client.list_flow_execution_messages(**kwargs)#

Returns a list of objects that contain information about events in a flow execution.

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.

Request Syntax

response = client.list_flow_execution_messages(
    flowExecutionId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

flowExecutionId (string) –
[REQUIRED]

The ID of the flow execution.
nextToken (string) – The string that specifies the next page of results. Use this when you’re paginating results.
maxResults (integer) – The maximum number of results to return in the response.

Return type:

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) –
  
  The string to specify as nextToken when you request the next page of results.

Exceptions

IoTThingsGraph.Client.exceptions.InvalidRequestException
IoTThingsGraph.Client.exceptions.ThrottlingException
IoTThingsGraph.Client.exceptions.InternalFailureException
IoTThingsGraph.Client.exceptions.ResourceNotFoundException