AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named explain that provides is a
self-service tool for understanding the execution approach being taken by the Neptune
engine for the query. You invoke it by adding an explain parameter to an HTTP
call that submits a Gremlin query.
The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.
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 one of the following IAM actions in that cluster, depending on the query:
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
For .NET Core this operation is only available in asynchronous form. Please refer to ExecuteGremlinExplainQueryAsync.
Namespace: Amazon.Neptunedata
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z
public virtual ExecuteGremlinExplainQueryResponse ExecuteGremlinExplainQuery( ExecuteGremlinExplainQueryRequest request )
Container for the necessary parameters to execute the ExecuteGremlinExplainQuery service method.
| Exception | Condition |
|---|---|
| BadRequestException | Raised when a request is submitted that cannot be processed. |
| CancelledByUserException | Raised when a user cancelled a request. |
| ClientTimeoutException | Raised when a request timed out in the client. |
| ConcurrentModificationException | Raised when a request attempts to modify data that is concurrently being modified by another process. |
| ConstraintViolationException | Raised when a value in a request field did not satisfy required constraints. |
| FailureByQueryException | Raised when a request fails. |
| IllegalArgumentException | Raised when an argument in a request is not supported. |
| InvalidArgumentException | Raised when an argument in a request has an invalid value. |
| InvalidParameterException | Raised when a parameter value is not valid. |
| MalformedQueryException | Raised when a query is submitted that is syntactically incorrect or does not pass additional validation. |
| MemoryLimitExceededException | Raised when a request fails because of insufficient memory resources. The request can be retried. |
| MissingParameterException | Raised when a required parameter is missing. |
| ParsingException | Raised when a parsing issue is encountered. |
| PreconditionsFailedException | Raised when a precondition for processing a request is not satisfied. |
| QueryLimitExceededException | Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy. |
| QueryLimitException | Raised when the size of a query exceeds the system limit. |
| QueryTooLargeException | Raised when the body of a query is too large. |
| TimeLimitExceededException | Raised when the an operation exceeds the time limit allowed for it. |
| TooManyRequestsException | Raised when the number of requests being processed exceeds the limit. |
| UnsupportedOperationException | Raised when a request attempts to initiate an operation that is not supported. |
.NET Framework:
Supported in: 4.5 and newer, 3.5