IoTThingsGraph / Client / search_flow_executions

search_flow_executions#

IoTThingsGraph.Client.search_flow_executions(**kwargs)#

Searches for AWS IoT Things Graph workflow execution instances.

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

Request Syntax

response = client.search_flow_executions(
    systemInstanceId='string',
    flowExecutionId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    nextToken='string',
    maxResults=123
)
Parameters:

  • systemInstanceId (string) –

    [REQUIRED]

    The ID of the system instance that contains the flow.

  • flowExecutionId (string) – The ID of a flow execution.

  • startTime (datetime) – The date and time of the earliest flow execution to return.

  • endTime (datetime) – The date and time of the latest flow execution to return.

  • 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

{
    'summaries': [
        {
            'flowExecutionId': 'string',
            'status': 'RUNNING'|'ABORTED'|'SUCCEEDED'|'FAILED',
            'systemInstanceId': 'string',
            'flowTemplateId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • summaries (list) –

      An array of objects that contain summary information about each workflow execution in the result set.

      • (dict) –

        An object that contains summary information about a flow execution.

        • flowExecutionId (string) –

          The ID of the flow execution.

        • status (string) –

          The current status of the flow execution.

        • systemInstanceId (string) –

          The ID of the system instance that contains the flow.

        • flowTemplateId (string) –

          The ID of the flow.

        • createdAt (datetime) –

          The date and time when the flow execution summary was created.

        • updatedAt (datetime) –

          The date and time when the flow execution summary was last updated.

    • 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