NeptuneData / Client / get_gremlin_query_status



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

See also: AWS API Documentation

Request Syntax

response = client.get_gremlin_query_status(

queryId (string) –


The unique identifier that identifies the Gremlin query.

Return type:



Response Syntax

    'queryId': 'string',
    'queryString': 'string',
    'queryEvalStats': {
        'waited': 123,
        'elapsed': 123,
        'cancelled': True|False,
        'subqueries': {...}|[...]|123|123.4|'string'|True|None

Response Structure

  • (dict) –

    • queryId (string) –

      The ID of the query for which status is being returned.

    • queryString (string) –

      The Gremlin query string.

    • queryEvalStats (dict) –

      The evaluation status of the Gremlin query.

      • waited (integer) –

        Indicates how long the query waited, in milliseconds.

      • elapsed (integer) –

        The number of milliseconds the query has been running so far.

      • cancelled (boolean) –

        Set to TRUE if the query was cancelled, or FALSE otherwise.

      • subqueries (document) –

        The number of subqueries in this query.


  • NeptuneData.Client.exceptions.BadRequestException

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.AccessDeniedException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.FailureByQueryException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.ParsingException

  • NeptuneData.Client.exceptions.ReadOnlyViolationException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.TimeLimitExceededException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.ConcurrentModificationException

  • NeptuneData.Client.exceptions.MissingParameterException