Skip to content

Synthetics module#

Index > Synthetics

Auto-generated documentation for Synthetics type annotations stubs module types-boto3-synthetics.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add Synthetics service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Synthetics.

From PyPI with pip#

Install types-boto3 for Synthetics service.

# install with boto3 type annotations
python -m pip install 'types-boto3[synthetics]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[synthetics]'

# standalone installation
python -m pip install types-boto3-synthetics

How to uninstall#

python -m pip uninstall -y types-boto3-synthetics

Usage#

Code samples can be found in Examples.

SyntheticsClient#

Type annotations and code completion for boto3.client("synthetics") as SyntheticsClient boto3 documentation

# SyntheticsClient usage example

from boto3.session import Session

from types_boto3_synthetics.client import SyntheticsClient

def get_client() -> SyntheticsClient:
    return Session().client("synthetics")

Literals#

Type annotations for literals used in methods and schema.

# CanaryRunStateReasonCodeType usage example

from types_boto3_synthetics.literals import CanaryRunStateReasonCodeType

def get_value() -> CanaryRunStateReasonCodeType:
    return "CANARY_FAILURE"

Type definitions#

Type annotations for type definitions used in methods and schema.