IoTSiteWise / Paginator / GetQueryResults

GetQueryResults

class IoTSiteWise.Paginator.GetQueryResults

paginator = client.get_paginator('get_query_results')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace associated with the query.

• queryId (string) –

  [REQUIRED]

  The unique identifier for the query execution.

• 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

{
    'columnInfo': [
        {
            'name': 'string',
            'type': 'string'
        },
    ],
    'rows': [
        [
            'string',
        ],
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response for the GetQueryResults operation.

  • columnInfo (list) –

    A list of column metadata for the query results. Each entry contains the column name and data type. Present when the query status is COMPLETED.

    • (dict) –

      Contains metadata about a column in the query results.

      • name (string) –

        The name of the column.

      • type (string) –

        The data type of the column. Valid values are STRING, DOUBLE, BOOLEAN, INTEGER, TIMESTAMP, and VARIANT.

  • rows (list) –

    The result rows. Each row is a list of string column values, positional to match the columnInfo order. Present when the query status is COMPLETED.

    • (list) –

      A single row of query results containing column values. Each element is a string-encoded column value, positional to match the columnInfo order.

      • (string) –

        A string-encoded column value.

  • NextToken (string) –

    A token to resume pagination.