Neptune module#
Index > Neptune
Auto-generated documentation for Neptune type annotations stubs module mypy-boto3-neptune.
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 Neptune
.
From PyPI with pip#
Install boto3-stubs
for Neptune
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[neptune]'
# 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]'
# standalone installation
python -m pip install mypy-boto3-neptune
How to uninstall#
python -m pip uninstall -y mypy-boto3-neptune
Usage#
Code samples can be found in Examples.
NeptuneClient#
Type annotations and code completion for boto3.client("neptune")
as NeptuneClient
boto3 documentation
# NeptuneClient usage example
from boto3.session import Session
from mypy_boto3_neptune.client import NeptuneClient
def get_client() -> NeptuneClient:
return Session().client("neptune")
Paginators#
Type annotations and code completion for paginators
from boto3.client("neptune").get_paginator("...")
.
# DescribeDBClusterEndpointsPaginator usage example
from boto3.session import Session
from mypy_boto3_neptune.paginator import DescribeDBClusterEndpointsPaginator
def get_describe_db_cluster_endpoints_paginator() -> DescribeDBClusterEndpointsPaginator:
return Session().client("neptune").get_paginator("describe_db_cluster_endpoints"))
- DescribeDBClusterEndpointsPaginator
- DescribeDBClusterParameterGroupsPaginator
- DescribeDBClusterParametersPaginator
- DescribeDBClusterSnapshotsPaginator
- DescribeDBClustersPaginator
- DescribeDBEngineVersionsPaginator
- DescribeDBInstancesPaginator
- DescribeDBParameterGroupsPaginator
- DescribeDBParametersPaginator
- DescribeDBSubnetGroupsPaginator
- DescribeEngineDefaultParametersPaginator
- DescribeEventSubscriptionsPaginator
- DescribeEventsPaginator
- DescribeGlobalClustersPaginator
- DescribeOrderableDBInstanceOptionsPaginator
- DescribePendingMaintenanceActionsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("neptune").get_waiter("...")
.
# DBInstanceAvailableWaiter usage example
from boto3.session import Session
from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter
def get_db_instance_available_waiter() -> DBInstanceAvailableWaiter:
return Session().client("neptune").get_waiter("db_instance_available")
Literals#
Type annotations for literals used in methods and schema.
# ApplyMethodType usage example
from mypy_boto3_neptune.literals import ApplyMethodType
def get_value() -> ApplyMethodType:
return "immediate"
- ApplyMethodType
- DBInstanceAvailableWaiterName
- DBInstanceDeletedWaiterName
- DescribeDBClusterEndpointsPaginatorName
- DescribeDBClusterParameterGroupsPaginatorName
- DescribeDBClusterParametersPaginatorName
- DescribeDBClusterSnapshotsPaginatorName
- DescribeDBClustersPaginatorName
- DescribeDBEngineVersionsPaginatorName
- DescribeDBInstancesPaginatorName
- DescribeDBParameterGroupsPaginatorName
- DescribeDBParametersPaginatorName
- DescribeDBSubnetGroupsPaginatorName
- DescribeEngineDefaultParametersPaginatorName
- DescribeEventSubscriptionsPaginatorName
- DescribeEventsPaginatorName
- DescribeGlobalClustersPaginatorName
- DescribeOrderableDBInstanceOptionsPaginatorName
- DescribePendingMaintenanceActionsPaginatorName
- SourceTypeType
- NeptuneServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AddRoleToDBClusterMessageRequestTypeDef
- AddSourceIdentifierToSubscriptionMessageRequestTypeDef
- EventSubscriptionTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- ApplyPendingMaintenanceActionMessageRequestTypeDef
- AvailabilityZoneTypeDef
- CharacterSetTypeDef
- CloudwatchLogsExportConfigurationTypeDef
- PendingCloudwatchLogsExportsTypeDef
- DBClusterParameterGroupTypeDef
- DBClusterSnapshotTypeDef
- DBParameterGroupTypeDef
- ServerlessV2ScalingConfigurationTypeDef
- CreateGlobalClusterMessageRequestTypeDef
- DBClusterEndpointTypeDef
- DBClusterMemberTypeDef
- DBClusterOptionGroupStatusTypeDef
- ParameterTypeDef
- DBClusterRoleTypeDef
- DBClusterSnapshotAttributeTypeDef
- ServerlessV2ScalingConfigurationInfoTypeDef
- VpcSecurityGroupMembershipTypeDef
- TimezoneTypeDef
- UpgradeTargetTypeDef
- DBInstanceStatusInfoTypeDef
- DBParameterGroupStatusTypeDef
- DBSecurityGroupMembershipTypeDef
- DomainMembershipTypeDef
- EndpointTypeDef
- OptionGroupMembershipTypeDef
- DeleteDBClusterEndpointMessageRequestTypeDef
- DeleteDBClusterMessageRequestTypeDef
- DeleteDBClusterParameterGroupMessageRequestTypeDef
- DeleteDBClusterSnapshotMessageRequestTypeDef
- DeleteDBInstanceMessageRequestTypeDef
- DeleteDBParameterGroupMessageRequestTypeDef
- DeleteDBSubnetGroupMessageRequestTypeDef
- DeleteEventSubscriptionMessageRequestTypeDef
- DeleteGlobalClusterMessageRequestTypeDef
- FilterTypeDef
- PaginatorConfigTypeDef
- DescribeDBClusterSnapshotAttributesMessageRequestTypeDef
- WaiterConfigTypeDef
- TimestampTypeDef
- DescribeGlobalClustersMessageRequestTypeDef
- DescribeValidDBInstanceModificationsMessageRequestTypeDef
- DoubleRangeTypeDef
- EventCategoriesMapTypeDef
- EventTypeDef
- FailoverDBClusterMessageRequestTypeDef
- FailoverGlobalClusterMessageRequestTypeDef
- GlobalClusterMemberTypeDef