NeptuneData / Client / cancel_loader_job

cancel_loader_job#

NeptuneData.Client.cancel_loader_job(**kwargs)#

Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API 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:CancelLoaderJob IAM action in that cluster..

See also: AWS API Documentation

Request Syntax

response = client.cancel_loader_job(
    loadId='string'
)
Parameters:

loadId (string) –

[REQUIRED]

The ID of the load job to be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The cancellation status.

Exceptions

  • NeptuneData.Client.exceptions.BadRequestException

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.BulkLoadIdNotFoundException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.LoadUrlAccessDeniedException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.InternalFailureException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.MissingParameterException