Skip to content

Synthetics module#

Index > Synthetics

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

How to install#

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

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

From PyPI with pip#

Install types-aioboto3 for Synthetics service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[synthetics]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SyntheticsClient#

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

# SyntheticsClient usage example

from aioboto3.session import Session

from types_aiobotocore_synthetics.client import SyntheticsClient


session = Session()
async with session.client("synthetics") as client:
    client: SyntheticsClient

Literals#

Type annotations for literals used in methods and schema.

# CanaryRunStateReasonCodeType usage example

from types_aiobotocore_synthetics.literals import CanaryRunStateReasonCodeType

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

Type definitions#

Type annotations for type definitions used in methods and schema.