Examples

Index > Synthetics > Examples

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

Client

Implicit type annotations

Can be used with types-aiobotocore[synthetics] package installed.

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

# SyntheticsClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("synthetics") as client:  # (1)
    result = await client.create_canary()  # (2)

1. client: SyntheticsClient
2. result: CreateCanaryResponseTypeDef

Explicit type annotations

With types-aiobotocore-lite[synthetics] or a standalone types_aiobotocore_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.

# SyntheticsClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_synthetics.client import SyntheticsClient
from types_aiobotocore_synthetics.type_defs import CreateCanaryResponseTypeDef
from types_aiobotocore_synthetics.type_defs import CreateCanaryRequestRequestTypeDef


session = get_session()

async with session.create_client("synthetics") as client:
    client: SyntheticsClient
    kwargs: CreateCanaryRequestRequestTypeDef = {...}
    result: CreateCanaryResponseTypeDef = await client.create_canary(**kwargs)