List Open Cypher Queries

neptunedata_list_open_cypher_queries

R Documentation

Lists active openCypher queries¶

Description¶

Lists active openCypher queries. See Neptune openCypher status endpoint for more information.

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

Usage¶

neptunedata_list_open_cypher_queries(includeWaiting)

Arguments¶

includeWaiting: When set to TRUE and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.

Value¶

A list with the following syntax:

list(
  acceptedQueryCount = 123,
  runningQueryCount = 123,
  queries = list(
    list(
      queryId = "string",
      queryString = "string",
      queryEvalStats = list(
        waited = 123,
        elapsed = 123,
        cancelled = TRUE|FALSE,
        subqueries = list()
      )
    )
  )
)

Request syntax¶

svc$list_open_cypher_queries(
  includeWaiting = TRUE|FALSE
)