AWS SDK Version 3 for .NET
API Reference

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.

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

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 enables 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).

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginExecuteGremlinQuery and EndExecuteGremlinQuery.

Namespace: Amazon.Neptunedata
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<ExecuteGremlinQueryResponse> ExecuteGremlinQueryAsync(
         ExecuteGremlinQueryRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Neptunedata.Model.ExecuteGremlinQueryRequest

Container for the necessary parameters to execute the ExecuteGremlinQuery service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ExecuteGremlinQuery service method, as returned by Neptunedata.

Exceptions

ExceptionCondition
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also