Skip to content

WorkMail module#

Index > WorkMail

Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and WorkMail.

From PyPI with pip#

Install boto3-stubs for WorkMail service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[workmail]'


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


# standalone installation
python -m pip install mypy-boto3-workmail

How to uninstall#

python -m pip uninstall -y mypy-boto3-workmail

Usage#

Code samples can be found in Examples.

WorkMailClient#

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

# WorkMailClient usage example

from boto3.session import Session

from mypy_boto3_workmail.client import WorkMailClient

def get_client() -> WorkMailClient:
    return Session().client("workmail")

Paginators#

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

# ListAliasesPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListAliasesPaginator

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

Literals#

Type annotations for literals used in methods and schemas.

# AccessControlRuleEffectType usage example

from mypy_boto3_workmail.literals import AccessControlRuleEffectType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccessControlRuleTypeDef usage example

from mypy_boto3_workmail.type_defs import AccessControlRuleTypeDef

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