ListGremlinQueriesCommand

Suggest an Edit

Lists active Gremlin queries. See Gremlin query status API  for details about the output.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NeptunedataClient, ListGremlinQueriesCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
// const { NeptunedataClient, ListGremlinQueriesCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
const client = new NeptunedataClient(config);
const input = { // ListGremlinQueriesInput
  includeWaiting: true || false,
};
const command = new ListGremlinQueriesCommand(input);
const response = await client.send(command);
// { // ListGremlinQueriesOutput
//   acceptedQueryCount: Number("int"),
//   runningQueryCount: Number("int"),
//   queries: [ // GremlinQueries
//     { // GremlinQueryStatus
//       queryId: "STRING_VALUE",
//       queryString: "STRING_VALUE",
//       queryEvalStats: { // QueryEvalStats
//         waited: Number("int"),
//         elapsed: Number("int"),
//         cancelled: true || false,
//         subqueries: "DOCUMENT_VALUE",
//       },
//     },
//   ],
// };

ListGremlinQueriesCommand Input

See ListGremlinQueriesCommandInput for more details

Parameter
Type
Description
includeWaiting
boolean | undefined

If set to TRUE, the list returned includes waiting queries. The default is FALSE;

ListGremlinQueriesCommand Output

See ListGremlinQueriesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
acceptedQueryCount
number | undefined

The number of queries that have been accepted but not yet completed, including queries in the queue.

queries
GremlinQueryStatus[] | undefined

A list of the current queries.

runningQueryCount
number | undefined

The number of Gremlin queries currently running.

Throws

Name
Fault
Details
AccessDeniedException
client

Raised in case of an authentication or authorization failure.

BadRequestException
client

Raised when a request is submitted that cannot be processed.

ClientTimeoutException
client

Raised when a request timed out in the client.

ConcurrentModificationException
server

Raised when a request attempts to modify data that is concurrently being modified by another process.

ConstraintViolationException
client

Raised when a value in a request field did not satisfy required constraints.

FailureByQueryException
server

Raised when a request fails.

IllegalArgumentException
client

Raised when an argument in a request is not supported.

InvalidArgumentException
client

Raised when an argument in a request has an invalid value.

InvalidParameterException
client

Raised when a parameter value is not valid.

MissingParameterException
client

Raised when a required parameter is missing.

ParsingException
client

Raised when a parsing issue is encountered.

PreconditionsFailedException
client

Raised when a precondition for processing a request is not satisfied.

ReadOnlyViolationException
client

Raised when a request attempts to write to a read-only resource.

TimeLimitExceededException
server

Raised when the an operation exceeds the time limit allowed for it.

TooManyRequestsException
client

Raised when the number of requests being processed exceeds the limit.

UnsupportedOperationException
client

Raised when a request attempts to initiate an operation that is not supported.

NeptunedataServiceException
Base exception class for all service exceptions from Neptunedata service.