IoTThingsGraph / Paginator / SearchFlowExecutions

SearchFlowExecutions

class IoTThingsGraph.Paginator.SearchFlowExecutions

paginator = client.get_paginator('search_flow_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTThingsGraph.Client.search_flow_executions().

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_iterator = paginator.paginate(
    systemInstanceId='string',
    flowExecutionId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  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.

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) –

    A token to resume pagination.