listGremlinQueries method

Future<ListGremlinQueriesOutput> listGremlinQueries({ bool? includeWaiting, })

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

May throw AccessDeniedException. May throw BadRequestException. May throw ClientTimeoutException. May throw ConcurrentModificationException. May throw ConstraintViolationException. May throw FailureByQueryException. May throw IllegalArgumentException. May throw InvalidArgumentException. May throw InvalidParameterException. May throw MissingParameterException. May throw ParsingException. May throw PreconditionsFailedException. May throw ReadOnlyViolationException. May throw TimeLimitExceededException. May throw TooManyRequestsException. May throw UnsupportedOperationException.

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

Implementation

Future<ListGremlinQueriesOutput> listGremlinQueries({
  bool? includeWaiting,
}) async {
  final $query = <String, List<String>>{
    if (includeWaiting != null) 'includeWaiting': [includeWaiting.toString()],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/gremlin/status',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListGremlinQueriesOutput.fromJson(response);
}