NeptuneGraph module#
Index > NeptuneGraph
Auto-generated documentation for NeptuneGraph type annotations stubs module mypy-boto3-neptune-graph.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and NeptuneGraph
.
From PyPI with pip#
Install boto3-stubs
for NeptuneGraph
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[neptune-graph]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[neptune-graph]'
# standalone installation
python -m pip install mypy-boto3-neptune-graph
How to uninstall#
python -m pip uninstall -y mypy-boto3-neptune-graph
Usage#
Code samples can be found in Examples.
NeptuneGraphClient#
Type annotations and code completion for boto3.client("neptune-graph")
as NeptuneGraphClient
boto3 documentation
# NeptuneGraphClient usage example
from boto3.session import Session
from mypy_boto3_neptune_graph.client import NeptuneGraphClient
def get_client() -> NeptuneGraphClient:
return Session().client("neptune-graph")
Paginators#
Type annotations and code completion for paginators
from boto3.client("neptune-graph").get_paginator("...")
.
# ListGraphSnapshotsPaginator usage example
from boto3.session import Session
from mypy_boto3_neptune_graph.paginator import ListGraphSnapshotsPaginator
def get_list_graph_snapshots_paginator() -> ListGraphSnapshotsPaginator:
return Session().client("neptune-graph").get_paginator("list_graph_snapshots"))
- ListGraphSnapshotsPaginator
- ListGraphsPaginator
- ListImportTasksPaginator
- ListPrivateGraphEndpointsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("neptune-graph").get_waiter("...")
.
# GraphAvailableWaiter usage example
from boto3.session import Session
from mypy_boto3_neptune_graph.waiter import GraphAvailableWaiter
def get_graph_available_waiter() -> GraphAvailableWaiter:
return Session().client("neptune-graph").get_waiter("graph_available")
- GraphAvailableWaiter
- GraphDeletedWaiter
- GraphSnapshotAvailableWaiter
- GraphSnapshotDeletedWaiter
- ImportTaskCancelledWaiter
- ImportTaskSuccessfulWaiter
- PrivateGraphEndpointAvailableWaiter
- PrivateGraphEndpointDeletedWaiter
Literals#
Type annotations for literals used in methods and schema.
# BlankNodeHandlingType usage example
from mypy_boto3_neptune_graph.literals import BlankNodeHandlingType
def get_value() -> BlankNodeHandlingType:
return "convertToIri"
- BlankNodeHandlingType
- ExplainModeType
- FormatType
- GraphAvailableWaiterName
- GraphDeletedWaiterName
- GraphSnapshotAvailableWaiterName
- GraphSnapshotDeletedWaiterName
- GraphStatusType
- GraphSummaryModeType
- ImportTaskCancelledWaiterName
- ImportTaskStatusType
- ImportTaskSuccessfulWaiterName
- ListGraphSnapshotsPaginatorName
- ListGraphsPaginatorName
- ListImportTasksPaginatorName
- ListPrivateGraphEndpointsPaginatorName
- PlanCacheTypeType
- PrivateGraphEndpointAvailableWaiterName
- PrivateGraphEndpointDeletedWaiterName
- PrivateGraphEndpointStatusType
- QueryLanguageType
- QueryStateInputType
- QueryStateType
- SnapshotStatusType
- NeptuneGraphServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
Type definitions#
Type annotations for type definitions used in methods and schema.
- CancelImportTaskInputRequestTypeDef
- ResponseMetadataTypeDef
- CancelQueryInputRequestTypeDef
- VectorSearchConfigurationTypeDef
- CreateGraphSnapshotInputRequestTypeDef
- CreatePrivateGraphEndpointInputRequestTypeDef
- DeleteGraphInputRequestTypeDef
- DeleteGraphSnapshotInputRequestTypeDef
- DeletePrivateGraphEndpointInputRequestTypeDef
- EdgeStructureTypeDef
- ExecuteQueryInputRequestTypeDef
- WaiterConfigTypeDef
- GetGraphInputRequestTypeDef
- GetGraphSnapshotInputRequestTypeDef
- GetGraphSummaryInputRequestTypeDef
- GetImportTaskInputRequestTypeDef
- ImportTaskDetailsTypeDef
- GetPrivateGraphEndpointInputRequestTypeDef
- GetQueryInputRequestTypeDef
- NodeStructureTypeDef
- GraphSnapshotSummaryTypeDef
- GraphSummaryTypeDef
- NeptuneImportOptionsTypeDef
- ImportTaskSummaryTypeDef
- PaginatorConfigTypeDef
- ListGraphSnapshotsInputRequestTypeDef
- ListGraphsInputRequestTypeDef
- ListImportTasksInputRequestTypeDef
- ListPrivateGraphEndpointsInputRequestTypeDef
- PrivateGraphEndpointSummaryTypeDef
- ListQueriesInputRequestTypeDef
- QuerySummaryTypeDef
- ListTagsForResourceInputRequestTypeDef
- ResetGraphInputRequestTypeDef
- RestoreGraphFromSnapshotInputRequestTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateGraphInputRequestTypeDef
- CancelImportTaskOutputTypeDef
- CreateGraphSnapshotOutputTypeDef
- CreatePrivateGraphEndpointOutputTypeDef
- DeleteGraphSnapshotOutputTypeDef
- DeletePrivateGraphEndpointOutputTypeDef
- EmptyResponseMetadataTypeDef
- ExecuteQueryOutputTypeDef
- GetGraphSnapshotOutputTypeDef
- GetPrivateGraphEndpointOutputTypeDef
- GetQueryOutputTypeDef
- ListTagsForResourceOutputTypeDef
- CreateGraphInputRequestTypeDef
- CreateGraphOutputTypeDef
- DeleteGraphOutputTypeDef
- GetGraphOutputTypeDef
- ResetGraphOutputTypeDef
- RestoreGraphFromSnapshotOutputTypeDef
- UpdateGraphOutputTypeDef
- GetGraphInputGraphAvailableWaitTypeDef
- GetGraphInputGraphDeletedWaitTypeDef
- GetGraphSnapshotInputGraphSnapshotAvailableWaitTypeDef
- GetGraphSnapshotInputGraphSnapshotDeletedWaitTypeDef
- GetImportTaskInputImportTaskCancelledWaitTypeDef
- GetImportTaskInputImportTaskSuccessfulWaitTypeDef
- GetPrivateGraphEndpointInputPrivateGraphEndpointAvailableWaitTypeDef
- GetPrivateGraphEndpointInputPrivateGraphEndpointDeletedWaitTypeDef
- GraphDataSummaryTypeDef
- ListGraphSnapshotsOutputTypeDef
- ListGraphsOutputTypeDef
- ImportOptionsTypeDef
- ListImportTasksOutputTypeDef
- ListGraphSnapshotsInputListGraphSnapshotsPaginateTypeDef
- ListGraphsInputListGraphsPaginateTypeDef
- ListImportTasksInputListImportTasksPaginateTypeDef
- ListPrivateGraphEndpointsInputListPrivateGraphEndpointsPaginateTypeDef
- ListPrivateGraphEndpointsOutputTypeDef
- ListQueriesOutputTypeDef
- GetGraphSummaryOutputTypeDef
- CreateGraphUsingImportTaskInputRequestTypeDef
- CreateGraphUsingImportTaskOutputTypeDef
- GetImportTaskOutputTypeDef
- StartImportTaskInputRequestTypeDef
- StartImportTaskOutputTypeDef