GetQueryStatus
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.
When you run a query, check the status to make sure that the query has SUCCEEDED
before you review the results.
-
QUEUED
: The query is scheduled to run. -
RUNNING
: The query is in progress but not complete. -
SUCCEEDED
: The query completed sucessfully. -
FAILED
: The query failed due to an error. -
CANCELED
: The query was canceled.
Request Syntax
GET /v20210603/Monitors/MonitorName
/Queries/QueryId
/Status HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MonitorName
-
The name of the monitor.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- QueryId
-
The ID of the query that you want to return the status for. A
QueryId
is an internally-generated dentifier 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
{
"Status": "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.
- Status
-
The current status for a query.
Type: String
Valid Values:
QUEUED | RUNNING | SUCCEEDED | FAILED | CANCELED
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 Amazon SDKs, see the following: