getOpenCypherQueryStatus method

Future<GetOpenCypherQueryStatusOutput> getOpenCypherQueryStatus({ required String queryId, })

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

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 InvalidNumericDataException. 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 queryId : The unique ID of the openCypher query for which to retrieve the query status.

Implementation

Future<GetOpenCypherQueryStatusOutput> getOpenCypherQueryStatus({
  required String queryId,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/opencypher/status/${Uri.encodeComponent(queryId)}',
    exceptionFnMap: _exceptionFns,
  );
  return GetOpenCypherQueryStatusOutput.fromJson(response);
}