Skip to content

Type definitions#

Index > NeptuneGraph > Type definitions

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

CancelImportTaskInputRequestTypeDef#

# CancelImportTaskInputRequestTypeDef definition

class CancelImportTaskInputRequestTypeDef(TypedDict):
    taskIdentifier: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CancelQueryInputRequestTypeDef#

# CancelQueryInputRequestTypeDef definition

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

VectorSearchConfigurationTypeDef#

# VectorSearchConfigurationTypeDef definition

class VectorSearchConfigurationTypeDef(TypedDict):
    dimension: int,

CreateGraphSnapshotInputRequestTypeDef#

# CreateGraphSnapshotInputRequestTypeDef definition

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

CreatePrivateGraphEndpointInputRequestTypeDef#

# CreatePrivateGraphEndpointInputRequestTypeDef definition

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

DeleteGraphInputRequestTypeDef#

# DeleteGraphInputRequestTypeDef definition

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

DeleteGraphSnapshotInputRequestTypeDef#

# DeleteGraphSnapshotInputRequestTypeDef definition

class DeleteGraphSnapshotInputRequestTypeDef(TypedDict):
    snapshotIdentifier: str,

DeletePrivateGraphEndpointInputRequestTypeDef#

# DeletePrivateGraphEndpointInputRequestTypeDef definition

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

EdgeStructureTypeDef#

# EdgeStructureTypeDef definition

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

ExecuteQueryInputRequestTypeDef#

# ExecuteQueryInputRequestTypeDef definition

class ExecuteQueryInputRequestTypeDef(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

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

GetGraphInputRequestTypeDef#

# GetGraphInputRequestTypeDef definition

class GetGraphInputRequestTypeDef(TypedDict):
    graphIdentifier: str,

GetGraphSnapshotInputRequestTypeDef#

# GetGraphSnapshotInputRequestTypeDef definition

class GetGraphSnapshotInputRequestTypeDef(TypedDict):
    snapshotIdentifier: str,

GetGraphSummaryInputRequestTypeDef#

# GetGraphSummaryInputRequestTypeDef definition

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

GetImportTaskInputRequestTypeDef#

# GetImportTaskInputRequestTypeDef definition

class GetImportTaskInputRequestTypeDef(TypedDict):
    taskIdentifier: str,

ImportTaskDetailsTypeDef#

# ImportTaskDetailsTypeDef definition

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

GetPrivateGraphEndpointInputRequestTypeDef#

# GetPrivateGraphEndpointInputRequestTypeDef definition

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

GetQueryInputRequestTypeDef#

# GetQueryInputRequestTypeDef definition

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

NodeStructureTypeDef#

# NodeStructureTypeDef definition

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

GraphSnapshotSummaryTypeDef#

# GraphSnapshotSummaryTypeDef definition

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

GraphSummaryTypeDef#

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

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

ImportTaskSummaryTypeDef#

# ImportTaskSummaryTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListGraphSnapshotsInputRequestTypeDef#

# ListGraphSnapshotsInputRequestTypeDef definition

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

ListGraphsInputRequestTypeDef#

# ListGraphsInputRequestTypeDef definition

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

ListImportTasksInputRequestTypeDef#

# ListImportTasksInputRequestTypeDef definition

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

ListPrivateGraphEndpointsInputRequestTypeDef#

# ListPrivateGraphEndpointsInputRequestTypeDef definition

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

PrivateGraphEndpointSummaryTypeDef#

# PrivateGraphEndpointSummaryTypeDef definition

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

ListQueriesInputRequestTypeDef#

# ListQueriesInputRequestTypeDef definition

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

QuerySummaryTypeDef#

# QuerySummaryTypeDef definition

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

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

ResetGraphInputRequestTypeDef#

# ResetGraphInputRequestTypeDef definition

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

RestoreGraphFromSnapshotInputRequestTypeDef#

# RestoreGraphFromSnapshotInputRequestTypeDef definition

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

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

UpdateGraphInputRequestTypeDef#

# UpdateGraphInputRequestTypeDef definition

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

CancelImportTaskOutputTypeDef#

# CancelImportTaskOutputTypeDef definition

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

CreateGraphSnapshotOutputTypeDef#

# CreateGraphSnapshotOutputTypeDef definition

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

CreatePrivateGraphEndpointOutputTypeDef#

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

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

DeletePrivateGraphEndpointOutputTypeDef#

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

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

ExecuteQueryOutputTypeDef#

# ExecuteQueryOutputTypeDef definition

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

GetGraphSnapshotOutputTypeDef#

# GetGraphSnapshotOutputTypeDef definition

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

GetPrivateGraphEndpointOutputTypeDef#

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

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

CreateGraphInputRequestTypeDef#

# CreateGraphInputRequestTypeDef definition

class CreateGraphInputRequestTypeDef(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 definition

class CreateGraphOutputTypeDef(TypedDict):
    id: str,
    name: str,
    arn