Skip to content

/AWS1/CL_NEGGETIMPTASKOUTPUT

GetImportTaskOutput

CONSTRUCTOR

IMPORTING

Required arguments:

iv_taskid TYPE /AWS1/NEGTASKID /AWS1/NEGTASKID

The unique identifier of the import task.

iv_source TYPE /AWS1/NEGSTRING /AWS1/NEGSTRING

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

iv_rolearn TYPE /AWS1/NEGROLEARN /AWS1/NEGROLEARN

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

iv_status TYPE /AWS1/NEGIMPORTTASKSTATUS /AWS1/NEGIMPORTTASKSTATUS

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.

Optional arguments:

iv_graphid TYPE /AWS1/NEGGRAPHID /AWS1/NEGGRAPHID

The unique identifier of the Neptune Analytics graph.

iv_format TYPE /AWS1/NEGFORMAT /AWS1/NEGFORMAT

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identifies the openCypher load format.

iv_parquettype TYPE /AWS1/NEGPARQUETTYPE /AWS1/NEGPARQUETTYPE

The parquet type of the import task.

io_importoptions TYPE REF TO /AWS1/CL_NEGIMPORTOPTIONS /AWS1/CL_NEGIMPORTOPTIONS

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.

io_importtaskdetails TYPE REF TO /AWS1/CL_NEGIMPORTTASKDETAILS /AWS1/CL_NEGIMPORTTASKDETAILS

Contains details about the specified import task.

iv_attemptnumber TYPE /AWS1/NEGINTEGER /AWS1/NEGINTEGER

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

iv_statusreason TYPE /AWS1/NEGSTRING /AWS1/NEGSTRING

The reason that the import task has this status value.

Queryable Attributes

graphId

The unique identifier of the Neptune Analytics graph.

Accessible with the following methods

Method Description
GET_GRAPHID() Getter for GRAPHID, with configurable default
ASK_GRAPHID() Getter for GRAPHID w/ exceptions if field has no value
HAS_GRAPHID() Determine if GRAPHID has a value

taskId

The unique identifier of the import task.

Accessible with the following methods

Method Description
GET_TASKID() Getter for TASKID, with configurable default
ASK_TASKID() Getter for TASKID w/ exceptions if field has no value
HAS_TASKID() Determine if TASKID has a value

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

Accessible with the following methods

Method Description
GET_SOURCE() Getter for SOURCE, with configurable default
ASK_SOURCE() Getter for SOURCE w/ exceptions if field has no value
HAS_SOURCE() Determine if SOURCE has a value

format

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identifies the openCypher load format.

Accessible with the following methods

Method Description
GET_FORMAT() Getter for FORMAT, with configurable default
ASK_FORMAT() Getter for FORMAT w/ exceptions if field has no value
HAS_FORMAT() Determine if FORMAT has a value

parquetType

The parquet type of the import task.

Accessible with the following methods

Method Description
GET_PARQUETTYPE() Getter for PARQUETTYPE, with configurable default
ASK_PARQUETTYPE() Getter for PARQUETTYPE w/ exceptions if field has no value
HAS_PARQUETTYPE() Determine if PARQUETTYPE has a value

roleArn

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

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

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.

Accessible with the following methods

Method Description
GET_IMPORTOPTIONS() Getter for IMPORTOPTIONS

importTaskDetails

Contains details about the specified import task.

Accessible with the following methods

Method Description
GET_IMPORTTASKDETAILS() Getter for IMPORTTASKDETAILS

attemptNumber

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

Accessible with the following methods

Method Description
GET_ATTEMPTNUMBER() Getter for ATTEMPTNUMBER, with configurable default
ASK_ATTEMPTNUMBER() Getter for ATTEMPTNUMBER w/ exceptions if field has no value
HAS_ATTEMPTNUMBER() Determine if ATTEMPTNUMBER has a value

statusReason

The reason that the import task has this status value.

Accessible with the following methods

Method Description
GET_STATUSREASON() Getter for STATUSREASON, with configurable default
ASK_STATUSREASON() Getter for STATUSREASON w/ exceptions if field has no value
HAS_STATUSREASON() Determine if STATUSREASON has a value