Skip to content

StartImportTaskInput

Source code in docs_src/capo_neptune_graph/types/start_import_task_input.py
class StartImportTaskInput(TypedDict, closed=True):
    import_options: NotRequired["capo_neptune_graph.types.import_options.ImportOptions"]
    fail_on_error: NotRequired["bool"]
    """<p>If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.</p>"""
    source: "str"
    """<p>A URL identifying 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.</p>"""
    format: NotRequired["capo_neptune_graph.types.format.Format"]
    """<p>Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identifies the openCypher load format.</p>"""
    parquet_type: NotRequired["capo_neptune_graph.types.parquet_type.ParquetType"]
    """<p>The parquet type of the import task.</p>"""
    blank_node_handling: NotRequired[
        "capo_neptune_graph.types.blank_node_handling.BlankNodeHandling"
    ]
    """<p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>. For more information, see <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling">Handling RDF values</a>.</p>"""
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier"
    """<p>The unique identifier of the Neptune Analytics graph.</p>"""
    role_arn: "capo_neptune_graph.types.role_arn.RoleArn"
    """<p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>"""

blank_node_handling instance-attribute

blank_node_handling: NotRequired[BlankNodeHandling]

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

fail_on_error instance-attribute

fail_on_error: NotRequired[bool]

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

format instance-attribute

format: NotRequired[Format]

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

graph_identifier instance-attribute

graph_identifier: GraphIdentifier

The unique identifier of the Neptune Analytics graph.

import_options instance-attribute

import_options: NotRequired[ImportOptions]

parquet_type instance-attribute

parquet_type: NotRequired[ParquetType]

The parquet type of the import task.

role_arn instance-attribute

role_arn: RoleArn

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

source instance-attribute

source: str

A URL identifying 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.