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.616s · 52MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.8s · import 0.586s · 53MB
50MB installed
● package 50MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
SupplyChainClient
✓ from mypy_boto3_supplychain.client import SupplyChainClient
✗ import boto3; client = boto3.client('supplychain')
While `boto3.client('supplychain')` works at runtime, type checkers need the explicit `SupplyChainClient` import for full static analysis and auto-completion.
ListDataIntegrationFlowsOutputTypeDef
✓ from mypy_boto3_supplychain.type_defs import ListDataIntegrationFlowsOutputTypeDef
Type definitions (TypedDicts) for API response objects are found in `type_defs`.
This example demonstrates how to use `mypy-boto3-supplychain` for type-hinting a boto3 SupplyChain client and its response. The `TYPE_CHECKING` guard ensures that `mypy-boto3` is only a development dependency. It retrieves and prints data integration flows.
import boto3
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_supplychain.client import SupplyChainClient
from mypy_boto3_supplychain.type_defs import ListDataIntegrationFlowsOutputTypeDef
def get_supply_chain_flows() -> ListDataIntegrationFlowsOutputTypeDef:
# boto3 client creation is untyped at runtime, hence the type hint below
client: SupplyChainClient = boto3.client("supplychain")
response = client.list_data_integration_flows()
print(f"Found {len(response.get('dataIntegrationFlows', []))} data integration flows.")
return response
if __name__ == "__main__":
# Ensure AWS credentials are configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY env vars)
# or AWS CLI configuration.
try:
flows = get_supply_chain_flows()
# Accessing typed properties
for flow in flows.get('dataIntegrationFlows', []):
print(f" Flow ID: {flow['dataIntegrationFlowId']}, Status: {flow['status']}")
except Exception as e:
print(f"An error occurred: {e}")
print("Please ensure 'boto3' is installed and AWS credentials are configured.")
Debug
Known issues
breakingSupport for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and subsequent `mypy-boto3-*` packages. Projects targeting Python 3.8 will no longer receive updates or new type stubs.fixUpgrade your project's Python version to 3.9 or newer. Ensure your `requires_python` is set appropriately.
affects: mypy-boto3-builder >= 8.12.0
breakingStarting with `mypy-boto3-builder` 8.9.0, there were breaking changes to `TypeDef` naming conventions. Specifically, packed method arguments may use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `TypeDef` 'Extra' postfixes were moved to the end.fixReview your `type_defs` imports and usage to align with the new naming conventions. Static type checkers will highlight affected areas.
affects: mypy-boto3-builder >= 8.9.0
gotchaFor optimal static analysis and IDE auto-completion (especially in VSCode), explicit type annotations for `boto3.client` and `boto3.resource` calls are often recommended, even though `mypy-boto3` attempts auto-discovery. PyCharm users might experience slow performance with `Literal` overloads, in which case `boto3-stubs-lite` or external type checkers like MyPy/Pyright are suggested.fixApply explicit type hints as shown in the quickstart (e.g., `client: SupplyChainClient = boto3.client(...)`). For PyCharm performance, consider `boto3-stubs-lite` or relying on external type checking.
affects: All versions
gotchaTo prevent `mypy-boto3-*` packages from becoming runtime dependencies, it is best practice to wrap all imports of types from these libraries within a `if typing.TYPE_CHECKING:` block. This ensures they are only used during static analysis.fixEnclose type stub imports like `from mypy_boto3_supplychain.client import SupplyChainClient` within `if TYPE_CHECKING:` conditional blocks.
affects: All versions
Upgrade
Version history
1.43.0latest on PyPI · released Apr 29, 2026
Audit
Dependencies
boto3requiredThis package provides type stubs for the 'boto3' library, which is a runtime dependency.
pythonrequiredRequires Python 3.9 or newer.