Install & Compatibility
Where this runs
tested against v1.43.23 · 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.604s · 52MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 3.9s · import 0.552s · 52MB
50MB installed
● package 50MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
EFSClient
✓ from mypy_boto3_efs.client import EFSClient
✗ from mypy_boto3_efs import EFSClient
Client types are typically nested under the 'client' submodule.
CreateFileSystemRequestRequestTypeDef
✓ from mypy_boto3_efs.type_defs import CreateFileSystemRequestRequestTypeDef
✗ from mypy_boto3_efs import CreateFileSystemRequestRequestTypeDef
All TypeDef objects are located in the 'type_defs' submodule.
This example demonstrates how to use `mypy-boto3-efs` to get type hints for `boto3.client('efs')`. It defines a function to create an EFS file system, explicitly typing the client and the request parameters. Note that `mypy-boto3-efs` provides *only* type stubs; `boto3` must be installed and configured for actual AWS interactions.
import boto3
from mypy_boto3_efs.client import EFSClient
from mypy_boto3_efs.type_defs import CreateFileSystemRequestRequestTypeDef
import os
# Ensure boto3 can find credentials (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or ~/.aws/credentials)
# This example does not explicitly set credentials, relying on default boto3 behavior.
def create_efs_filesystem(token: str) -> None:
client: EFSClient = boto3.client(
"efs",
region_name=os.environ.get('AWS_REGION', 'us-east-1')
)
request_params: CreateFileSystemRequestRequestTypeDef = {
"CreationToken": token,
"PerformanceMode": "generalPurpose",
"Encrypted": False # Set to True for encryption
}
try:
response = client.create_file_system(**request_params)
print(f"Created EFS File System with ID: {response['FileSystemId']}")
print(f"ARN: {response['FileSystemArn']}")
except client.exceptions.FileSystemAlreadyExists as e:
print(f"File system with token '{token}' already exists: {e}")
except Exception as e:
print(f"Error creating file system: {e}")
# Example usage (replace with a unique token for actual creation)
# create_efs_filesystem("my-unique-efs-token")
print("Run 'create_efs_filesystem("my-unique-efs-token")' to test")
Debug
Known issues
breakingPython 3.8 is no longer supported. `mypy-boto3-builder` version 8.12.0 (and subsequent versions which generate `mypy-boto3-efs` 1.42.3+) removed support for Python 3.8. Ensure your environment uses Python 3.9 or newer.fixUpgrade your Python environment to 3.9 or a later version.
affects: mypy-boto3-efs >=1.42.3 (generated by builder >=8.12.0)
gotchaThese packages provide only type stubs. They do not replace `boto3`. You must install both `boto3` and the `mypy-boto3-efs` package to get full type checking alongside runtime functionality.fixAlways install both `boto3` and `mypy-boto3-efs` (e.g., `pip install boto3 mypy-boto3-efs`).
affects: All versions
breakingTypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0. This can affect code that directly references generated TypeDefs, potentially shortening names like `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`. While `mypy-boto3-efs` might not have many double-suffixed types, it's a general builder change.fixReview and update explicit TypeDef references in your code if they relied on older naming conventions.
affects: mypy-boto3-efs versions generated by builder >=8.9.0
breakingMigration to PEP 561 packages in `mypy-boto3-builder` 8.12.0. This changes how stubs are packaged and discovered by MyPy (using `py.typed` marker files). While generally backward compatible, custom build systems or highly specific `mypy` configurations might need adjustment.fixEnsure your `mypy` configuration is standard and recognizes PEP 561 packages. Most users won't need to change anything unless using esoteric build setups.
affects: mypy-boto3-efs >=1.42.3 (generated by builder >=8.12.0)
Upgrade
Version history
1.43.23latest on PyPI · released Jun 4, 2026
Audit
Dependencies
boto3requiredProvides runtime functionality; `mypy-boto3-efs` only offers type stubs for it.