NeptuneGraph / Client / cancel_import_task

cancel_import_task#

NeptuneGraph.Client.cancel_import_task(**kwargs)#

Deletes the specified import task.

Request Syntax

response = client.cancel_import_task(
    taskIdentifier='string'
)

Parameters:

taskIdentifier (string) –

[REQUIRED]

The unique identifier of the import task.

Return type:

dict

Returns:

Response Syntax

{
    'graphId': 'string',
    'taskId': 'string',
    'source': 'string',
    'format': 'CSV'|'OPEN_CYPHER'|'PARQUET'|'NTRIPLES',
    'parquetType': 'COLUMNAR',
    'roleArn': 'string',
    'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED'
}

Response Structure

(dict) –
- graphId (string) –
  
  The unique identifier of the Neptune Analytics graph.
- taskId (string) –
  
  The unique identifier of the import task.
- source (string) –
  
  A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.
- format (string) –
  
  Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
- parquetType (string) –
  
  The parquet type of the cancelled import task.
- roleArn (string) –
  
  The ARN of the IAM role that will allow access to the data that is to be imported.
- status (string) –
  
  Current status of the task. Status is CANCELLING when the import task is cancelled.

Exceptions

NeptuneGraph.Client.exceptions.ThrottlingException
NeptuneGraph.Client.exceptions.ValidationException
NeptuneGraph.Client.exceptions.ConflictException
NeptuneGraph.Client.exceptions.InternalServerException
NeptuneGraph.Client.exceptions.ResourceNotFoundException