GetQueryResults
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.
Request Syntax
GET /v20210603/Monitors/MonitorName
/Queries/QueryId
/Results?MaxResults=MaxResults
&NextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The number of query results that you want to return with this call.
Valid Range: Minimum value of 1. Maximum value of 1000.
- MonitorName
-
The name of the monitor to return data for.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- NextToken
-
The token for the next set of results. You receive this token from a previous call.
- QueryId
-
The ID of the query that you want to return data results for. A
QueryId
is an internally-generated identifier for a specific query.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Data": [
[ "string" ]
],
"Fields": [
{
"Name": "string",
"Type": "string"
}
],
"NextToken": "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.
- Data
-
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 usingFilterParameters
that you define.Type: Array of arrays of strings
- Fields
-
The fields that the query returns data for. Fields are name-data type pairs, such as
availability_score
-float
.Type: Array of QueryField objects
- NextToken
-
The token for the next set of results. You receive this token from a previous call.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: