GetQuery
Retrieves the status of a specified query.
Note
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the
neptune-graph:GetQueryStatus IAM action attached.
Request Syntax
GET /queries/queryId HTTP/1.1
graphIdentifier: graphIdentifier
URI Request Parameters
The request uses the following URI parameters.
- graphIdentifier
-
The unique identifier of the Neptune Analytics graph.
Pattern:
g-[a-z0-9]{10}Required: Yes
- queryId
-
The ID of the query in question.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"elapsed": number,
"id": "string",
"queryString": "string",
"state": "string",
"waited": number
}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.
- elapsed
-
The number of milliseconds the query has been running.
Type: Integer
- id
-
The ID of the query in question.
Type: String
- queryString
-
The query in question.
Type: String
- state
-
State of the query.
Type: String
Valid Values:
RUNNING | WAITING | CANCELLING - waited
-
Indicates how long the query waited, in milliseconds.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Raised in case of an authentication or authorization failure.
- message
-
A message describing the problem.
HTTP Status Code: 403
- InternalServerException
-
A failure occurred on the server.
- message
-
A message describing the problem.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
- message
-
A message describing the problem.
HTTP Status Code: 404
- ThrottlingException
-
The exception was interrupted by throttling.
- message
-
A message describing the problem.
HTTP Status Code: 429
- ValidationException
-
A resource could not be validated.
- message
-
A message describing the problem.
- reason
-
The reason that the resource could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
