Skip to content
AWS for Query.Farm

aws.neptune_graph.get_import_task

Example SQL Queries

SELECT * FROM
aws.neptune_graph.get_import_task
WHERE
"task_identifier" = 'VALUE';

Description

Retrieves a specified import task.

Table Definition

Column NameColumn Data Type
task_identifier Required Input Column

The unique identifier of the import task.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

attempt_number

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

BIGINT
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.

VARCHAR
graph_id

The unique identifier of the Neptune Analytics graph.

VARCHAR
import_options

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.

STRUCT(
    "neptune" STRUCT(
        "s3_export_path" VARCHAR,
        "s3_export_kms_key_id" VARCHAR,
        "preserve_default_vertex_labels" BOOLEAN,
        "preserve_edge_ids" BOOLEAN
    )
)
Show child fields
import_options.neptune

Options for importing data from a Neptune database.

Show child fields
import_options.neptune.preserve_default_vertex_labels

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.

import_options.neptune.preserve_edge_ids

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.

import_options.neptune.s3_export_kms_key_id

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

import_options.neptune.s3_export_path

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

import_task_details

Contains details about the specified import task.

STRUCT(
    "status" VARCHAR,
    "start_time" TIMESTAMP_S,
    "time_elapsed_seconds" BIGINT,
    "progress_percentage" BIGINT,
    "error_count" BIGINT,
    "error_details" VARCHAR,
    "statement_count" BIGINT,
    "dictionary_entry_count" BIGINT
)
Show child fields
import_task_details.dictionary_entry_count

The number of dictionary entries in the import task.

import_task_details.error_count

The number of errors encountered so far.

import_task_details.error_details

Details about the errors that have been encountered.

import_task_details.progress_percentage

The percentage progress so far.

import_task_details.start_time

Time at which the import task started.

import_task_details.statement_count

The number of statements in the import task.

import_task_details.status

Status of the import task.

import_task_details.time_elapsed_seconds

Seconds elapsed since the import task started.

role_arn

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

VARCHAR
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

VARCHAR
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.

VARCHAR
status_reason

The reason that the import task has this status value.

VARCHAR
task_id

The unique identifier of the import task.

VARCHAR