NeptuneData / Client / cancel_open_cypher_query

cancel_open_cypher_query

NeptuneData.Client.cancel_open_cypher_query(**kwargs)

Cancels a specified openCypher query. See Neptune openCypher status endpoint 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_open_cypher_query(
    queryId='string',
    silent=True|False
)

Parameters:

• queryId (string) –

  [REQUIRED]

  The unique ID of the openCypher query to cancel.

• silent (boolean) – If set to TRUE, causes the cancelation of the openCypher query to happen silently.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'payload': True|False
}

Response Structure

• (dict) –

  • status (string) –

    The cancellation status of the openCypher query.

  • payload (boolean) –

    The cancelation payload for the openCypher query.

Exceptions

• NeptuneData.Client.exceptions.InvalidNumericDataException

• NeptuneData.Client.exceptions.BadRequestException

• NeptuneData.Client.exceptions.InvalidParameterException

• NeptuneData.Client.exceptions.ClientTimeoutException

• 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.ConstraintViolationException

• NeptuneData.Client.exceptions.TimeLimitExceededException

• NeptuneData.Client.exceptions.InvalidArgumentException

• NeptuneData.Client.exceptions.ConcurrentModificationException

• NeptuneData.Client.exceptions.MissingParameterException