mypy-boto3-synthetics Type Stubs for AWS Synthetics

1.42.3 · active · verified Sat Apr 11

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.

Warnings

breaking Starting 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`.
breaking mypy-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.
gotcha The 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.
gotcha When 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()`.
gotcha A 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.

Install

pip install mypy-boto3-synthetics Install standalone package
pip install 'boto3-stubs[synthetics]' Install as part of boto3-stubs

Imports

SyntheticsClient
```
from mypy_boto3_synthetics.client import SyntheticsClient
```
This is the explicit import for the Synthetics client type.
SyntheticsServiceName
```
from mypy_boto3_synthetics.literals import SyntheticsServiceName
```
Used for Literal type hints when calling boto3.client.
CreateCanaryRequestRequestTypeDef
```
from mypy_boto3_synthetics.type_defs import CreateCanaryRequestRequestTypeDef
```
Example of importing a specific TypedDict for request parameters.

Quickstart

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}")

view raw JSON →