mypy-boto3-connecthealth

Warnings

• breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0 (November 2025). This affects all generated `mypy-boto3` stub packages, including `mypy-boto3-connecthealth` versions 1.42.x and newer. Projects using Python 3.8 or older will encounter compatibility issues.
  Fix: Upgrade your Python environment to version 3.9 or newer.
• breaking Type definition (TypeDef) naming conventions changed in `mypy-boto3-builder` version 8.9.0 (November 2025). Type definition names for method arguments and conflicting types may have been shortened or rearranged (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`). This could break existing explicit type annotations in your codebase that referenced the old names.
  Fix: Review your codebase for explicit `TypeDef` annotations and update them to reflect the new naming conventions, consulting the `mypy_boto3_connecthealth.type_defs` module for the correct names.
• gotcha `mypy-boto3-connecthealth` is a stub-only package and does not include the actual `boto3` runtime. Your application must have `boto3` installed to function at runtime. The type stubs are solely for static analysis.
  Fix: Always ensure `boto3` is installed in your runtime environment (e.g., `pip install boto3`).
• gotcha Following the migration to PEP 561 compliant packages in `mypy-boto3-builder` 8.12.0, ensure your `mypy` or other type checker is up-to-date. Older versions might not correctly discover or utilize the stubs, leading to `Missing type stub` errors or incorrect type inference.
  Fix: Update your type checker (e.g., `pip install --upgrade mypy`) and ensure it's configured to recognize PEP 561-compliant stub packages.
• gotcha For optimal performance and to avoid runtime dependencies, type imports from `mypy_boto3_*` packages should ideally be placed within `if TYPE_CHECKING:` blocks. This ensures that these stub packages are only used by static analysis tools and are not treated as runtime dependencies.
  Fix: Wrap your `from mypy_boto3_SERVICE import ...` statements in `if TYPE_CHECKING:` blocks.
• gotcha PyCharm users might experience slow performance and high CPU usage due to a known issue with Literal overloads (issue PY-40997) when using `boto3-stubs`.
  Fix: Consider installing the `boto3-stubs-lite` version (e.g., `pip install 'boto3-stubs-lite[connecthealth]'`) which is more RAM-friendly but requires explicit type annotations. Alternatively, disable PyCharm's internal type checker and use `mypy` or `pyright` instead.

Install

• pip install mypy-boto3-connecthealth boto3 Install with boto3 runtime
• pip install 'boto3-stubs[connecthealth]' boto3 Install via boto3-stubs meta-package

Imports

• ConnectHealthClient

  from mypy_boto3_connecthealth.client import ConnectHealthClient

• DescribeEventsPaginator

  from mypy_boto3_connecthealth.paginator import DescribeEventsPaginator

• EventTypeDef

  from mypy_boto3_connecthealth.type_defs import EventTypeDef

Quickstart

This quickstart demonstrates how to initialize a `boto3` ConnectHealth client with type annotations and fetch events. It includes explicit type hints for `ConnectHealthClient` and `EventTypeDef` to leverage static analysis. Ensure `boto3` is installed alongside `mypy-boto3-connecthealth`.

from typing import TYPE_CHECKING
import boto3
import os

if TYPE_CHECKING:
    from mypy_boto3_connecthealth.client import ConnectHealthClient
    from mypy_boto3_connecthealth.type_defs import EventTypeDef


def get_connect_health_events(region_name: str) -> list["EventTypeDef"]:
    # boto3 client creation without explicit type hint will still work
    # but explicit type hints provide better IDE support and type checking
    client: ConnectHealthClient = boto3.client(
        "connect-health",
        region_name=region_name,
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', ''),
        aws_session_token=os.environ.get('AWS_SESSION_TOKEN', '')
    )

    # Example: Describe events (Connect Health operations might require specific permissions)
    try:
        response = client.describe_events(
            Filter={
                'EventType': {'Values': ['AWS_HEALTH_EVENT']}
            }
        )
        return response['Events']
    except client.exceptions.InvalidRequestException as e:
        print(f"Error describing events: {e}")
        return []

if __name__ == "__main__":
    events = get_connect_health_events("us-east-1")
    print(f"Found {len(events)} Connect Health events.")
    for event in events:
        print(f"  - Event ARN: {event['eventArn']}")