NeptuneGraph / Client / get_query

get_query

NeptuneGraph.Client.get_query(**kwargs)

Retrieves the status of a specified query.

Note

When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the neptune-graph:GetQueryStatus IAM action attached.

See also: AWS API Documentation

Request Syntax

response = client.get_query(
    graphIdentifier='string',
    queryId='string'
)

Parameters:

• graphIdentifier (string) –

  [REQUIRED]

  The unique identifier of the Neptune Analytics graph.

• queryId (string) –

  [REQUIRED]

  The ID of the query in question.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'queryString': 'string',
    'waited': 123,
    'elapsed': 123,
    'state': 'RUNNING'|'WAITING'|'CANCELLING'
}

Response Structure

• (dict) –

  • id (string) –

    The ID of the query in question.

  • queryString (string) –

    The query in question.

  • waited (integer) –

    Indicates how long the query waited, in milliseconds.

  • elapsed (integer) –

    The number of milliseconds the query has been running.

  • state (string) –

    State of the query.

Exceptions

• NeptuneGraph.Client.exceptions.ThrottlingException

• NeptuneGraph.Client.exceptions.ValidationException

• NeptuneGraph.Client.exceptions.AccessDeniedException

• NeptuneGraph.Client.exceptions.InternalServerException

• NeptuneGraph.Client.exceptions.ResourceNotFoundException