NeptuneData / Client / cancel_gremlin_query

cancel_gremlin_query#

NeptuneData.Client.cancel_gremlin_query(**kwargs)#

Cancels a Gremlin query. See Gremlin query cancellation 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:CancelQuery IAM action in that cluster.

See also: AWS API Documentation

Request Syntax

response = client.cancel_gremlin_query(
    queryId='string'
)
Parameters:

queryId (string) –

[REQUIRED]

The unique identifier that identifies the query to be canceled.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The status of the cancelation

Exceptions