Skip to content

WellArchitected module#

Index > WellArchitected

Auto-generated documentation for WellArchitected type annotations stubs module mypy-boto3-wellarchitected.

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 WellArchitected.

From PyPI with pip#

Install boto3-stubs for WellArchitected service.

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


# 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[wellarchitected]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WellArchitectedClient#

Type annotations and code completion for boto3.client("wellarchitected") as WellArchitectedClient boto3 documentation

# WellArchitectedClient usage example

from boto3.session import Session

from mypy_boto3_wellarchitected.client import WellArchitectedClient

def get_client() -> WellArchitectedClient:
    return Session().client("wellarchitected")

Literals#

Type annotations for literals used in methods and schemas.

# AdditionalResourceTypeType usage example

from mypy_boto3_wellarchitected.literals import AdditionalResourceTypeType

def get_value() -> AdditionalResourceTypeType:
    return "HELPFUL_RESOURCE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ChoiceContentTypeDef usage example

from mypy_boto3_wellarchitected.type_defs import ChoiceContentTypeDef

def get_value() -> ChoiceContentTypeDef:
    return {
        "DisplayText": ...,
    }