CloudWatchInternetMonitor / Client / get_query_results

get_query_results#

CloudWatchInternetMonitor.Client.get_query_results(**kwargs)#

Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name.

For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_query_results(
    MonitorName='string',
    QueryId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • MonitorName (string) –

    [REQUIRED]

    The name of the monitor to return data for.

  • QueryId (string) –

    [REQUIRED]

    The ID of the query that you want to return data results for. A QueryId is an internally-generated identifier for a specific query.

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

  • MaxResults (integer) – The number of query results that you want to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'Fields': [
        {
            'Name': 'string',
            'Type': 'string'
        },
    ],
    'Data': [
        [
            'string',
        ],
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Fields (list) –

      The fields that the query returns data for. Fields are name-data type pairs, such as availability_score- float.

      • (dict) –

        Defines a field to query for your application’s Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific type. Each QueryType includes a specific set of fields and datatypes to retrieve data for.

        • Name (string) –

          The name of a field to query your application’s Amazon CloudWatch Internet Monitor data for, such as availability_score.

        • Type (string) –

          The data type for a query field, which must correspond to the field you’re defining for QueryField. For example, if the query field name is availability_score, the data type is float.

    • Data (list) –

      The data results that the query returns. Data is returned in arrays, aligned with the Fields for the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter the information in the repository by using FilterParameters that you define.

      • (list) –

        • (string) –

    • NextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions

  • CloudWatchInternetMonitor.Client.exceptions.InternalServerException

  • CloudWatchInternetMonitor.Client.exceptions.AccessDeniedException

  • CloudWatchInternetMonitor.Client.exceptions.ThrottlingException

  • CloudWatchInternetMonitor.Client.exceptions.LimitExceededException

  • CloudWatchInternetMonitor.Client.exceptions.ValidationException