IoTSiteWise / Paginator / ListQueries

ListQueries

class IoTSiteWise.Paginator.ListQueries

paginator = client.get_paginator('list_queries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_queries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workspaceName='string',
    filter='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace to list queries for.

• filter (string) – An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING.

• 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

{
    'queries': [
        {
            'queryId': 'string',
            'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING',
            'submittedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response for the ListQueries operation.

  • queries (list) –

    A list of query summaries for the workspace.

    • (dict) –

      Contains summary information about a query.

      • queryId (string) –

        The unique identifier for the query execution.

      • status (string) –

        The current query status.

      • submittedAt (datetime) –

        The date and time when the query was submitted, in Unix epoch time.

      • completedAt (datetime) –

        The date and time when the query reached a terminal state, in Unix epoch time.

  • NextToken (string) –

    A token to resume pagination.