Skip to content

Health module#

Index > Health

Auto-generated documentation for Health type annotations stubs module types-aiobotocore-health.

How to install#

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

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

From PyPI with pip#

Install types-aiobotocore for Health service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[health]'

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

# standalone installation
python -m pip install types-aiobotocore-health

How to uninstall#

python -m pip uninstall -y types-aiobotocore-health

Usage#

Code samples can be found in Examples.

HealthClient#

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

# HealthClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_health.client import HealthClient


session = get_session()
async with session.create_client("health") as client:
    client: HealthClient

Paginators#

Type annotations and code completion for paginators from session.create_client("health").get_paginator("...").

# DescribeAffectedAccountsForOrganizationPaginator usage example

from types_aiobotocore_health.paginator import DescribeAffectedAccountsForOrganizationPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# DescribeAffectedAccountsForOrganizationPaginatorName usage example

from types_aiobotocore_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.