CloudWatchOmni / Paginator / GetTelemetryQueryResults

GetTelemetryQueryResults

class CloudWatchOmni.Paginator.GetTelemetryQueryResults

paginator = client.get_paginator('get_telemetry_query_results')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.get_telemetry_query_results().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• queryId (string) –

  [REQUIRED]

  The unique ID of the query.

• 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

{
    'status': 'Running'|'Failed'|'Complete'|'Cancelled',
    'rows': [
        {
            'string': 'string'
        },
    ],
    'statistics': {
        'bytesScanned': 123.0,
        'percentComplete': 123,
        'recordsScanned': 123,
        'recordsMatched': 123,
        'partialResults': {
            'partialResultsDetected': True|False
        }
    },
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • status (string) –

    The current execution status of the query.

  • rows (list) –

    The result rows returned by the query.

    • (dict) –

      • (string) –

        • (string) –

  • statistics (dict) –

    Statistics about the query execution.

    • bytesScanned (float) –

      The number of bytes scanned by the query.

    • percentComplete (integer) –

      The percentage of the query that has completed.

    • recordsScanned (integer) –

      The total number of records scanned.

    • recordsMatched (integer) –

      The number of records that matched the query criteria.

    • partialResults (dict) –

      Information about whether the query returned partial results.

      • partialResultsDetected (boolean) –

        True when the query returned partial results (some data could not be read).

  • NextToken (string) –

    A token to resume pagination.