NeptuneGraph / Client / cancel_export_task

cancel_export_task#

NeptuneGraph.Client.cancel_export_task(**kwargs)#

Cancel the specified export task.

Request Syntax

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

Parameters:

taskIdentifier (string) –

[REQUIRED]

The unique identifier of the export task.

Return type:

dict

Returns:

Response Syntax

{
    'graphId': 'string',
    'roleArn': 'string',
    'taskId': 'string',
    'status': 'INITIALIZING'|'EXPORTING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED',
    'format': 'PARQUET'|'CSV',
    'destination': 'string',
    'kmsKeyIdentifier': 'string',
    'parquetType': 'COLUMNAR',
    'statusReason': 'string'
}

Response Structure

(dict) –
- graphId (string) –
  
  The source graph identifier of the cancelled export task.
- roleArn (string) –
  
  The ARN of the IAM role that will allow the exporting of data to the destination.
- taskId (string) –
  
  The unique identifier of the export task.
- status (string) –
  
  The current status of the export task. The status is CANCELLING when the export task is cancelled.
- format (string) –
  
  The format of the cancelled export task.
- destination (string) –
  
  The Amazon S3 URI of the cancelled export task where data will be exported to.
- kmsKeyIdentifier (string) –
  
  The KMS key identifier of the cancelled export task.
- parquetType (string) –
  
  The parquet type of the cancelled export task.
- statusReason (string) –
  
  The reason that the export task has this status value.

Exceptions

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