Skip to content

Type definitions#

Index > NeptuneGraph > Type definitions

Auto-generated documentation for NeptuneGraph type annotations stubs module mypy-boto3-neptune-graph.

ExportFilterUnionTypeDef#

# ExportFilterUnionTypeDef Union usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterUnionTypeDef


def get_value() -> ExportFilterUnionTypeDef:
    return ...


# ExportFilterUnionTypeDef definition

ExportFilterUnionTypeDef = Union[
    ExportFilterTypeDef,  # (1)
    ExportFilterOutputTypeDef,  # (2)
]
  1. See ExportFilterTypeDef
  2. See ExportFilterOutputTypeDef

CancelExportTaskInputTypeDef#

# CancelExportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CancelExportTaskInputTypeDef


def get_value() -> CancelExportTaskInputTypeDef:
    return {
        "taskIdentifier": ...,
    }


# CancelExportTaskInputTypeDef definition

class CancelExportTaskInputTypeDef(TypedDict):
    taskIdentifier: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CancelImportTaskInputTypeDef#

# CancelImportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CancelImportTaskInputTypeDef


def get_value() -> CancelImportTaskInputTypeDef:
    return {
        "taskIdentifier": ...,
    }


# CancelImportTaskInputTypeDef definition

class CancelImportTaskInputTypeDef(TypedDict):
    taskIdentifier: str,

CancelQueryInputTypeDef#

# CancelQueryInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CancelQueryInputTypeDef


def get_value() -> CancelQueryInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# CancelQueryInputTypeDef definition

class CancelQueryInputTypeDef(TypedDict):
    graphIdentifier: str,
    queryId: str,

VectorSearchConfigurationTypeDef#

# VectorSearchConfigurationTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import VectorSearchConfigurationTypeDef


def get_value() -> VectorSearchConfigurationTypeDef:
    return {
        "dimension": ...,
    }


# VectorSearchConfigurationTypeDef definition

class VectorSearchConfigurationTypeDef(TypedDict):
    dimension: int,

CreateGraphSnapshotInputTypeDef#

# CreateGraphSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphSnapshotInputTypeDef


def get_value() -> CreateGraphSnapshotInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# CreateGraphSnapshotInputTypeDef definition

class CreateGraphSnapshotInputTypeDef(TypedDict):
    graphIdentifier: str,
    snapshotName: str,
    tags: NotRequired[Mapping[str, str]],

CreatePrivateGraphEndpointInputTypeDef#

# CreatePrivateGraphEndpointInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreatePrivateGraphEndpointInputTypeDef


def get_value() -> CreatePrivateGraphEndpointInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# CreatePrivateGraphEndpointInputTypeDef definition

class CreatePrivateGraphEndpointInputTypeDef(TypedDict):
    graphIdentifier: str,
    vpcId: NotRequired[str],
    subnetIds: NotRequired[Sequence[str]],
    vpcSecurityGroupIds: NotRequired[Sequence[str]],

DeleteGraphInputTypeDef#

# DeleteGraphInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeleteGraphInputTypeDef


def get_value() -> DeleteGraphInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# DeleteGraphInputTypeDef definition

class DeleteGraphInputTypeDef(TypedDict):
    graphIdentifier: str,
    skipSnapshot: bool,

DeleteGraphSnapshotInputTypeDef#

# DeleteGraphSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeleteGraphSnapshotInputTypeDef


def get_value() -> DeleteGraphSnapshotInputTypeDef:
    return {
        "snapshotIdentifier": ...,
    }


# DeleteGraphSnapshotInputTypeDef definition

class DeleteGraphSnapshotInputTypeDef(TypedDict):
    snapshotIdentifier: str,

DeletePrivateGraphEndpointInputTypeDef#

# DeletePrivateGraphEndpointInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeletePrivateGraphEndpointInputTypeDef


def get_value() -> DeletePrivateGraphEndpointInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# DeletePrivateGraphEndpointInputTypeDef definition

class DeletePrivateGraphEndpointInputTypeDef(TypedDict):
    graphIdentifier: str,
    vpcId: str,

EdgeStructureTypeDef#

# EdgeStructureTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import EdgeStructureTypeDef


def get_value() -> EdgeStructureTypeDef:
    return {
        "count": ...,
    }


# EdgeStructureTypeDef definition

class EdgeStructureTypeDef(TypedDict):
    count: NotRequired[int],
    edgeProperties: NotRequired[List[str]],

ExecuteQueryInputTypeDef#

# ExecuteQueryInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExecuteQueryInputTypeDef


def get_value() -> ExecuteQueryInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ExecuteQueryInputTypeDef definition

class ExecuteQueryInputTypeDef(TypedDict):
    graphIdentifier: str,
    queryString: str,
    language: QueryLanguageType,  # (1)
    parameters: NotRequired[Mapping[str, Mapping[str, Any]]],
    planCache: NotRequired[PlanCacheTypeType],  # (2)
    explainMode: NotRequired[ExplainModeType],  # (3)
    queryTimeoutMilliseconds: NotRequired[int],
  1. See QueryLanguageType
  2. See PlanCacheTypeType
  3. See ExplainModeType

ExportFilterPropertyAttributesTypeDef#

# ExportFilterPropertyAttributesTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterPropertyAttributesTypeDef


def get_value() -> ExportFilterPropertyAttributesTypeDef:
    return {
        "outputType": ...,
    }


# ExportFilterPropertyAttributesTypeDef definition

class ExportFilterPropertyAttributesTypeDef(TypedDict):
    outputType: NotRequired[str],
    sourcePropertyName: NotRequired[str],
    multiValueHandling: NotRequired[MultiValueHandlingTypeType],  # (1)
  1. See MultiValueHandlingTypeType

ExportTaskDetailsTypeDef#

# ExportTaskDetailsTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportTaskDetailsTypeDef


def get_value() -> ExportTaskDetailsTypeDef:
    return {
        "startTime": ...,
    }


# ExportTaskDetailsTypeDef definition

class ExportTaskDetailsTypeDef(TypedDict):
    startTime: datetime.datetime,
    timeElapsedSeconds: int,
    progressPercentage: int,
    numVerticesWritten: NotRequired[int],
    numEdgesWritten: NotRequired[int],

ExportTaskSummaryTypeDef#

# ExportTaskSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportTaskSummaryTypeDef


def get_value() -> ExportTaskSummaryTypeDef:
    return {
        "graphId": ...,
    }


# ExportTaskSummaryTypeDef definition

class ExportTaskSummaryTypeDef(TypedDict):
    graphId: str,
    roleArn: str,
    taskId: str,
    status: ExportTaskStatusType,  # (1)
    format: ExportFormatType,  # (2)
    destination: str,
    kmsKeyIdentifier: str,
    parquetType: NotRequired[ParquetTypeType],  # (3)
    statusReason: NotRequired[str],
  1. See ExportTaskStatusType
  2. See ExportFormatType
  3. See ParquetTypeType

GetExportTaskInputTypeDef#

# GetExportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetExportTaskInputTypeDef


def get_value() -> GetExportTaskInputTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetExportTaskInputTypeDef definition

class GetExportTaskInputTypeDef(TypedDict):
    taskIdentifier: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import WaiterConfigTypeDef


def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }


# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetGraphInputTypeDef#

# GetGraphInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphInputTypeDef


def get_value() -> GetGraphInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetGraphInputTypeDef definition

class GetGraphInputTypeDef(TypedDict):
    graphIdentifier: str,

GetGraphSnapshotInputTypeDef#

# GetGraphSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSnapshotInputTypeDef


def get_value() -> GetGraphSnapshotInputTypeDef:
    return {
        "snapshotIdentifier": ...,
    }


# GetGraphSnapshotInputTypeDef definition

class GetGraphSnapshotInputTypeDef(TypedDict):
    snapshotIdentifier: str,

GetGraphSummaryInputTypeDef#

# GetGraphSummaryInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSummaryInputTypeDef


def get_value() -> GetGraphSummaryInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetGraphSummaryInputTypeDef definition

class GetGraphSummaryInputTypeDef(TypedDict):
    graphIdentifier: str,
    mode: NotRequired[GraphSummaryModeType],  # (1)
  1. See GraphSummaryModeType

GetImportTaskInputTypeDef#

# GetImportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetImportTaskInputTypeDef


def get_value() -> GetImportTaskInputTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetImportTaskInputTypeDef definition

class GetImportTaskInputTypeDef(TypedDict):
    taskIdentifier: str,

ImportTaskDetailsTypeDef#

# ImportTaskDetailsTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ImportTaskDetailsTypeDef


def get_value() -> ImportTaskDetailsTypeDef:
    return {
        "status": ...,
    }


# ImportTaskDetailsTypeDef definition

class ImportTaskDetailsTypeDef(TypedDict):
    status: str,
    startTime: datetime.datetime,
    timeElapsedSeconds: int,
    progressPercentage: int,
    errorCount: int,
    statementCount: int,
    dictionaryEntryCount: int,
    errorDetails: NotRequired[str],

GetPrivateGraphEndpointInputTypeDef#

# GetPrivateGraphEndpointInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetPrivateGraphEndpointInputTypeDef


def get_value() -> GetPrivateGraphEndpointInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetPrivateGraphEndpointInputTypeDef definition

class GetPrivateGraphEndpointInputTypeDef(TypedDict):
    graphIdentifier: str,
    vpcId: str,

GetQueryInputTypeDef#

# GetQueryInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetQueryInputTypeDef


def get_value() -> GetQueryInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetQueryInputTypeDef definition

class GetQueryInputTypeDef(TypedDict):
    graphIdentifier: str,
    queryId: str,

NodeStructureTypeDef#

# NodeStructureTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import NodeStructureTypeDef


def get_value() -> NodeStructureTypeDef:
    return {
        "count": ...,
    }


# NodeStructureTypeDef definition

class NodeStructureTypeDef(TypedDict):
    count: NotRequired[int],
    nodeProperties: NotRequired[List[str]],
    distinctOutgoingEdgeLabels: NotRequired[List[str]],

GraphSnapshotSummaryTypeDef#

# GraphSnapshotSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GraphSnapshotSummaryTypeDef


def get_value() -> GraphSnapshotSummaryTypeDef:
    return {
        "id": ...,
    }


# GraphSnapshotSummaryTypeDef definition

class GraphSnapshotSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    sourceGraphId: NotRequired[str],
    snapshotCreateTime: NotRequired[datetime.datetime],
    status: NotRequired[SnapshotStatusType],  # (1)
    kmsKeyIdentifier: NotRequired[str],
  1. See SnapshotStatusType

GraphSummaryTypeDef#

# GraphSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GraphSummaryTypeDef


def get_value() -> GraphSummaryTypeDef:
    return {
        "id": ...,
    }


# GraphSummaryTypeDef definition

class GraphSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: NotRequired[GraphStatusType],  # (1)
    provisionedMemory: NotRequired[int],
    publicConnectivity: NotRequired[bool],
    endpoint: NotRequired[str],
    replicaCount: NotRequired[int],
    kmsKeyIdentifier: NotRequired[str],
    deletionProtection: NotRequired[bool],
  1. See GraphStatusType

NeptuneImportOptionsTypeDef#

# NeptuneImportOptionsTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import NeptuneImportOptionsTypeDef


def get_value() -> NeptuneImportOptionsTypeDef:
    return {
        "s3ExportPath": ...,
    }


# NeptuneImportOptionsTypeDef definition

class NeptuneImportOptionsTypeDef(TypedDict):
    s3ExportPath: str,
    s3ExportKmsKeyId: str,
    preserveDefaultVertexLabels: NotRequired[bool],
    preserveEdgeIds: NotRequired[bool],

ImportTaskSummaryTypeDef#

# ImportTaskSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ImportTaskSummaryTypeDef


def get_value() -> ImportTaskSummaryTypeDef:
    return {
        "graphId": ...,
    }


# ImportTaskSummaryTypeDef definition

class ImportTaskSummaryTypeDef(TypedDict):
    taskId: str,
    source: str,
    roleArn: str,
    status: ImportTaskStatusType,  # (3)
    graphId: NotRequired[str],
    format: NotRequired[FormatType],  # (1)
    parquetType: NotRequired[ParquetTypeType],  # (2)
  1. See FormatType
  2. See ParquetTypeType
  3. See ImportTaskStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListExportTasksInputTypeDef#

# ListExportTasksInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListExportTasksInputTypeDef


def get_value() -> ListExportTasksInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListExportTasksInputTypeDef definition

class ListExportTasksInputTypeDef(TypedDict):
    graphIdentifier: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListGraphSnapshotsInputTypeDef#

# ListGraphSnapshotsInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphSnapshotsInputTypeDef


def get_value() -> ListGraphSnapshotsInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListGraphSnapshotsInputTypeDef definition

class ListGraphSnapshotsInputTypeDef(TypedDict):
    graphIdentifier: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListGraphsInputTypeDef#

# ListGraphsInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphsInputTypeDef


def get_value() -> ListGraphsInputTypeDef:
    return {
        "nextToken": ...,
    }


# ListGraphsInputTypeDef definition

class ListGraphsInputTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListImportTasksInputTypeDef#

# ListImportTasksInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListImportTasksInputTypeDef


def get_value() -> ListImportTasksInputTypeDef:
    return {
        "nextToken": ...,
    }


# ListImportTasksInputTypeDef definition

class ListImportTasksInputTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPrivateGraphEndpointsInputTypeDef#

# ListPrivateGraphEndpointsInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListPrivateGraphEndpointsInputTypeDef


def get_value() -> ListPrivateGraphEndpointsInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListPrivateGraphEndpointsInputTypeDef definition

class ListPrivateGraphEndpointsInputTypeDef(TypedDict):
    graphIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

PrivateGraphEndpointSummaryTypeDef#

# PrivateGraphEndpointSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import PrivateGraphEndpointSummaryTypeDef


def get_value() -> PrivateGraphEndpointSummaryTypeDef:
    return {
        "vpcId": ...,
    }


# PrivateGraphEndpointSummaryTypeDef definition

class PrivateGraphEndpointSummaryTypeDef(TypedDict):
    vpcId: str,
    subnetIds: List[str],
    status: PrivateGraphEndpointStatusType,  # (1)
    vpcEndpointId: NotRequired[str],
  1. See PrivateGraphEndpointStatusType

ListQueriesInputTypeDef#

# ListQueriesInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListQueriesInputTypeDef


def get_value() -> ListQueriesInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListQueriesInputTypeDef definition

class ListQueriesInputTypeDef(TypedDict):
    graphIdentifier: str,
    maxResults: int,
    state: NotRequired[QueryStateInputType],  # (1)
  1. See QueryStateInputType

QuerySummaryTypeDef#

# QuerySummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import QuerySummaryTypeDef


def get_value() -> QuerySummaryTypeDef:
    return {
        "id": ...,
    }


# QuerySummaryTypeDef definition

class QuerySummaryTypeDef(TypedDict):
    id: NotRequired[str],
    queryString: NotRequired[str],
    waited: NotRequired[int],
    elapsed: NotRequired[int],
    state: NotRequired[QueryStateType],  # (1)
  1. See QueryStateType

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    resourceArn: str,

ResetGraphInputTypeDef#

# ResetGraphInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ResetGraphInputTypeDef


def get_value() -> ResetGraphInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ResetGraphInputTypeDef definition

class ResetGraphInputTypeDef(TypedDict):
    graphIdentifier: str,
    skipSnapshot: bool,

RestoreGraphFromSnapshotInputTypeDef#

# RestoreGraphFromSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import RestoreGraphFromSnapshotInputTypeDef


def get_value() -> RestoreGraphFromSnapshotInputTypeDef:
    return {
        "snapshotIdentifier": ...,
    }


# RestoreGraphFromSnapshotInputTypeDef definition

class RestoreGraphFromSnapshotInputTypeDef(TypedDict):
    snapshotIdentifier: str,
    graphName: str,
    provisionedMemory: NotRequired[int],
    deletionProtection: NotRequired[bool],
    tags: NotRequired[Mapping[str, str]],
    replicaCount: NotRequired[int],
    publicConnectivity: NotRequired[bool],

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateGraphInputTypeDef#

# UpdateGraphInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import UpdateGraphInputTypeDef


def get_value() -> UpdateGraphInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# UpdateGraphInputTypeDef definition

class UpdateGraphInputTypeDef(TypedDict):
    graphIdentifier: str,
    publicConnectivity: NotRequired[bool],
    provisionedMemory: NotRequired[int],
    deletionProtection: NotRequired[bool],

CancelExportTaskOutputTypeDef#

# CancelExportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CancelExportTaskOutputTypeDef


def get_value() -> CancelExportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# CancelExportTaskOutputTypeDef definition

class CancelExportTaskOutputTypeDef(TypedDict):
    graphId: str,
    roleArn: str,
    taskId: str,
    status: ExportTaskStatusType,  # (1)
    format: ExportFormatType,  # (2)
    destination: str,
    kmsKeyIdentifier: str,
    parquetType: ParquetTypeType,  # (3)
    statusReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExportTaskStatusType
  2. See ExportFormatType
  3. See ParquetTypeType
  4. See ResponseMetadataTypeDef

CancelImportTaskOutputTypeDef#

# CancelImportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CancelImportTaskOutputTypeDef


def get_value() -> CancelImportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# CancelImportTaskOutputTypeDef definition

class CancelImportTaskOutputTypeDef(TypedDict):
    graphId: str,
    taskId: str,
    source: str,
    format: FormatType,  # (1)
    parquetType: ParquetTypeType,  # (2)
    roleArn: str,
    status: ImportTaskStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FormatType
  2. See ParquetTypeType
  3. See ImportTaskStatusType
  4. See ResponseMetadataTypeDef

CreateGraphSnapshotOutputTypeDef#

# CreateGraphSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphSnapshotOutputTypeDef


def get_value() -> CreateGraphSnapshotOutputTypeDef:
    return {
        "id": ...,
    }


# CreateGraphSnapshotOutputTypeDef definition

class CreateGraphSnapshotOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    sourceGraphId: str,
    snapshotCreateTime: datetime.datetime,
    status: SnapshotStatusType,  # (1)
    kmsKeyIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotStatusType
  2. See ResponseMetadataTypeDef

CreatePrivateGraphEndpointOutputTypeDef#

# CreatePrivateGraphEndpointOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreatePrivateGraphEndpointOutputTypeDef


def get_value() -> CreatePrivateGraphEndpointOutputTypeDef:
    return {
        "vpcId": ...,
    }


# CreatePrivateGraphEndpointOutputTypeDef definition

class CreatePrivateGraphEndpointOutputTypeDef(TypedDict):
    vpcId: str,
    subnetIds: List[str],
    status: PrivateGraphEndpointStatusType,  # (1)
    vpcEndpointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PrivateGraphEndpointStatusType
  2. See ResponseMetadataTypeDef

DeleteGraphSnapshotOutputTypeDef#

# DeleteGraphSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeleteGraphSnapshotOutputTypeDef


def get_value() -> DeleteGraphSnapshotOutputTypeDef:
    return {
        "id": ...,
    }


# DeleteGraphSnapshotOutputTypeDef definition

class DeleteGraphSnapshotOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    sourceGraphId: str,
    snapshotCreateTime: datetime.datetime,
    status: SnapshotStatusType,  # (1)
    kmsKeyIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotStatusType
  2. See ResponseMetadataTypeDef

DeletePrivateGraphEndpointOutputTypeDef#

# DeletePrivateGraphEndpointOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeletePrivateGraphEndpointOutputTypeDef


def get_value() -> DeletePrivateGraphEndpointOutputTypeDef:
    return {
        "vpcId": ...,
    }


# DeletePrivateGraphEndpointOutputTypeDef definition

class DeletePrivateGraphEndpointOutputTypeDef(TypedDict):
    vpcId: str,
    subnetIds: List[str],
    status: PrivateGraphEndpointStatusType,  # (1)
    vpcEndpointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PrivateGraphEndpointStatusType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExecuteQueryOutputTypeDef#

# ExecuteQueryOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExecuteQueryOutputTypeDef


def get_value() -> ExecuteQueryOutputTypeDef:
    return {
        "payload": ...,
    }


# ExecuteQueryOutputTypeDef definition

class ExecuteQueryOutputTypeDef(TypedDict):
    payload: botocore.response.StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetGraphSnapshotOutputTypeDef#

# GetGraphSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSnapshotOutputTypeDef


def get_value() -> GetGraphSnapshotOutputTypeDef:
    return {
        "id": ...,
    }


# GetGraphSnapshotOutputTypeDef definition

class GetGraphSnapshotOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    sourceGraphId: str,
    snapshotCreateTime: datetime.datetime,
    status: SnapshotStatusType,  # (1)
    kmsKeyIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotStatusType
  2. See ResponseMetadataTypeDef

GetPrivateGraphEndpointOutputTypeDef#

# GetPrivateGraphEndpointOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetPrivateGraphEndpointOutputTypeDef


def get_value() -> GetPrivateGraphEndpointOutputTypeDef:
    return {
        "vpcId": ...,
    }


# GetPrivateGraphEndpointOutputTypeDef definition

class GetPrivateGraphEndpointOutputTypeDef(TypedDict):
    vpcId: str,
    subnetIds: List[str],
    status: PrivateGraphEndpointStatusType,  # (1)
    vpcEndpointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PrivateGraphEndpointStatusType
  2. See ResponseMetadataTypeDef

GetQueryOutputTypeDef#

# GetQueryOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetQueryOutputTypeDef


def get_value() -> GetQueryOutputTypeDef:
    return {
        "id": ...,
    }


# GetQueryOutputTypeDef definition

class GetQueryOutputTypeDef(TypedDict):
    id: str,
    queryString: str,
    waited: int,
    elapsed: int,
    state: QueryStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryStateType
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGraphInputTypeDef#

# CreateGraphInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphInputTypeDef


def get_value() -> CreateGraphInputTypeDef:
    return {
        "graphName": ...,
    }


# CreateGraphInputTypeDef definition

class CreateGraphInputTypeDef(TypedDict):
    graphName: str,
    provisionedMemory: int,
    tags: NotRequired[Mapping[str, str]],
    publicConnectivity: NotRequired[bool],
    kmsKeyIdentifier: NotRequired[str],
    vectorSearchConfiguration: NotRequired[VectorSearchConfigurationTypeDef],  # (1)
    replicaCount: NotRequired[int],
    deletionProtection: NotRequired[bool],
  1. See VectorSearchConfigurationTypeDef

CreateGraphOutputTypeDef#

# CreateGraphOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphOutputTypeDef


def get_value() -> CreateGraphOutputTypeDef:
    return {
        "id": ...,
    }


# CreateGraphOutputTypeDef definition

class CreateGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

DeleteGraphOutputTypeDef#

# DeleteGraphOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import DeleteGraphOutputTypeDef


def get_value() -> DeleteGraphOutputTypeDef:
    return {
        "id": ...,
    }


# DeleteGraphOutputTypeDef definition

class DeleteGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

GetGraphOutputTypeDef#

# GetGraphOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphOutputTypeDef


def get_value() -> GetGraphOutputTypeDef:
    return {
        "id": ...,
    }


# GetGraphOutputTypeDef definition

class GetGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

ResetGraphOutputTypeDef#

# ResetGraphOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ResetGraphOutputTypeDef


def get_value() -> ResetGraphOutputTypeDef:
    return {
        "id": ...,
    }


# ResetGraphOutputTypeDef definition

class ResetGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

RestoreGraphFromSnapshotOutputTypeDef#

# RestoreGraphFromSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import RestoreGraphFromSnapshotOutputTypeDef


def get_value() -> RestoreGraphFromSnapshotOutputTypeDef:
    return {
        "id": ...,
    }


# RestoreGraphFromSnapshotOutputTypeDef definition

class RestoreGraphFromSnapshotOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

UpdateGraphOutputTypeDef#

# UpdateGraphOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import UpdateGraphOutputTypeDef


def get_value() -> UpdateGraphOutputTypeDef:
    return {
        "id": ...,
    }


# UpdateGraphOutputTypeDef definition

class UpdateGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn: str,
    status: GraphStatusType,  # (1)
    statusReason: str,
    createTime: datetime.datetime,
    provisionedMemory: int,
    endpoint: str,
    publicConnectivity: bool,
    vectorSearchConfiguration: VectorSearchConfigurationTypeDef,  # (2)
    replicaCount: int,
    kmsKeyIdentifier: str,
    sourceSnapshotId: str,
    deletionProtection: bool,
    buildNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See GraphStatusType
  2. See VectorSearchConfigurationTypeDef
  3. See ResponseMetadataTypeDef

ExportFilterElementOutputTypeDef#

# ExportFilterElementOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterElementOutputTypeDef


def get_value() -> ExportFilterElementOutputTypeDef:
    return {
        "properties": ...,
    }


# ExportFilterElementOutputTypeDef definition

class ExportFilterElementOutputTypeDef(TypedDict):
    properties: NotRequired[Dict[str, ExportFilterPropertyAttributesTypeDef]],  # (1)
  1. See Dict[str, ExportFilterPropertyAttributesTypeDef]

ExportFilterElementTypeDef#

# ExportFilterElementTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterElementTypeDef


def get_value() -> ExportFilterElementTypeDef:
    return {
        "properties": ...,
    }


# ExportFilterElementTypeDef definition

class ExportFilterElementTypeDef(TypedDict):
    properties: NotRequired[Mapping[str, ExportFilterPropertyAttributesTypeDef]],  # (1)
  1. See Mapping[str, ExportFilterPropertyAttributesTypeDef]

ListExportTasksOutputTypeDef#

# ListExportTasksOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListExportTasksOutputTypeDef


def get_value() -> ListExportTasksOutputTypeDef:
    return {
        "tasks": ...,
    }


# ListExportTasksOutputTypeDef definition

class ListExportTasksOutputTypeDef(TypedDict):
    tasks: List[ExportTaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ExportTaskSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetExportTaskInputWaitExtraTypeDef#

# GetExportTaskInputWaitExtraTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetExportTaskInputWaitExtraTypeDef


def get_value() -> GetExportTaskInputWaitExtraTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetExportTaskInputWaitExtraTypeDef definition

class GetExportTaskInputWaitExtraTypeDef(TypedDict):
    taskIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetExportTaskInputWaitTypeDef#

# GetExportTaskInputWaitTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetExportTaskInputWaitTypeDef


def get_value() -> GetExportTaskInputWaitTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetExportTaskInputWaitTypeDef definition

class GetExportTaskInputWaitTypeDef(TypedDict):
    taskIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetGraphInputWaitExtraTypeDef#

# GetGraphInputWaitExtraTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphInputWaitExtraTypeDef


def get_value() -> GetGraphInputWaitExtraTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetGraphInputWaitExtraTypeDef definition

class GetGraphInputWaitExtraTypeDef(TypedDict):
    graphIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetGraphInputWaitTypeDef#

# GetGraphInputWaitTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphInputWaitTypeDef


def get_value() -> GetGraphInputWaitTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetGraphInputWaitTypeDef definition

class GetGraphInputWaitTypeDef(TypedDict):
    graphIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetGraphSnapshotInputWaitExtraTypeDef#

# GetGraphSnapshotInputWaitExtraTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSnapshotInputWaitExtraTypeDef


def get_value() -> GetGraphSnapshotInputWaitExtraTypeDef:
    return {
        "snapshotIdentifier": ...,
    }


# GetGraphSnapshotInputWaitExtraTypeDef definition

class GetGraphSnapshotInputWaitExtraTypeDef(TypedDict):
    snapshotIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetGraphSnapshotInputWaitTypeDef#

# GetGraphSnapshotInputWaitTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSnapshotInputWaitTypeDef


def get_value() -> GetGraphSnapshotInputWaitTypeDef:
    return {
        "snapshotIdentifier": ...,
    }


# GetGraphSnapshotInputWaitTypeDef definition

class GetGraphSnapshotInputWaitTypeDef(TypedDict):
    snapshotIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetImportTaskInputWaitExtraTypeDef#

# GetImportTaskInputWaitExtraTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetImportTaskInputWaitExtraTypeDef


def get_value() -> GetImportTaskInputWaitExtraTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetImportTaskInputWaitExtraTypeDef definition

class GetImportTaskInputWaitExtraTypeDef(TypedDict):
    taskIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetImportTaskInputWaitTypeDef#

# GetImportTaskInputWaitTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetImportTaskInputWaitTypeDef


def get_value() -> GetImportTaskInputWaitTypeDef:
    return {
        "taskIdentifier": ...,
    }


# GetImportTaskInputWaitTypeDef definition

class GetImportTaskInputWaitTypeDef(TypedDict):
    taskIdentifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetPrivateGraphEndpointInputWaitExtraTypeDef#

# GetPrivateGraphEndpointInputWaitExtraTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetPrivateGraphEndpointInputWaitExtraTypeDef


def get_value() -> GetPrivateGraphEndpointInputWaitExtraTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetPrivateGraphEndpointInputWaitExtraTypeDef definition

class GetPrivateGraphEndpointInputWaitExtraTypeDef(TypedDict):
    graphIdentifier: str,
    vpcId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetPrivateGraphEndpointInputWaitTypeDef#

# GetPrivateGraphEndpointInputWaitTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetPrivateGraphEndpointInputWaitTypeDef


def get_value() -> GetPrivateGraphEndpointInputWaitTypeDef:
    return {
        "graphIdentifier": ...,
    }


# GetPrivateGraphEndpointInputWaitTypeDef definition

class GetPrivateGraphEndpointInputWaitTypeDef(TypedDict):
    graphIdentifier: str,
    vpcId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GraphDataSummaryTypeDef#

# GraphDataSummaryTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GraphDataSummaryTypeDef


def get_value() -> GraphDataSummaryTypeDef:
    return {
        "numNodes": ...,
    }


# GraphDataSummaryTypeDef definition

class GraphDataSummaryTypeDef(TypedDict):
    numNodes: NotRequired[int],
    numEdges: NotRequired[int],
    numNodeLabels: NotRequired[int],
    numEdgeLabels: NotRequired[int],
    nodeLabels: NotRequired[List[str]],
    edgeLabels: NotRequired[List[str]],
    numNodeProperties: NotRequired[int],
    numEdgeProperties: NotRequired[int],
    nodeProperties: NotRequired[List[Dict[str, int]]],
    edgeProperties: NotRequired[List[Dict[str, int]]],
    totalNodePropertyValues: NotRequired[int],
    totalEdgePropertyValues: NotRequired[int],
    nodeStructures: NotRequired[List[NodeStructureTypeDef]],  # (1)
    edgeStructures: NotRequired[List[EdgeStructureTypeDef]],  # (2)
  1. See List[NodeStructureTypeDef]
  2. See List[EdgeStructureTypeDef]

ListGraphSnapshotsOutputTypeDef#

# ListGraphSnapshotsOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphSnapshotsOutputTypeDef


def get_value() -> ListGraphSnapshotsOutputTypeDef:
    return {
        "graphSnapshots": ...,
    }


# ListGraphSnapshotsOutputTypeDef definition

class ListGraphSnapshotsOutputTypeDef(TypedDict):
    graphSnapshots: List[GraphSnapshotSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[GraphSnapshotSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListGraphsOutputTypeDef#

# ListGraphsOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphsOutputTypeDef


def get_value() -> ListGraphsOutputTypeDef:
    return {
        "graphs": ...,
    }


# ListGraphsOutputTypeDef definition

class ListGraphsOutputTypeDef(TypedDict):
    graphs: List[GraphSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[GraphSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ImportOptionsTypeDef#

# ImportOptionsTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ImportOptionsTypeDef


def get_value() -> ImportOptionsTypeDef:
    return {
        "neptune": ...,
    }


# ImportOptionsTypeDef definition

class ImportOptionsTypeDef(TypedDict):
    neptune: NotRequired[NeptuneImportOptionsTypeDef],  # (1)
  1. See NeptuneImportOptionsTypeDef

ListImportTasksOutputTypeDef#

# ListImportTasksOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListImportTasksOutputTypeDef


def get_value() -> ListImportTasksOutputTypeDef:
    return {
        "tasks": ...,
    }


# ListImportTasksOutputTypeDef definition

class ListImportTasksOutputTypeDef(TypedDict):
    tasks: List[ImportTaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ImportTaskSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListExportTasksInputPaginateTypeDef#

# ListExportTasksInputPaginateTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListExportTasksInputPaginateTypeDef


def get_value() -> ListExportTasksInputPaginateTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListExportTasksInputPaginateTypeDef definition

class ListExportTasksInputPaginateTypeDef(TypedDict):
    graphIdentifier: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGraphSnapshotsInputPaginateTypeDef#

# ListGraphSnapshotsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphSnapshotsInputPaginateTypeDef


def get_value() -> ListGraphSnapshotsInputPaginateTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListGraphSnapshotsInputPaginateTypeDef definition

class ListGraphSnapshotsInputPaginateTypeDef(TypedDict):
    graphIdentifier: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGraphsInputPaginateTypeDef#

# ListGraphsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListGraphsInputPaginateTypeDef


def get_value() -> ListGraphsInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListGraphsInputPaginateTypeDef definition

class ListGraphsInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListImportTasksInputPaginateTypeDef#

# ListImportTasksInputPaginateTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListImportTasksInputPaginateTypeDef


def get_value() -> ListImportTasksInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListImportTasksInputPaginateTypeDef definition

class ListImportTasksInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPrivateGraphEndpointsInputPaginateTypeDef#

# ListPrivateGraphEndpointsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListPrivateGraphEndpointsInputPaginateTypeDef


def get_value() -> ListPrivateGraphEndpointsInputPaginateTypeDef:
    return {
        "graphIdentifier": ...,
    }


# ListPrivateGraphEndpointsInputPaginateTypeDef definition

class ListPrivateGraphEndpointsInputPaginateTypeDef(TypedDict):
    graphIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPrivateGraphEndpointsOutputTypeDef#

# ListPrivateGraphEndpointsOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListPrivateGraphEndpointsOutputTypeDef


def get_value() -> ListPrivateGraphEndpointsOutputTypeDef:
    return {
        "privateGraphEndpoints": ...,
    }


# ListPrivateGraphEndpointsOutputTypeDef definition

class ListPrivateGraphEndpointsOutputTypeDef(TypedDict):
    privateGraphEndpoints: List[PrivateGraphEndpointSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[PrivateGraphEndpointSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListQueriesOutputTypeDef#

# ListQueriesOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ListQueriesOutputTypeDef


def get_value() -> ListQueriesOutputTypeDef:
    return {
        "queries": ...,
    }


# ListQueriesOutputTypeDef definition

class ListQueriesOutputTypeDef(TypedDict):
    queries: List[QuerySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[QuerySummaryTypeDef]
  2. See ResponseMetadataTypeDef

ExportFilterOutputTypeDef#

# ExportFilterOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterOutputTypeDef


def get_value() -> ExportFilterOutputTypeDef:
    return {
        "vertexFilter": ...,
    }


# ExportFilterOutputTypeDef definition

class ExportFilterOutputTypeDef(TypedDict):
    vertexFilter: NotRequired[Dict[str, ExportFilterElementOutputTypeDef]],  # (1)
    edgeFilter: NotRequired[Dict[str, ExportFilterElementOutputTypeDef]],  # (1)
  1. See Dict[str, ExportFilterElementOutputTypeDef]
  2. See Dict[str, ExportFilterElementOutputTypeDef]

ExportFilterTypeDef#

# ExportFilterTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import ExportFilterTypeDef


def get_value() -> ExportFilterTypeDef:
    return {
        "vertexFilter": ...,
    }


# ExportFilterTypeDef definition

class ExportFilterTypeDef(TypedDict):
    vertexFilter: NotRequired[Mapping[str, ExportFilterElementTypeDef]],  # (1)
    edgeFilter: NotRequired[Mapping[str, ExportFilterElementTypeDef]],  # (1)
  1. See Mapping[str, ExportFilterElementTypeDef]
  2. See Mapping[str, ExportFilterElementTypeDef]

GetGraphSummaryOutputTypeDef#

# GetGraphSummaryOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetGraphSummaryOutputTypeDef


def get_value() -> GetGraphSummaryOutputTypeDef:
    return {
        "version": ...,
    }


# GetGraphSummaryOutputTypeDef definition

class GetGraphSummaryOutputTypeDef(TypedDict):
    version: str,
    lastStatisticsComputationTime: datetime.datetime,
    graphSummary: GraphDataSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GraphDataSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateGraphUsingImportTaskInputTypeDef#

# CreateGraphUsingImportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphUsingImportTaskInputTypeDef


def get_value() -> CreateGraphUsingImportTaskInputTypeDef:
    return {
        "graphName": ...,
    }


# CreateGraphUsingImportTaskInputTypeDef definition

class CreateGraphUsingImportTaskInputTypeDef(TypedDict):
    graphName: str,
    source: str,
    roleArn: str,
    tags: NotRequired[Mapping[str, str]],
    publicConnectivity: NotRequired[bool],
    kmsKeyIdentifier: NotRequired[str],
    vectorSearchConfiguration: NotRequired[VectorSearchConfigurationTypeDef],  # (1)
    replicaCount: NotRequired[int],
    deletionProtection: NotRequired[bool],
    importOptions: NotRequired[ImportOptionsTypeDef],  # (2)
    maxProvisionedMemory: NotRequired[int],
    minProvisionedMemory: NotRequired[int],
    failOnError: NotRequired[bool],
    format: NotRequired[FormatType],  # (3)
    parquetType: NotRequired[ParquetTypeType],  # (4)
    blankNodeHandling: NotRequired[BlankNodeHandlingType],  # (5)
  1. See VectorSearchConfigurationTypeDef
  2. See ImportOptionsTypeDef
  3. See FormatType
  4. See ParquetTypeType
  5. See BlankNodeHandlingType

CreateGraphUsingImportTaskOutputTypeDef#

# CreateGraphUsingImportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import CreateGraphUsingImportTaskOutputTypeDef


def get_value() -> CreateGraphUsingImportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# CreateGraphUsingImportTaskOutputTypeDef definition

class CreateGraphUsingImportTaskOutputTypeDef(TypedDict):
    graphId: str,
    taskId: str,
    source: str,
    format: FormatType,  # (1)
    parquetType: ParquetTypeType,  # (2)
    roleArn: str,
    status: ImportTaskStatusType,  # (3)
    importOptions: ImportOptionsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See FormatType
  2. See ParquetTypeType
  3. See ImportTaskStatusType
  4. See ImportOptionsTypeDef
  5. See ResponseMetadataTypeDef

GetImportTaskOutputTypeDef#

# GetImportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetImportTaskOutputTypeDef


def get_value() -> GetImportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# GetImportTaskOutputTypeDef definition

class GetImportTaskOutputTypeDef(TypedDict):
    graphId: str,
    taskId: str,
    source: str,
    format: FormatType,  # (1)
    parquetType: ParquetTypeType,  # (2)
    roleArn: str,
    status: ImportTaskStatusType,  # (3)
    importOptions: ImportOptionsTypeDef,  # (4)
    importTaskDetails: ImportTaskDetailsTypeDef,  # (5)
    attemptNumber: int,
    statusReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See FormatType
  2. See ParquetTypeType
  3. See ImportTaskStatusType
  4. See ImportOptionsTypeDef
  5. See ImportTaskDetailsTypeDef
  6. See ResponseMetadataTypeDef

StartImportTaskInputTypeDef#

# StartImportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import StartImportTaskInputTypeDef


def get_value() -> StartImportTaskInputTypeDef:
    return {
        "source": ...,
    }


# StartImportTaskInputTypeDef definition

class StartImportTaskInputTypeDef(TypedDict):
    source: str,
    graphIdentifier: str,
    roleArn: str,
    importOptions: NotRequired[ImportOptionsTypeDef],  # (1)
    failOnError: NotRequired[bool],
    format: NotRequired[FormatType],  # (2)
    parquetType: NotRequired[ParquetTypeType],  # (3)
    blankNodeHandling: NotRequired[BlankNodeHandlingType],  # (4)
  1. See ImportOptionsTypeDef
  2. See FormatType
  3. See ParquetTypeType
  4. See BlankNodeHandlingType

StartImportTaskOutputTypeDef#

# StartImportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import StartImportTaskOutputTypeDef


def get_value() -> StartImportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# StartImportTaskOutputTypeDef definition

class StartImportTaskOutputTypeDef(TypedDict):
    graphId: str,
    taskId: str,
    source: str,
    format: FormatType,  # (1)
    parquetType: ParquetTypeType,  # (2)
    roleArn: str,
    status: ImportTaskStatusType,  # (3)
    importOptions: ImportOptionsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See FormatType
  2. See ParquetTypeType
  3. See ImportTaskStatusType
  4. See ImportOptionsTypeDef
  5. See ResponseMetadataTypeDef

GetExportTaskOutputTypeDef#

# GetExportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import GetExportTaskOutputTypeDef


def get_value() -> GetExportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# GetExportTaskOutputTypeDef definition

class GetExportTaskOutputTypeDef(TypedDict):
    graphId: str,
    roleArn: str,
    taskId: str,
    status: ExportTaskStatusType,  # (1)
    format: ExportFormatType,  # (2)
    destination: str,
    kmsKeyIdentifier: str,
    parquetType: ParquetTypeType,  # (3)
    statusReason: str,
    exportTaskDetails: ExportTaskDetailsTypeDef,  # (4)
    exportFilter: ExportFilterOutputTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See ExportTaskStatusType
  2. See ExportFormatType
  3. See ParquetTypeType
  4. See ExportTaskDetailsTypeDef
  5. See ExportFilterOutputTypeDef
  6. See ResponseMetadataTypeDef

StartExportTaskOutputTypeDef#

# StartExportTaskOutputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import StartExportTaskOutputTypeDef


def get_value() -> StartExportTaskOutputTypeDef:
    return {
        "graphId": ...,
    }


# StartExportTaskOutputTypeDef definition

class StartExportTaskOutputTypeDef(TypedDict):
    graphId: str,
    roleArn: str,
    taskId: str,
    status: ExportTaskStatusType,  # (1)
    format: ExportFormatType,  # (2)
    destination: str,
    kmsKeyIdentifier: str,
    parquetType: ParquetTypeType,  # (3)
    statusReason: str,
    exportFilter: ExportFilterOutputTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ExportTaskStatusType
  2. See ExportFormatType
  3. See ParquetTypeType
  4. See ExportFilterOutputTypeDef
  5. See ResponseMetadataTypeDef

StartExportTaskInputTypeDef#

# StartExportTaskInputTypeDef TypedDict usage example

from mypy_boto3_neptune_graph.type_defs import StartExportTaskInputTypeDef


def get_value() -> StartExportTaskInputTypeDef:
    return {
        "graphIdentifier": ...,
    }


# StartExportTaskInputTypeDef definition

class StartExportTaskInputTypeDef(TypedDict):
    graphIdentifier: str,
    roleArn: str,
    format: ExportFormatType,  # (1)
    destination: str,
    kmsKeyIdentifier: str,
    parquetType: NotRequired[ParquetTypeType],  # (2)
    exportFilter: NotRequired[ExportFilterUnionTypeDef],  # (3)
    tags: NotRequired[Mapping[str, str]],
  1. See ExportFormatType
  2. See ParquetTypeType
  3. See ExportFilterUnionTypeDef