Install & Compatibility
Where this runs
tested against v1.43.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.915 runs
installs and imports cleanly · install 0.0s · import 0.000s · 18.3MB
glibcpy 3.10–3.915 runs
installs and imports cleanly · install 3.0s · import 0.000s · 216MB
143MB installed
● package 143MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
NeptuneDataClient
✓ from mypy_boto3_neptunedata import NeptuneDataClient
✗ from mypy_boto3_neptunedata import NeptuneDataClient
This quickstart demonstrates how to initialize a type-hinted `boto3` client for the NeptuneData service and use it with type-safe operations. It highlights how response structures are automatically typed, allowing for static analysis by `mypy`. Remember that `boto3` itself needs to be installed, and AWS credentials configured for actual execution.
import boto3
from mypy_boto3_neptunedata.client import NeptuneDataClient
from mypy_boto3_neptunedata.type_defs import (
ListGremlinQueriesOutputTypeDef,
GremlinQueryStatusTypeDef
)
import os
def get_neptune_query_status() -> ListGremlinQueriesOutputTypeDef:
"""
Demonstrates using typed boto3 client for NeptuneData service.
Requires 'boto3' and 'mypy-boto3-neptunedata' installed.
"""
# Create a typed NeptuneData client
client: NeptuneDataClient = boto3.client(
"neptunedata",
region_name=os.environ.get("AWS_REGION", "us-east-1")
)
# Example: List active Gremlin queries
# The return type will be correctly inferred as ListGremlinQueriesOutputTypeDef
response = client.list_gremlin_queries(
includeWaitingQueries=True
)
# Type checking ensures correct access to dictionary keys and values
for query in response.get("queries", []):
status: GremlinQueryStatusTypeDef = query.get("status")
query_id: str = query.get("queryId")
print(f"Query ID: {query_id}, Status: {status}")
return response
# To type-check this code, run `mypy your_script.py`
# To run this code, ensure AWS credentials are configured for your environment.
# if __name__ == "__main__":
# try:
# result = get_neptune_query_status()
# print(f"Listed {len(result.get('queries', []))} queries.")
# except Exception as e:
# print(f"Error calling NeptuneData: {e}")
Debug
Known issues
breakingSupport for Python 3.8 was removed. Projects requiring type annotations for `boto3` will need to upgrade to Python 3.9 or newer.fixUpgrade your Python environment to 3.9 or higher. For older Python versions, use an older `mypy-boto3-neptunedata` release (e.g., from builder < 8.12.0).
affects: mypy-boto3-builder >= 8.12.0 (and packages generated by it, including mypy-boto3-neptunedata 1.42.x)
breakingThe builder migrated to PEP 561 compliant packages. While beneficial, this might impact how `mypy` or other tooling discovers and processes these stubs if they relied on specific older package structures or `mypy` configurations.fixEnsure your `mypy` and environment are up-to-date. If issues arise, verify `mypy`'s `package_data` or `namespace_packages` configuration.
affects: mypy-boto3-builder >= 8.12.0
breakingTypeDefs for packed method arguments use shorter names if possible, and conflicting TypeDef `Extra` postfix moved to the end. This can break code that directly imported or referenced these specific TypeDef names.fixReview your code for direct imports of specific `*_RequestTypeDef` or `*_ExtraRequestTypeDef` names and adjust to the new naming conventions if they clash. Consult the generated stub files for the correct names.
affects: mypy-boto3-builder >= 8.9.0
gotchaThis library provides type stubs only. You must also install the `boto3` runtime library for your application to function at runtime. `mypy-boto3-neptunedata` is not a replacement for `boto3`.fixEnsure `pip install boto3` is part of your project's dependencies.
affects: All versions
gotchaFor optimal type checking accuracy, the `mypy-boto3-neptunedata` package version should ideally align closely with your installed `boto3` version. Significant version mismatches can lead to incorrect type hints due to API differences.fixRegularly update both `boto3` and `mypy-boto3-neptunedata` to their latest compatible versions. The `mypy-boto3` documentation often provides guidance on version compatibility.
affects: All versions
Upgrade
Version history
1.43.0latest on PyPI · released Apr 29, 2026
Audit
Dependencies
boto3requiredThis library provides type stubs for boto3; boto3 itself is required at runtime for your application.
typing-extensionsoptionalMay be a transitive dependency or explicitly required by the builder for compatibility with older Python versions.