GetOpenCypherQueryStatus
Retrieves the status of a specified openCypher query.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
Request Syntax
GET /opencypher/status/queryId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- queryId
-
The unique ID of the openCypher query for which to retrieve the query status.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"queryEvalStats": {
"cancelled": boolean,
"elapsed": number,
"subqueries": JSON value,
"waited": number
},
"queryId": "string",
"queryString": "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.
- queryEvalStats
-
The openCypher query evaluation status.
Type: QueryEvalStats object
- queryId
-
The unique ID of the query for which status is being returned.
Type: String
- queryString
-
The openCypher query string.
Type: String
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.
HTTP Status Code: 403
- BadRequestException
-
Raised when a request is submitted that cannot be processed.
HTTP Status Code: 400
- ClientTimeoutException
-
Raised when a request timed out in the client.
HTTP Status Code: 408
- ConcurrentModificationException
-
Raised when a request attempts to modify data that is concurrently being modified by another process.
HTTP Status Code: 500
- ConstraintViolationException
-
Raised when a value in a request field did not satisfy required constraints.
HTTP Status Code: 400
- FailureByQueryException
-
Raised when a request fails.
HTTP Status Code: 500
- IllegalArgumentException
-
Raised when an argument in a request is not supported.
HTTP Status Code: 400
- InvalidArgumentException
-
Raised when an argument in a request has an invalid value.
HTTP Status Code: 400
- InvalidNumericDataException
-
Raised when invalid numerical data is encountered when servicing a request.
HTTP Status Code: 400
- InvalidParameterException
-
Raised when a parameter value is not valid.
HTTP Status Code: 400
- MissingParameterException
-
Raised when a required parameter is missing.
HTTP Status Code: 400
- ParsingException
-
Raised when a parsing issue is encountered.
HTTP Status Code: 400
- PreconditionsFailedException
-
Raised when a precondition for processing a request is not satisfied.
HTTP Status Code: 400
- ReadOnlyViolationException
-
Raised when a request attempts to write to a read-only resource.
HTTP Status Code: 400
- TimeLimitExceededException
-
Raised when the an operation exceeds the time limit allowed for it.
HTTP Status Code: 500
- TooManyRequestsException
-
Raised when the number of requests being processed exceeds the limit.
HTTP Status Code: 429
- UnsupportedOperationException
-
Raised when a request attempts to initiate an operation that is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: