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.95 runs
installs and imports cleanly · install 0.0s · import 0.664s · 52.4MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.9s · import 0.618s · 53MB
51MB installed
● package 51MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ProtonClient
✓ from mypy_boto3_proton.client import ProtonClient
Paginator
✓ from mypy_boto3_proton.paginator import ListComponentsPaginator
Paginators are specific to list operations, e.g., ListComponentsPaginator.
TypeDefs
✓ from mypy_boto3_proton.type_defs import CreateEnvironmentInputRequestTypeDef
Type definitions are available in the `type_defs` module.
This quickstart demonstrates how to initialize a `boto3` client and apply `mypy-boto3-proton` type hints to enable static analysis for AWS Proton operations, then lists environments.
import boto3
from mypy_boto3_proton.client import ProtonClient
from mypy_boto3_proton.type_defs import ListEnvironmentsOutputTypeDef
# Ensure boto3 is installed: pip install boto3
# Ensure stubs are installed: pip install mypy-boto3-proton
def get_proton_environments(client: ProtonClient) -> ListEnvironmentsOutputTypeDef:
"""Lists Proton environments using a type-hinted client."""
response = client.list_environments()
return response
if __name__ == "__main__":
# Initialize a boto3 client (region may vary)
# Use a region where Proton is available, e.g., 'us-west-2'
boto3_client = boto3.client("proton", region_name="us-west-2")
# Type-hint the boto3 client with mypy-boto3-proton's Client
proton_client: ProtonClient = boto3_client
print("Listing Proton environments:")
try:
environments_data = get_proton_environments(proton_client)
for env in environments_data.get("environments", []):
print(f" Environment: {env['name']} ({env['arn']}) - {env['provisioning']}")
except Exception as e:
print(f"An error occurred: {e}")
print("Please ensure you have AWS credentials configured and Proton is available in 'us-west-2'.")
Debug
Known issues
breakingSupport for Python 3.8 was removed with the underlying `mypy-boto3-builder` version 8.12.0. Projects using `mypy-boto3` stubs will now require Python 3.9 or newer.fixUpgrade your Python environment to 3.9 or newer.
affects: mypy-boto3-builder >=8.12.0
breakingThe `mypy-boto3-builder` (version 8.12.0) migrated to the PEP 561 package format. While generally seamless, if you have custom `mypy` configurations or non-standard module resolution, this change *could* impact stub discovery.fixVerify `mypy` continues to correctly resolve imports. Ensure `mypy-boto3-proton` is installed in a standard location.
affects: mypy-boto3-builder >=8.12.0
breakingIn `mypy-boto3-builder` version 8.9.0, TypeDef names for packed method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`). If you explicitly import these TypeDefs, your code may break upon upgrading.fixReview and update explicit `TypeDef` imports in your codebase according to the new naming conventions.
affects: mypy-boto3-builder >=8.9.0
gotchaThis package provides only type stubs for `boto3`. The actual `boto3` library must be installed and available at runtime for your code to function.fixEnsure `pip install boto3` is part of your project's dependencies.
affects: All versions
gotchaFor optimal type checking, it's crucial to align `mypy-boto3-proton`'s version with your `boto3` version. Mismatched versions can lead to incorrect type hints, missing attributes, or `mypy` errors if service APIs differ.fixRegularly update `mypy-boto3-proton` alongside `boto3`. For example, if `boto3` is `1.x.y`, install `mypy-boto3-proton` `1.x.y`.
affects: All versions
Upgrade
Version history
1.43.0latest on PyPI · released Apr 29, 2026
Audit
Dependencies
boto3requiredRuntime dependency for AWS SDK functionality; mypy-boto3-proton provides only type stubs.