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-aioboto3[workmail] package installed.

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

ClientPaginators

Client usage example

from aioboto3.session import Session


session = Session()

async with session.client("workmail") as client:  # (1)
    result = await client.create_group()  # (2)

1. client: WorkMailClient
2. result: CreateGroupResponseTypeDef

Paginator usage example

from aioboto3.session import Session


session = Session()

async with session.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-aioboto3-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.

ClientPaginators

Client usage example

from aioboto3.session import Session

from types_aiobotocore_workmail.client import WorkMailClient
from types_aiobotocore_workmail.type_defs import CreateGroupResponseTypeDef
from types_aiobotocore_workmail.type_defs import CreateGroupRequestRequestTypeDef


session = Session()

client: WorkMailClient
async with session.client("workmail") as client:  # (1)
    kwargs: CreateGroupRequestRequestTypeDef = {...}  # (2)
    result: CreateGroupResponseTypeDef = await client.create_group(**kwargs)  # (3)

1. client: WorkMailClient
2. kwargs: CreateGroupRequestRequestTypeDef
3. result: CreateGroupResponseTypeDef

Paginator usage example

from aioboto3.session import Session

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


session = Session()

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

1. client: WorkMailClient
2. paginator: ListAliasesPaginator
3. item: ListAliasesResponseTypeDef