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
Usage
Code samples can be found in Examples.
NeptuneClient
Type annotations and code completion for boto3.client("neptune")
as NeptuneClient
boto3 documentation
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("...")
.
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("...")
.
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 schemas.
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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_neptune.type_defs import AddRoleToDBClusterMessageRequestTypeDef
def get_value() -> AddRoleToDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"RoleArn": ...,
}
- AddRoleToDBClusterMessageRequestTypeDef
- AddSourceIdentifierToSubscriptionMessageRequestTypeDef
- EventSubscriptionTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- ApplyPendingMaintenanceActionMessageRequestTypeDef
- AvailabilityZoneTypeDef
- CharacterSetTypeDef
- CloudwatchLogsExportConfigurationTypeDef
- 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
- DescribeGlobalClustersMessageRequestTypeDef
- DescribeValidDBInstanceModificationsMessageRequestTypeDef
- DoubleRangeTypeDef
- EventCategoriesMapTypeDef
- EventTypeDef
- FailoverDBClusterMessageRequestTypeDef
- FailoverGlobalClusterMessageRequestTypeDef
- GlobalClusterMemberTypeDef
- ModifyDBClusterEndpointMessageRequestTypeDef
- ModifyDBClusterSnapshotAttributeMessageRequestTypeDef
- ModifyDBSubnetGroupMessageRequestTypeDef
- ModifyEventSubscriptionMessageRequestTypeDef
- ModifyGlobalClusterMessageRequestTypeDef
- PendingCloudwatchLogsExportsTypeDef
- PendingMaintenanceActionTypeDef
- PromoteReadReplicaDBClusterMessageRequestTypeDef
- RangeTypeDef
- RebootDBInstanceMessageRequestTypeDef
- RemoveFromGlobalClusterMessageRequestTypeDef
- RemoveRoleFromDBClusterMessageRequestTypeDef
- RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef
- RemoveTagsFromResourceMessageRequestTypeDef
- StartDBClusterMessageRequestTypeDef
- StopDBClusterMessageRequestTypeDef
- AddSourceIdentifierToSubscriptionResultTypeDef
- CreateDBClusterEndpointOutputTypeDef
- CreateEventSubscriptionResultTypeDef
- DBClusterParameterGroupNameMessageTypeDef
- DBParameterGroupNameMessageTypeDef
- DeleteDBClusterEndpointOutputTypeDef
- DeleteEventSubscriptionResultTypeDef
- EmptyResponseMetadataTypeDef
- EventSubscriptionsMessageTypeDef
- ModifyDBClusterEndpointOutputTypeDef
- ModifyEventSubscriptionResultTypeDef
- RemoveSourceIdentifierFromSubscriptionResultTypeDef
- AddTagsToResourceMessageRequestTypeDef
- CopyDBClusterParameterGroupMessageRequestTypeDef
- CopyDBClusterSnapshotMessageRequestTypeDef
- CopyDBParameterGroupMessageRequestTypeDef
- CreateDBClusterEndpointMessageRequestTypeDef
- CreateDBClusterParameterGroupMessageRequestTypeDef
- CreateDBClusterSnapshotMessageRequestTypeDef
- CreateDBInstanceMessageRequestTypeDef
- CreateDBParameterGroupMessageRequestTypeDef
- CreateDBSubnetGroupMessageRequestTypeDef
- CreateEventSubscriptionMessageRequestTypeDef
- TagListMessageTypeDef
- OrderableDBInstanceOptionTypeDef
- SubnetTypeDef
- ModifyDBInstanceMessageRequestTypeDef
- CopyDBClusterParameterGroupResultTypeDef
- CreateDBClusterParameterGroupResultTypeDef
- DBClusterParameterGroupsMessageTypeDef
- CopyDBClusterSnapshotResultTypeDef
- CreateDBClusterSnapshotResultTypeDef
- DBClusterSnapshotMessageTypeDef
- DeleteDBClusterSnapshotResultTypeDef
- CopyDBParameterGroupResultTypeDef
- CreateDBParameterGroupResultTypeDef
- DBParameterGroupsMessageTypeDef
- CreateDBClusterMessageRequestTypeDef
- ModifyDBClusterMessageRequestTypeDef
- RestoreDBClusterFromSnapshotMessageRequestTypeDef
- RestoreDBClusterToPointInTimeMessageRequestTypeDef
- DBClusterEndpointMessageTypeDef
- DBClusterParameterGroupDetailsTypeDef
- DBParameterGroupDetailsTypeDef
- EngineDefaultsTypeDef
- ModifyDBClusterParameterGroupMessageRequestTypeDef
- ModifyDBParameterGroupMessageRequestTypeDef
- ResetDBClusterParameterGroupMessageRequestTypeDef
- ResetDBParameterGroupMessageRequestTypeDef
- DBClusterSnapshotAttributesResultTypeDef
- DBClusterTypeDef
- DBEngineVersionTypeDef
- DescribeDBClusterEndpointsMessageRequestTypeDef
- DescribeDBClusterParameterGroupsMessageRequestTypeDef
- DescribeDBClusterParametersMessageRequestTypeDef
- DescribeDBClusterSnapshotsMessageRequestTypeDef
- DescribeDBClustersMessageRequestTypeDef
- DescribeDBEngineVersionsMessageRequestTypeDef
- DescribeDBInstancesMessageRequestTypeDef
- DescribeDBParameterGroupsMessageRequestTypeDef
- DescribeDBParametersMessageRequestTypeDef
- DescribeDBSubnetGroupsMessageRequestTypeDef
- DescribeEngineDefaultClusterParametersMessageRequestTypeDef
- DescribeEngineDefaultParametersMessageRequestTypeDef
- DescribeEventCategoriesMessageRequestTypeDef
- DescribeEventSubscriptionsMessageRequestTypeDef
- DescribeEventsMessageRequestTypeDef
- DescribeOrderableDBInstanceOptionsMessageRequestTypeDef
- DescribePendingMaintenanceActionsMessageRequestTypeDef
- ListTagsForResourceMessageRequestTypeDef
- DescribeDBClusterEndpointsMessageDescribeDBClusterEndpointsPaginateTypeDef
- DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef
- DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef
- DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef
- DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef
- DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef
- DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef
- DescribeDBParameterGroupsMessageDescribeDBParameterGroupsPaginateTypeDef
- DescribeDBParametersMessageDescribeDBParametersPaginateTypeDef
- DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef
- DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef
- DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef
- DescribeEventsMessageDescribeEventsPaginateTypeDef
- DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef
- DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef
- DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef
- DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef
- DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef
- EventCategoriesMessageTypeDef
- EventsMessageTypeDef
- GlobalClusterTypeDef
- PendingModifiedValuesTypeDef
- ResourcePendingMaintenanceActionsTypeDef
- ValidStorageOptionsTypeDef
- OrderableDBInstanceOptionsMessageTypeDef
- DBSubnetGroupTypeDef
- DescribeEngineDefaultClusterParametersResultTypeDef
- DescribeEngineDefaultParametersResultTypeDef
- DescribeDBClusterSnapshotAttributesResultTypeDef
- ModifyDBClusterSnapshotAttributeResultTypeDef
- CreateDBClusterResultTypeDef
- DBClusterMessageTypeDef
- DeleteDBClusterResultTypeDef
- FailoverDBClusterResultTypeDef
- ModifyDBClusterResultTypeDef
- PromoteReadReplicaDBClusterResultTypeDef
- RestoreDBClusterFromSnapshotResultTypeDef
- RestoreDBClusterToPointInTimeResultTypeDef
- StartDBClusterResultTypeDef
- StopDBClusterResultTypeDef
- DBEngineVersionMessageTypeDef
- CreateGlobalClusterResultTypeDef
- DeleteGlobalClusterResultTypeDef
- FailoverGlobalClusterResultTypeDef
- GlobalClustersMessageTypeDef
- ModifyGlobalClusterResultTypeDef
- RemoveFromGlobalClusterResultTypeDef
- ApplyPendingMaintenanceActionResultTypeDef
- PendingMaintenanceActionsMessageTypeDef
- ValidDBInstanceModificationsMessageTypeDef
- CreateDBSubnetGroupResultTypeDef
- DBInstanceTypeDef
- DBSubnetGroupMessageTypeDef
- ModifyDBSubnetGroupResultTypeDef
- DescribeValidDBInstanceModificationsResultTypeDef
- CreateDBInstanceResultTypeDef
- DBInstanceMessageTypeDef
- DeleteDBInstanceResultTypeDef
- ModifyDBInstanceResultTypeDef
- RebootDBInstanceResultTypeDef