Synthetics module

Index > Synthetics

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

How to install

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 boto3-stubs for Synthetics service.

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


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

SyntheticsClient

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

Usage example

from boto3.session import Session

from mypy_boto3_synthetics.client import SyntheticsClient

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

Literals

Type annotations for literals used in methods and schemas.

Usage example

from mypy_boto3_synthetics.literals import CanaryRunStateReasonCodeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example

from mypy_boto3_synthetics.type_defs import S3EncryptionConfigTypeDef

def get_value() -> S3EncryptionConfigTypeDef:
    return {
        "EncryptionMode": ...,
    }