NeptuneData / Client / get_open_cypher_query_status

get_open_cypher_query_status#

NeptuneData.Client.get_open_cypher_query_status(**kwargs)#

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

Request Syntax

response = client.get_open_cypher_query_status(
    queryId='string'
)

Parameters:

queryId (string) –

[REQUIRED]

The unique ID of the openCypher query for which to retrieve the query status.

Return type:

dict

Returns:

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 unique ID of the query for which status is being returned.
- queryString (string) –
  
  The openCypher query string.
- queryEvalStats (dict) –
  
  The openCypher query evaluation status.
  - 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.

Exceptions

NeptuneData.Client.exceptions.InvalidNumericDataException
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