CloudWatchOmni / Client / get_telemetry_query_results

get_telemetry_query_results

CloudWatchOmni.Client.get_telemetry_query_results(**kwargs)

Returns the results for the specified query.

See also: AWS API Documentation

Request Syntax

response = client.get_telemetry_query_results(
    queryId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • queryId (string) –

    [REQUIRED]

    The unique ID of the query.

  • nextToken (string) – A token to retrieve the next page of results.

  • maxResults (integer) – The maximum number of result rows to return per page.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • status (string) –

      The current execution status of the query.

    • rows (list) –

      The result rows returned by the query.

      • (dict) –

        • (string) –

          • (string) –

    • nextToken (string) –

      A token to retrieve the next page of results, or null if there are no more results.

    • 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).

Exceptions