Skip to content

WorkMail module#

Index > WorkMail

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

How to install#

You can generate type annotations for aioboto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aioboto3==14.1.0' mypy-boto3-builder
  2. Select aioboto3 AWS SDK.
  3. Add WorkMail service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aioboto3 for WorkMail service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[workmail]'

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

# standalone installation
python -m pip install types-aiobotocore-workmail

How to uninstall#

python -m pip uninstall -y types-aiobotocore-workmail

Usage#

Code samples can be found in Examples.

WorkMailClient#

Type annotations and code completion for session.client("workmail") as WorkMailClient boto3 documentation

# WorkMailClient usage example

from aioboto3.session import Session

from types_aiobotocore_workmail.client import WorkMailClient


session = Session()
async with session.client("workmail") as client:
    client: WorkMailClient

Paginators#

Type annotations and code completion for paginators from session.client("workmail").get_paginator("...").

# ListAliasesPaginator usage example

from types_aiobotocore_workmail.paginator import ListAliasesPaginator

def get_list_aliases_paginator() -> ListAliasesPaginator:
    return client.get_paginator("list_aliases"))

Literals#

Type annotations for literals used in methods and schema.

# AccessControlRuleEffectType usage example

from types_aiobotocore_workmail.literals import AccessControlRuleEffectType

def get_value() -> AccessControlRuleEffectType:
    return "ALLOW"

Type definitions#

Type annotations for type definitions used in methods and schema.