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.000s · 116.6MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 5.8s · import 0.000s · 114MB
114MB installed
● package 114MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
PipesClient
✓ from mypy_boto3_pipes.client import PipesClient
Use this for explicit type hinting of the boto3 EventBridgePipes client.
EventBridgePipesServiceName
✓ from mypy_boto3_pipes.literals import EventBridgePipesServiceName
Provides a literal type for the service name 'pipes' for stricter type checking.
PipeStateTypeDef
✓ from mypy_boto3_pipes.type_defs import PipeStateTypeDef
Provides type definitions for service-specific structures (e.g., input/output dictionaries).
This quickstart demonstrates how to initialize a `boto3` client for EventBridge Pipes with type hints from `mypy-boto3-pipes` and perform a simple `list_pipes` operation. The `TYPE_CHECKING` block ensures that `mypy-boto3-pipes` is only a development dependency.
import boto3
import os
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_pipes.client import PipesClient
from mypy_boto3_pipes.type_defs import ListPipesResponseTypeDef
# Ensure boto3 is configured, e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION
# For this example, we'll just create a client.
# In a real application, ensure credentials are set up (e.g., via environment variables or ~/.aws/credentials)
def get_pipes_client() -> 'PipesClient':
# The explicit type annotation here (PipesClient) enables type checking and autocompletion
client: PipesClient = boto3.client(
"pipes",
aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'DUMMY_KEY'),
aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'DUMMY_SECRET'),
region_name=os.environ.get('AWS_REGION', 'us-east-1')
)
return client
def list_eventbridge_pipes():
pipes_client = get_pipes_client()
try:
response: ListPipesResponseTypeDef = pipes_client.list_pipes(
MaxResults=5
)
print("Successfully listed pipes:")
for pipe in response.get('Pipes', []):
print(f" Pipe Name: {pipe.get('Name')}, State: {pipe.get('State')}")
except Exception as e:
print(f"Error listing pipes: {e}")
if __name__ == "__main__":
list_eventbridge_pipes()
Debug
Known issues
breakingSupport for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0, which generates these stubs. Ensure your environment uses Python 3.9 or higher.fixUpgrade Python to 3.9 or newer.
affects: >=8.12.0 of mypy-boto3-builder (impacts mypy-boto3-pipes versions generated by it)
breakingTypeDef names were shortened in `mypy-boto3-builder` 8.9.0 (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). If you manually import TypeDefs, their names might have changed.fixReview your explicit `from mypy_boto3_pipes.type_defs import ...` statements and adjust to the new, shorter names if applicable.
affects: >=8.9.0 of mypy-boto3-builder
gotchaThis library provides only type stubs. You must install `boto3` (the actual AWS SDK) separately for your code to run. `mypy-boto3-pipes` provides no runtime functionality.fixEnsure `pip install boto3` is part of your project's dependencies.
affects: All versions
gotchaThe version of `mypy-boto3-pipes` should ideally match the major and minor version of your installed `boto3` library for full compatibility and accurate type hints.fixPeriodically update `mypy-boto3-pipes` along with `boto3` to maintain type accuracy. Check the `mypy-boto3` documentation for versioning guidance.
affects: All versions
gotchaFor production environments, it is recommended to wrap imports of `mypy-boto3` stubs within `if TYPE_CHECKING:` blocks to prevent them from becoming runtime dependencies.fixUse `from typing import TYPE_CHECKING` and conditionally import stubs: `if TYPE_CHECKING: from mypy_boto3_pipes.client import PipesClient`.
affects: All versions
gotchaUsers of PyCharm may experience slow performance or high CPU usage due to `Literal` overloads. Consider using `mypy-boto3-pipes-lite` or an external type checker like Mypy/Pyright.fixInstall `mypy-boto3-pipes-lite` instead, or disable PyCharm's internal type checker and use Mypy/Pyright.
affects: All versions with PyCharm
Upgrade
Version history
1.43.0latest on PyPI · released Apr 29, 2026
Audit
Dependencies
boto3requiredProvides the core AWS SDK runtime that these stubs type-check.
mypyoptionalRequired to perform static type checking with these stubs.