Examples

Index > Synthetics > Examples

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

Client

Implicit type annotations

Can be used with boto3-stubs[synthetics] package installed.

Write your Synthetics code as usual, type checking and code completion should work out of the box.

Client method usage example

# SyntheticsClient usage example

from boto3.session import Session


session = Session()

client = session.client("synthetics")  # (1)
result = client.create_canary()  # (2)

1. client: SyntheticsClient
2. result: CreateCanaryResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[synthetics] or a standalone mypy_boto3_synthetics package, you have to explicitly specify client: SyntheticsClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# SyntheticsClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_synthetics.client import SyntheticsClient
from mypy_boto3_synthetics.type_defs import CreateCanaryResponseTypeDef
from mypy_boto3_synthetics.type_defs import CreateCanaryRequestTypeDef


session = Session()

client: SyntheticsClient = session.client("synthetics")

kwargs: CreateCanaryRequestTypeDef = {...}
result: CreateCanaryResponseTypeDef = client.create_canary(**kwargs)