Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartQuery

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.

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.

Request Syntax


POST /v20210603/Monitors/MonitorName/Queries HTTP/1.1
Content-type: application/json

{
   "EndTime": "string",
   "FilterParameters": [ 
      { 
         "Field": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "LinkedAccountId": "string",
   "QueryType": "string",
   "StartTime": "string"
}

URI Request Parameters

The request uses the following URI parameters.

MonitorName

The name of the monitor to query.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

EndTime

The timestamp that is the end of the period that you want to retrieve data for with your query.

Type: Timestamp

Required: Yes

FilterParameters

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Type: Array of FilterParameter objects

Required: No

LinkedAccountId

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Type: String

Length Constraints: Fixed length of 12.

Required: No

QueryType

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.
TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.
TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.
OVERALL_TRAFFIC_SUGGESTIONS: Provides TTFB, using a 30-day weighted average, for all traffic in each Amazon location that is monitored.
OVERALL_TRAFFIC_SUGGESTIONS_DETAILS: Provides TTFB, using a 30-day weighted average, for each top location, for a proposed Amazon location. Must provide a Amazon location to search.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Type: String

Valid Values: MEASUREMENTS | TOP_LOCATIONS | TOP_LOCATION_DETAILS | OVERALL_TRAFFIC_SUGGESTIONS | OVERALL_TRAFFIC_SUGGESTIONS_DETAILS

Required: Yes

StartTime

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Type: Timestamp

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "QueryId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

QueryId

The internally-generated identifier of a specific query.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

LimitExceededException

The request exceeded a service quota.

HTTP Status Code: 403

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Invalid request.

HTTP Status Code: 400