Registry /
type-stubs / mypy-boto3-imagebuilder
Install & Compatibility
Where this runs
tested against v1.43.37 · 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.700s · 52.4MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 4.0s · import 0.650s · 53MB
51MB installed
● package 51MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ImagebuilderClient
✓ from mypy_boto3_imagebuilder.client import ImagebuilderClient
ImageStateTypeDef
✓ from mypy_boto3_imagebuilder.type_defs import ImageStateTypeDef
✗ from mypy_boto3_imagebuilder.service_resource import ImageStateTypeDef
Type definitions (like 'TypeDef' suffixed types) are found in `type_defs`, not `service_resource` or `client` modules.
This quickstart demonstrates how to instantiate a type-hinted AWS Imagebuilder client using `boto3` and `mypy-boto3-imagebuilder` stubs. It then performs a `list_images` operation and accesses typed response data, showcasing how the stubs provide autocompletion and static type validation for client methods and response structures.
import boto3
from mypy_boto3_imagebuilder.client import ImagebuilderClient
from mypy_boto3_imagebuilder.type_defs import ImageSummaryTypeDef
# Instantiate a typed client
client: ImagebuilderClient = boto3.client("imagebuilder")
# Use the client with type-checking benefits
try:
response = client.list_images(filters=[
{
'name': 'name',
'values': ['example-image-name']
}
])
print(f"Found {len(response.get('imageSummaryList', []))} images.")
# Example of accessing a typed item
if response.get('imageSummaryList'):
first_image: ImageSummaryTypeDef = response['imageSummaryList'][0]
print(f"First image ARN: {first_image['arn']}")
except client.exceptions.ClientError as e:
print(f"An AWS error occurred: {e}")
except Exception as e:
print(f"An unexpected error occurred: {e}")
Debug
Known issues
breakingSupport for Python 3.8 has been removed. All `mypy-boto3` packages, including `mypy-boto3-imagebuilder`, now require Python 3.9 or newer.fixUpgrade your Python environment to 3.9 or newer.
affects: >=8.12.0 of `mypy-boto3-builder` generated packages
breakingPackages have migrated to PEP 561, which changes how `mypy` and other type checkers discover stub files. While generally backwards compatible, specific `mypy` configurations or custom stub paths might need adjustment.fixEnsure your `mypy` configuration correctly points to your virtual environment or site-packages. Reinstalling the stubs might resolve discovery issues if encountered.
affects: >=8.12.0 of `mypy-boto3-builder` generated packages
breakingSpecific `TypeDef` names for method arguments and conflicting definitions were shortened or renamed, potentially breaking code that explicitly referenced these type definitions.fixConsult the `mypy-boto3-builder` release notes for version 8.9.0 or higher, and update your code to use the new `TypeDef` names where applicable (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
affects: >=8.9.0 of `mypy-boto3-builder` generated packages
gotcha`mypy-boto3-imagebuilder` provides type stubs only. It is not a standalone library and requires `boto3` and `botocore` to be installed for runtime functionality.fixAlways install `boto3` and `botocore` alongside `mypy-boto3-imagebuilder` (e.g., `pip install mypy-boto3-imagebuilder boto3 botocore`).
affects: All versions
gotchaFor optimal type-checking accuracy, the version of `mypy-boto3-imagebuilder` should ideally match the major and minor version of your installed `boto3` library.fixPeriodically update `mypy-boto3-imagebuilder` to match your `boto3` version (e.g., `pip install --upgrade mypy-boto3-imagebuilder`).
affects: All versions
Upgrade
Version history
1.43.37latest on PyPI · released Jun 29, 2026
Audit
Dependencies
boto3requiredRuntime dependency for the AWS SDK for Python, which these stubs type-check.
botocorerequiredCore dependency for boto3, providing fundamental types and functionality.