Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1434174156.5 KB

Retrieves a specified import task.

get/importtasks/{taskIdentifier}

Path parameters

taskIdentifierstring required

The unique identifier of the import task.

Response

Success

graphIdstring

The unique identifier of the Neptune Analytics graph.

taskIdstring required

The unique identifier of the import task.

sourcestring required

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'CSV' | 'OPEN_CYPHER' | 'PARQUET' | 'NTRIPLES'

Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV format</a> or <code>OPENCYPHER</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher load format</a>.

parquetType'COLUMNAR'

The parquet type of the import task.

roleArnstring required

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

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

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

statusReasonstring

The reason that the import task has this status value.