Registry / type-stubs / mypy-boto3-synthetics

mypy-boto3-synthetics

library1.43.45pypypi✓ verified 23d ago

mypy-boto3-synthetics provides comprehensive type annotations for the AWS Synthetics service within the boto3 library. It enables static type checking with tools like MyPy and Pyright, enhancing developer experience with features such as auto-completion and early bug detection in IDEs like VSCode and PyCharm. The package, currently at version 1.42.3, is generated by mypy-boto3-builder and is actively maintained, with updates often aligned with boto3 releases.

type-stubs aws

pip install mypy-boto3-synthetics

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · MYPY-BOTO3-SYNTHET

mypy-boto3-synthetics

type-stubspythonv1.43.45

Install

3.4s avg

Import

—

Disk

18MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.43.45 · 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

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.000s · 19.7MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 3.4s · import 0.000s · 20MB

18MB installed

● package 18MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SyntheticsClient

✓ from mypy_boto3_synthetics import SyntheticsClient

✗ from mypy_boto3_synthetics import SyntheticsClient

This quickstart demonstrates how to obtain a type-hinted AWS Synthetics client and use it to call an API method (e.g., `get_canary`). Explicit type annotations are shown for clarity and to ensure full type checking capabilities.

import boto3 from mypy_boto3_synthetics.client import SyntheticsClient from mypy_boto3_synthetics.type_defs import GetCanaryResponseTypeDef def get_synthetics_client() -> SyntheticsClient: """Returns a type-hinted AWS Synthetics client.""" session = boto3.Session() client: SyntheticsClient = session.client("synthetics") return client if __name__ == "__main__": synthetics_client = get_synthetics_client() try: canary_name = "my-test-canary" response: GetCanaryResponseTypeDef = synthetics_client.get_canary(Name=canary_name) print(f"Successfully retrieved canary '{canary_name}':") print(response) except synthetics_client.exceptions.NotFoundException: print(f"Canary '{canary_name}' not found.") except Exception as e: print(f"An error occurred: {e}")

Debug

Known issues

breakingStarting with mypy-boto3-builder 8.12.0 (which generated mypy-boto3-synthetics 1.42.3), Python 3.8 is no longer supported. Projects must use Python 3.9 or newer.

fix

Upgrade your Python environment to 3.9 or a later version. Update your `requires_python` in `pyproject.toml` or `setup.py`.

affects: mypy-boto3-synthetics >=1.42.3, mypy-boto3-builder >=8.12.0

breakingmypy-boto3-builder 8.9.0 introduced breaking changes to TypeDef naming conventions, making names shorter (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). If you manually referenced these types, your code might break.

fix

Review and update `TypedDict` references in your code to match the new, shorter naming conventions provided by the stubs. Consult the specific service's `type_defs.pyi` for correct names.

affects: mypy-boto3-synthetics >=1.38.0 (generated by builder 8.9.0)

gotchaThe mypy-boto3 ecosystem migrated to PEP 561-compliant packages with builder 8.12.0. This change might require explicit installation of `mypy-boto3-synthetics` or `boto3-stubs[synthetics]` to ensure type checkers properly discover and use the stubs.

fix

Ensure `mypy-boto3-synthetics` or `boto3-stubs[synthetics]` is correctly installed in your project's environment. For standalone packages, explicit type annotations (`client: SyntheticsClient`) are often necessary for optimal IDE support.

affects: mypy-boto3-synthetics >=1.42.3, mypy-boto3-builder >=8.12.0

gotchaWhen using standalone service packages like `mypy-boto3-synthetics` (or `boto3-stubs-lite`), explicit type annotations on `boto3.Session().client()` calls are recommended (`client: SyntheticsClient = session.client("synthetics")`) to ensure full IDE auto-completion and type checking capabilities.

fix

Always add explicit type hints for the client object returned by `session.client()` or `boto3.client()`.

affects: All versions of mypy-boto3-synthetics

gotchaA service like `sms-voice` was deprecated and replaced by `pinpoint-sms-voice` in mypy-boto3-builder 8.11.0. While specific to another service, this highlights that service names can change, potentially requiring updates to your imports and client instantiation strings.

fix

Always verify the correct service name and import path for the AWS service you intend to use. Refer to the official `boto3-stubs` documentation for the latest naming conventions.

affects: mypy-boto3-builder >=8.11.0

Upgrade

Version history

1.43.45latest on PyPI · released Jul 9, 2026

Audit

Dependencies

boto3requiredProvides the core AWS SDK functionality that these stubs type-annotate.

typing-extensionsoptionalMay be required for compatibility with certain Python versions or advanced type features; automatically managed by the builder's dependency calculation.

Agent activity

24 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/youtype/mypy_boto3_builder ↗

packagehttps://pypi.org/project/mypy-boto3-synthetics/ ↗

docshttps://youtype.github.io/boto3_stubs_docs/mypy_boto3_synthetics/ ↗