NeptuneGraph module#
Index > NeptuneGraph
Auto-generated documentation for NeptuneGraph type annotations stubs module types-boto3-neptune-graph.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
NeptuneGraph
service. - Use provided commands to install generated packages.
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 types-boto3
for NeptuneGraph
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[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 'types-boto3-lite[neptune-graph]'
# standalone installation
python -m pip install types-boto3-neptune-graph
How to uninstall#
python -m pip uninstall -y types-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 types_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("...")
.
# ListExportTasksPaginator usage example
from boto3.session import Session
from types_boto3_neptune_graph.paginator import ListExportTasksPaginator
def get_list_export_tasks_paginator() -> ListExportTasksPaginator:
return Session().client("neptune-graph").get_paginator("list_export_tasks"))
- ListExportTasksPaginator
- ListGraphSnapshotsPaginator
- ListGraphsPaginator
- ListImportTasksPaginator
- ListPrivateGraphEndpointsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("neptune-graph").get_waiter("...")
.
# ExportTaskCancelledWaiter usage example
from boto3.session import Session
from types_boto3_neptune_graph.waiter import ExportTaskCancelledWaiter
def get_export_task_cancelled_waiter() -> ExportTaskCancelledWaiter:
return Session().client("neptune-graph").get_waiter("export_task_cancelled")
- ExportTaskCancelledWaiter
- ExportTaskSuccessfulWaiter
- GraphAvailableWaiter
- GraphDeletedWaiter
- GraphSnapshotAvailableWaiter
- GraphSnapshotDeletedWaiter
- ImportTaskCancelledWaiter
- ImportTaskSuccessfulWaiter
- PrivateGraphEndpointAvailableWaiter
- PrivateGraphEndpointDeletedWaiter
Literals#
Type annotations for literals used in methods and schema.
# BlankNodeHandlingType usage example
from types_boto3_neptune_graph.literals import BlankNodeHandlingType
def get_value() -> BlankNodeHandlingType:
return "convertToIri"
- BlankNodeHandlingType
- ExplainModeType
- ExportFormatType
- ExportTaskCancelledWaiterName
- ExportTaskStatusType
- ExportTaskSuccessfulWaiterName
- FormatType
- GraphAvailableWaiterName
- GraphDeletedWaiterName
- GraphSnapshotAvailableWaiterName
- GraphSnapshotDeletedWaiterName
- GraphStatusType
- GraphSummaryModeType
- ImportTaskCancelledWaiterName
- ImportTaskStatusType
- ImportTaskSuccessfulWaiterName
- ListExportTasksPaginatorName
- ListGraphSnapshotsPaginatorName
- ListGraphsPaginatorName
- ListImportTasksPaginatorName
- ListPrivateGraphEndpointsPaginatorName
- MultiValueHandlingTypeType
- ParquetTypeType
- 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.
- CancelExportTaskInputRequestTypeDef
- ResponseMetadataTypeDef
- CancelImportTaskInputRequestTypeDef
- CancelQueryInputRequestTypeDef
- VectorSearchConfigurationTypeDef
- CreateGraphSnapshotInputRequestTypeDef
- CreatePrivateGraphEndpointInputRequestTypeDef
- DeleteGraphInputRequestTypeDef
- DeleteGraphSnapshotInputRequestTypeDef
- DeletePrivateGraphEndpointInputRequestTypeDef
- EdgeStructureTypeDef
- ExecuteQueryInputRequestTypeDef
- ExportFilterPropertyAttributesTypeDef
- ExportTaskDetailsTypeDef
- ExportTaskSummaryTypeDef
- GetExportTaskInputRequestTypeDef
- WaiterConfigTypeDef
- GetGraphInputRequestTypeDef
- GetGraphSnapshotInputRequestTypeDef
- GetGraphSummaryInputRequestTypeDef
- GetImportTaskInputRequestTypeDef
- ImportTaskDetailsTypeDef
- GetPrivateGraphEndpointInputRequestTypeDef
- GetQueryInputRequestTypeDef
- NodeStructureTypeDef
- GraphSnapshotSummaryTypeDef
- GraphSummaryTypeDef
- NeptuneImportOptionsTypeDef
- ImportTaskSummaryTypeDef
- PaginatorConfigTypeDef
- ListExportTasksInputRequestTypeDef
- ListGraphSnapshotsInputRequestTypeDef
- ListGraphsInputRequestTypeDef
- ListImportTasksInputRequestTypeDef
- ListPrivateGraphEndpointsInputRequestTypeDef
- PrivateGraphEndpointSummaryTypeDef
- ListQueriesInputRequestTypeDef
- QuerySummaryTypeDef
- ListTagsForResourceInputRequestTypeDef
- ResetGraphInputRequestTypeDef
- RestoreGraphFromSnapshotInputRequestTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateGraphInputRequestTypeDef
- CancelExportTaskOutputTypeDef
- CancelImportTaskOutputTypeDef
- CreateGraphSnapshotOutputTypeDef
- CreatePrivateGraphEndpointOutputTypeDef
- DeleteGraphSnapshotOutputTypeDef
- DeletePrivateGraphEndpointOutputTypeDef
- EmptyResponseMetadataTypeDef
- ExecuteQueryOutputTypeDef
- GetGraphSnapshotOutputTypeDef
- GetPrivateGraphEndpointOutputTypeDef
- GetQueryOutputTypeDef
- ListTagsForResourceOutputTypeDef
- CreateGraphInputRequestTypeDef
- CreateGraphOutputTypeDef
- DeleteGraphOutputTypeDef
- GetGraphOutputTypeDef
- ResetGraphOutputTypeDef
- RestoreGraphFromSnapshotOutputTypeDef
- UpdateGraphOutputTypeDef
- ExportFilterElementOutputTypeDef
- ExportFilterElementTypeDef
- ListExportTasksOutputTypeDef
- GetExportTaskInputWaitTypeDef
- GetGraphInputWaitTypeDef
- GetGraphSnapshotInputWaitTypeDef
- GetImportTaskInputWaitTypeDef
- GetPrivateGraphEndpointInputWaitTypeDef
- GraphDataSummaryTypeDef
- ListGraphSnapshotsOutputTypeDef
- ListGraphsOutputTypeDef
- ImportOptionsTypeDef
- ListImportTasksOutputTypeDef
- ListExportTasksInputPaginateTypeDef
- ListGraphSnapshotsInputPaginateTypeDef
- ListGraphsInputPaginateTypeDef
- ListImportTasksInputPaginateTypeDef
- ListPrivateGraphEndpointsInputPaginateTypeDef
- ListPrivateGraphEndpointsOutputTypeDef
- ListQueriesOutputTypeDef
- ExportFilterOutputTypeDef
- ExportFilterElementUnionTypeDef
- GetGraphSummaryOutputTypeDef
- CreateGraphUsingImportTaskInputRequestTypeDef
- CreateGraphUsingImportTaskOutputTypeDef
- GetImportTaskOutputTypeDef
- StartImportTaskInputRequestTypeDef
- StartImportTaskOutputTypeDef
- GetExportTaskOutputTypeDef
- StartExportTaskOutputTypeDef
- ExportFilterTypeDef
- StartExportTaskInputRequestTypeDef