Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CancelImportTask

Deletes the specified import task.

Request Syntax


DELETE /importtasks/taskIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

taskIdentifier

The unique identifier of the import task.

Pattern: t-[a-z0-9]{10}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "format": "string",
   "graphId": "string",
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "taskId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

format

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.

Type: String

Valid Values: CSV | OPEN_CYPHER | PARQUET | NTRIPLES

graphId

The unique identifier of the Neptune Analytics graph.

Type: String

Pattern: g-[a-z0-9]{10}

parquetType

The parquet type of the cancelled import task.

Type: String

Valid Values: COLUMNAR

roleArn

The ARN of the IAM role that will allow access to the data that is to be imported.

Type: String

Pattern: arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+

source

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.

Type: String

status

Current status of the task. Status is CANCELLING when the import task is cancelled.

Type: String

taskId

The unique identifier of the import task.

Type: String

Pattern: t-[a-z0-9]{10}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Raised when a conflict is encountered.

message: A message describing the problem.
reason: The reason for the conflict exception.

HTTP Status Code: 409

InternalServerException

A failure occurred on the server.

message: A message describing the problem.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be located.

message: A message describing the problem.

HTTP Status Code: 404

ThrottlingException

The exception was interrupted by throttling.

message: A message describing the problem.

HTTP Status Code: 429

ValidationException

A resource could not be validated.

message: A message describing the problem.
reason: The reason that the resource could not be validated.

HTTP Status Code: 400