Skip to content

Health module#

Index > Health

Auto-generated documentation for Health type annotations stubs module mypy-boto3-health.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Health service.
  4. Use provided commands to install generated packages.

VSCode extension#

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

Click Modify and select boto3 common and Health.

From PyPI with pip#

Install boto3-stubs for Health service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

HealthClient#

Type annotations and code completion for boto3.client("health") as HealthClient boto3 documentation

# HealthClient usage example

from boto3.session import Session

from mypy_boto3_health.client import HealthClient

def get_client() -> HealthClient:
    return Session().client("health")

Paginators#

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

# DescribeAffectedAccountsForOrganizationPaginator usage example

from boto3.session import Session

from mypy_boto3_health.paginator import DescribeAffectedAccountsForOrganizationPaginator

def get_describe_affected_accounts_for_organization_paginator() -> DescribeAffectedAccountsForOrganizationPaginator:
    return Session().client("health").get_paginator("describe_affected_accounts_for_organization"))

Literals#

Type annotations for literals used in methods and schema.

# DescribeAffectedAccountsForOrganizationPaginatorName usage example

from mypy_boto3_health.literals import DescribeAffectedAccountsForOrganizationPaginatorName

def get_value() -> DescribeAffectedAccountsForOrganizationPaginatorName:
    return "describe_affected_accounts_for_organization"

Type definitions#

Type annotations for type definitions used in methods and schema.