Skip to content

Examples#

Index > WorkMail > Examples

Auto-generated documentation for WorkMail type annotations stubs module types-aiobotocore-workmail.

Client#

Implicit type annotations#

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

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

# WorkMailClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("workmail") as client:  # (1)
    result = await client.assume_impersonation_role()  # (2)
  1. client: WorkMailClient
  2. result: AssumeImpersonationRoleResponseTypeDef
# ListAliasesPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("workmail") as client:  # (1)
    paginator = client.get_paginator("list_aliases")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListAliasesPaginator
  3. item: ListAliasesResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[workmail] or a standalone types_aiobotocore_workmail package, you have to explicitly specify client: WorkMailClient 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.

# WorkMailClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_workmail.client import WorkMailClient
from types_aiobotocore_workmail.type_defs import AssumeImpersonationRoleResponseTypeDef
from types_aiobotocore_workmail.type_defs import AssumeImpersonationRoleRequestRequestTypeDef


session = get_session()

async with session.create_client("workmail") as client:
    client: WorkMailClient
    kwargs: AssumeImpersonationRoleRequestRequestTypeDef = {...}
    result: AssumeImpersonationRoleResponseTypeDef = await client.assume_impersonation_role(**kwargs)
# ListAliasesPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_workmail.client import WorkMailClient
from types_aiobotocore_workmail.paginator import ListAliasesPaginator
from types_aiobotocore_workmail.type_defs import ListAliasesResponseTypeDef


session = get_session()

async with session.create_client("workmail") as client:
    client: WorkMailClient
    paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
    async for item in paginator.paginate(...):
        item: ListAliasesResponseTypeDef
        print(item)