Skip to content

WorkMail module

Index > WorkMail

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

How to install

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

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("...").

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.

Usage example
from types_aiobotocore_workmail.literals import AccessControlRuleEffectType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_workmail.type_defs import AccessControlRuleTypeDef

def get_value() -> AccessControlRuleTypeDef:
    return {
        "Name": ...,
    }