Skip to content

ImportTaskSummary

Source code in docs_src/capo_neptune_graph/types/import_task_summary.py
class ImportTaskSummary(TypedDict, closed=True):
    graph_id: NotRequired["capo_neptune_graph.types.graph_id.GraphId"]
    """<p>The unique identifier of the Neptune Analytics graph.</p>"""
    task_id: "capo_neptune_graph.types.task_id.TaskId"
    """<p>The unique identifier of the import task.</p>"""
    source: "str"
    """<p>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</p>"""
    format: NotRequired["capo_neptune_graph.types.format.Format"]
    """<p>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 identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher load format</a>.</p>"""
    parquet_type: NotRequired["capo_neptune_graph.types.parquet_type.ParquetType"]
    """<p>The parquet type of the import task.</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>"""
    status: "capo_neptune_graph.types.import_task_status.ImportTaskStatus"
    """<p>Status of the import task.</p>"""

format instance-attribute

format: NotRequired[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.

graph_id instance-attribute

graph_id: NotRequired[GraphId]

The unique identifier of the Neptune Analytics graph.

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

status instance-attribute

Status of the import task.

task_id instance-attribute

task_id: TaskId

The unique identifier of the import task.