Type annotations for boto3 WellArchitected

1.42.3 · active · verified Sat Apr 11

This library provides static type annotations for the AWS Well-Architected service, enabling `mypy` to perform static type checking on `boto3` code. It ensures type safety and enhances developer experience with improved autocompletion. The current version is 1.42.3, and it follows the `mypy-boto3-builder` release cadence, which is typically frequent due to `boto3` updates.

Warnings

breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and subsequent `mypy-boto3` packages. Users on Python 3.8 will need to upgrade to Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking In `mypy-boto3-builder` version 8.9.0, TypeDef names for packed method arguments were shortened, and conflicting `Extra` postfixes were moved. If you have explicitly imported or referenced generated `TypeDef` names, these may have changed.
Fix: Review your code for direct imports of `TypeDef` objects from `mypy_boto3_wellarchitected.type_defs` and adjust to the new naming conventions if they break.
gotcha The `mypy-boto3` ecosystem migrated to PEP 561 packages in `mypy-boto3-builder` 8.12.0. While beneficial for type checkers, it might cause unexpected behavior with older `pip` versions or custom build systems that do not correctly handle PEP 561 stub distribution.
Fix: Ensure your `pip` is up-to-date (`pip install --upgrade pip`) and your build environment correctly recognizes PEP 561 compliant stub packages.
gotcha For optimal type checking and compatibility, the version of `mypy-boto3-wellarchitected` should ideally align with the version of `boto3` you are using. Mismatched versions can lead to incorrect type hints or missing attributes, especially after significant `boto3` updates.
Fix: Keep `mypy-boto3-wellarchitected` updated to a version compatible with your `boto3` installation. The `mypy-boto3` documentation often suggests installing with `boto3-stubs[boto3]` to ensure synchronization.

Install

pip install mypy-boto3-wellarchitected Install service-specific stubs
pip install 'boto3-stubs[wellarchitected]' Install via boto3-stubs extras (recommended)

Imports

WellArchitectedClient
```
from mypy_boto3_wellarchitected.client import WellArchitectedClient
```
Directly importing from `boto3.client` will not provide the type hints. The `mypy_boto3_wellarchitected` package provides the necessary type stubs for the specific service client.
WellArchitectedServiceName
```
from mypy_boto3_wellarchitected.type_defs import CreateWorkloadInputRequestTypeDef
```
Type definitions are typically found in the `type_defs` submodule, corresponding to API request/response structures.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `WellArchitectedClient` using `boto3` and the `mypy-boto3-wellarchitected` stubs. It uses environment variables for AWS credentials, which is good practice. The `list_workloads` call is included to show typical client interaction, though it requires valid AWS credentials and permissions to execute successfully.

import os
import boto3
from mypy_boto3_wellarchitected.client import WellArchitectedClient


def get_wellarchitected_client() -> WellArchitectedClient:
    """Initializes and returns a WellArchitectedClient with type annotations."""
    session = boto3.Session(
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'DUMMY_KEY'),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'DUMMY_SECRET'),
        region_name=os.environ.get('AWS_REGION', 'us-east-1')
    )
    client: WellArchitectedClient = session.client("wellarchitected")
    return client

# Example usage (will require valid AWS credentials for actual execution)
if __name__ == "__main__":
    try:
        wa_client = get_wellarchitected_client()
        # This call will typically fail without proper credentials and permissions
        # but demonstrates type-hinted client usage.
        response = wa_client.list_workloads(
            MaxResults=10
        )
        print("Successfully initialized WellArchitected client (response may be empty/error without valid creds).")
        # print(response.get('WorkloadSummaries'))
    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →