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

GetImportTask

Retrieves a specified import task.

Request Syntax


GET /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

{
   "attemptNumber": number,
   "format": "string",
   "graphId": "string",
   "importOptions": { ... },
   "importTaskDetails": { 
      "dictionaryEntryCount": number,
      "errorCount": number,
      "errorDetails": "string",
      "progressPercentage": number,
      "startTime": number,
      "statementCount": number,
      "status": "string",
      "timeElapsedSeconds": number
   },
   "parquetType": "string",
   "roleArn": "string",
   "source": "string",
   "status": "string",
   "statusReason": "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.

attemptNumber

The number of the current attempts to execute the import task.

Type: Integer

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}

importOptions

Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

Type: ImportOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

importTaskDetails

Contains details about the specified import task.

Type: ImportTaskDetails object

parquetType

The parquet type of the 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

The status of the import task:

INITIALIZING – The necessary resources needed to create the graph are being prepared.
ANALYZING_DATA – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.
RE_PROVISIONING – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.
IMPORTING – The data is being loaded.
ERROR_ENCOUNTERED – An error has been encountered while trying to create the graph and import the data.
ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, the graph is being rolled back and all its resources released.
SUCCEEDED – Graph creation and data loading succeeded.
FAILED – Graph creation or data loading failed. When the status is FAILED, you can use get-graphs to get more information about the state of the graph.
CANCELLING – Because you cancelled the import task, cancellation is in progress.
CANCELLED – You have successfully cancelled the import task.

Type: String

statusReason

The reason that the import task has this status value.

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.

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