mypy-boto3-workmail Type Annotations

1.42.3 · active · verified Sat Apr 11

mypy-boto3-workmail provides type annotations for the `boto3` WorkMail service, enabling static type checking with tools like MyPy and Pyright for `boto3.client('workmail')` calls. It is automatically generated by `mypy-boto3-builder` and is frequently updated in sync with `boto3` and `botocore` releases to provide up-to-date type hints.

Warnings

breaking Python 3.8 support was removed starting with `mypy-boto3-builder` version 8.12.0. If you are using an older Python version, you must use an older `mypy-boto3-workmail` release or upgrade your Python environment.
Fix: Upgrade Python to 3.9+ or pin `mypy-boto3-workmail` to an older version compatible with Python 3.8 (e.g., <1.42.0).
breaking TypeDef naming conventions changed in `mypy-boto3-builder` version 8.9.0. Specifically, 'RequestRequestTypeDef' was shortened to 'RequestTypeDef' and 'Extra' postfixes moved to the end. This can break existing explicit `TypeDef` imports.
Fix: Update `TypeDef` import paths and names in your code to match the new convention. Review the specific service's `type_defs` module.
gotcha Pylint may raise `undefined-variable` warnings for type-hinted `boto3` clients when `mypy-boto3-workmail` is installed. This is due to how Pylint handles the `TYPE_CHECKING` guard.
Fix: Use a conditional assignment within a `if TYPE_CHECKING:` block, setting runtime variables to `object` in the `else` branch, as shown in the quickstart example.
gotcha This package provides *only* type annotations. You must also install the `boto3` library to actually make AWS API calls at runtime.
Fix: Ensure `boto3` is installed alongside `mypy-boto3-workmail` (e.g., `pip install mypy-boto3-workmail boto3`).
gotcha For PyCharm users, there can be performance issues with `Literal` overloads provided by `mypy-boto3-workmail`. PyCharm's indexing might be slow.
Fix: It is recommended to use `boto3-stubs-lite` instead of the full `boto3-stubs` or `mypy-boto3-*` packages, as the lite versions are more RAM-friendly and mitigate this issue. Note that `boto3-stubs-lite` requires more explicit type annotations.

Install

pip install mypy-boto3-workmail boto3 Install with boto3
pip install 'boto3-stubs[workmail]' boto3 Install via boto3-stubs extra

Imports

WorkMailClient
```
from mypy_boto3_workmail.client import WorkMailClient
```
Provides type annotations for `boto3.client("workmail")`.
AccessControlRuleTypeDef
```
from mypy_boto3_workmail.type_defs import AccessControlRuleTypeDef
```
Example of importing a generated TypedDict for request/response payloads.
AccessControlRuleEffectType
```
from mypy_boto3_workmail.literals import AccessControlRuleEffectType
```
Example of importing a generated Literal type for specific string values.

Quickstart

This quickstart demonstrates how to obtain a type-hinted WorkMail client using `mypy-boto3-workmail` and perform a basic API call like listing organizations. The `TYPE_CHECKING` block ensures that `mypy-boto3-workmail` is only used for type checking and not as a runtime dependency. Remember to have `boto3` installed for runtime execution.

import boto3
from mypy_boto3_workmail.client import WorkMailClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    client: WorkMailClient
else:
    client = boto3.client("workmail")

# Example usage: List organizations
# client = boto3.client("workmail") # In actual runtime, use this line

try:
    response = client.list_organizations(MaxResults=5) # Type-checked call
    for org in response.get("OrganizationSummaries", []):
        print(f"Organization ID: {org['OrganizationId']}, State: {org['State']}")
except client.exceptions.OrganizationNotFoundException:
    print("No WorkMail organizations found.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →