Skip to content

Get Gremlin Query Status

neptunedata_get_gremlin_query_status R Documentation

Gets the status of a specified Gremlin query

Description

Gets the status of a specified Gremlin 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: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).

Usage

neptunedata_get_gremlin_query_status(queryId)

Arguments

queryId

[required] The unique identifier that identifies the Gremlin query.

Value

A list with the following syntax:

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

Request syntax

svc$get_gremlin_query_status(
  queryId = "string"
)