GetQueryState
Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.
Request Syntax
{
"QueryId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- QueryId
-
The ID of the plan query operation.
Type: String
Length Constraints: Fixed length of 36.
Required: Yes
Response Syntax
{
"Error": "string",
"State": "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.
- Error
-
An error message when the operation fails.
Type: String
- State
-
The state of a query previously submitted. The possible states are:
-
PENDING: the query is pending.
-
WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
-
FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.
-
ERROR: an error occurred with the query, such as an invalid query ID or a backend error.
Type: String
Valid Values:
PENDING | WORKUNITS_AVAILABLE | ERROR | FINISHED | EXPIRED -
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
