NeptuneGraph / Client / get_import_task

get_import_task#

NeptuneGraph.Client.get_import_task(**kwargs)#

Retrieves a specified import task.

See also: AWS API Documentation

Request Syntax

response = client.get_import_task(
    taskIdentifier='string'
)
Parameters:

taskIdentifier (string) –

[REQUIRED]

The unique identifier of the import task.

Return type:

dict

Returns:

Response Syntax

{
    'graphId': 'string',
    'taskId': 'string',
    'source': 'string',
    'format': 'CSV'|'OPEN_CYPHER',
    'roleArn': 'string',
    'status': 'INITIALIZING'|'EXPORTING'|'ANALYZING_DATA'|'IMPORTING'|'REPROVISIONING'|'ROLLING_BACK'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
    'importOptions': {
        'neptune': {
            's3ExportPath': 'string',
            's3ExportKmsKeyId': 'string',
            'preserveDefaultVertexLabels': True|False,
            'preserveEdgeIds': True|False
        }
    },
    'importTaskDetails': {
        'status': 'string',
        'startTime': datetime(2015, 1, 1),
        'timeElapsedSeconds': 123,
        'progressPercentage': 123,
        'errorCount': 123,
        'errorDetails': 'string',
        'statementCount': 123,
        'dictionaryEntryCount': 123
    },
    'attemptNumber': 123,
    'statusReason': 'string'
}

Response Structure

  • (dict) –

    • graphId (string) –

      The unique identifier of the Neptune Analytics graph.

    • taskId (string) –

      The unique identifier of the import task.

    • source (string) –

      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 (string) –

      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.

    • roleArn (string) –

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

    • status (string) –

      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.

    • importOptions (dict) –

      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.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: neptune. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • neptune (dict) –

        Options for importing data from a Neptune database.

        • s3ExportPath (string) –

          The path to an S3 bucket from which to import data.

        • s3ExportKmsKeyId (string) –

          The KMS key to use to encrypt data in the S3 bucket where the graph data is exported

        • preserveDefaultVertexLabels (boolean) –

          Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.

        • preserveEdgeIds (boolean) –

          Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.

    • importTaskDetails (dict) –

      Contains details about the specified import task.

      • status (string) –

        Status of the import task.

      • startTime (datetime) –

        Time at which the import task started.

      • timeElapsedSeconds (integer) –

        Seconds elapsed since the import task started.

      • progressPercentage (integer) –

        The percentage progress so far.

      • errorCount (integer) –

        The number of errors encountered so far.

      • errorDetails (string) –

        Details about the errors that have been encountered.

      • statementCount (integer) –

        The number of statements in the import task.

      • dictionaryEntryCount (integer) –

        The number of dictionary entries in the import task.

    • attemptNumber (integer) –

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

    • statusReason (string) –

      The reason that the import task has this status value.

Exceptions