mypy-boto3-health type annotations

1.42.59 · active · verified Sat Apr 11

mypy-boto3-health provides type annotations (stubs) for the AWS Boto3 Health service. It enables static type checking with tools like MyPy, improving code quality and catching potential errors for applications interacting with AWS Health. The library is actively maintained and releases frequently, often in sync with new `boto3` versions or `mypy-boto3-builder` updates.

Warnings

breaking Python 3.8 support has been removed across all `mypy-boto3` packages, and all packages have migrated to PEP 561. This may require upgrading your Python environment and reviewing how stubs are resolved by your type checker.
Fix: Upgrade your Python environment to 3.9 or newer. Ensure your type checker (e.g., MyPy) is configured to correctly find PEP 561-compliant packages.
breaking TypeDef naming conventions changed for packed method arguments and conflict resolution. This primarily impacts users relying on specific TypeDef names for complex input/output structures within the stubs.
Fix: Review your code for any direct references to `CreateDistributionRequestRequestTypeDef` (now `CreateDistributionRequestTypeDef`) or `CreateDistributionExtraRequestTypeDef` (now `CreateDistributionRequestExtraTypeDef`) and similar patterns, and update them accordingly.
gotcha This package provides *only* type annotations. You must install `boto3` separately for your application to actually interact with AWS services at runtime.
Fix: Ensure `pip install boto3` is part of your project's dependencies alongside `mypy-boto3-health`.
gotcha AWS service names and their corresponding `mypy-boto3` package names can sometimes change or be deprecated (e.g., `sms-voice` replaced by `pinpoint-sms-voice`). Ensure you are using the correct and most up-to-date service name.
Fix: Periodically check the official AWS documentation and `mypy-boto3` release notes for changes in service names or preferred alternatives. If a service package seems outdated, verify if a newer or renamed package exists.

Install

pip install mypy-boto3-health Install library

Imports

HealthClient
```
from mypy_boto3_health.client import HealthClient
```
Type hints for Boto3 clients are provided by mypy-boto3 packages, not directly from boto3 itself.
DescribeEventsResponseTypeDef
```
from mypy_boto3_health.type_defs import DescribeEventsResponseTypeDef
```
Specific TypeDefs for service responses or input parameters are within the mypy-boto3 service package.

Quickstart

This quickstart demonstrates how to obtain a typed Boto3 Health client and use its methods with full type hint support. It includes an example of calling `describe_events` and accessing the typed response.

import boto3
from mypy_boto3_health.client import HealthClient
from mypy_boto3_health.type_defs import DescribeEventsResponseTypeDef
import os

# Instantiate a typed Boto3 Health client
# Ensure AWS_REGION is set in your environment or passed explicitly
region = os.environ.get("AWS_REGION", "us-east-1")
health_client: HealthClient = boto3.client("health", region_name=region)

print(f"Fetching health events in {region}...")

try:
    # Use a typed method and receive a typed response
    response: DescribeEventsResponseTypeDef = health_client.describe_events(
        filter={
            "eventStatusCodes": ["open"],
        }
    )
    events = response.get("events", [])
    if events:
        print(f"Found {len(events)} open health events:")
        for event in events:
            print(f"  Event ARN: {event['eventArn']}, Type: {event['eventTypeCategory']}")
    else:
        print("No open health events found.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →