Skip to main content

mypy-boto3-health

PyPI - mypy-boto3-health PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 Health 1.43.107 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on boto3-stubs page and in mypy-boto3-health docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

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.43.107' 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

VSCode

python -m pip install 'boto3-stubs[health]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[health] in your environment:

python -m pip install 'boto3-stubs[health]'

Both type checking and code completion should now work.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[health]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

  • Install boto3-stubs[health] with services you use in your environment:
python -m pip install 'boto3-stubs[health]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install boto3-stubs[health] in your environment:
python -m pip install 'boto3-stubs[health]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install boto3-stubs[health] in your environment:
python -m pip install 'boto3-stubs[health]'

Optionally, you can install boto3-stubs to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-health dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

HealthClient provides annotations for boto3.client("health").

from boto3.session import Session

from mypy_boto3_health import HealthClient

client: HealthClient = Session().client("health")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_health.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_health import HealthClient
from mypy_boto3_health.paginator import (
    DescribeAffectedAccountsForOrganizationPaginator,
    DescribeAffectedEntitiesForOrganizationPaginator,
    DescribeAffectedEntitiesPaginator,
    DescribeEventAggregatesPaginator,
    DescribeEventTypesPaginator,
    DescribeEventsForOrganizationPaginator,
    DescribeEventsPaginator,
    DescribeServiceLifecyclePaginator,
)

client: HealthClient = Session().client("health")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_affected_accounts_for_organization_paginator: DescribeAffectedAccountsForOrganizationPaginator = client.get_paginator(
    "describe_affected_accounts_for_organization"
)
describe_affected_entities_for_organization_paginator: DescribeAffectedEntitiesForOrganizationPaginator = client.get_paginator(
    "describe_affected_entities_for_organization"
)
describe_affected_entities_paginator: DescribeAffectedEntitiesPaginator = client.get_paginator(
    "describe_affected_entities"
)
describe_event_aggregates_paginator: DescribeEventAggregatesPaginator = client.get_paginator(
    "describe_event_aggregates"
)
describe_event_types_paginator: DescribeEventTypesPaginator = client.get_paginator(
    "describe_event_types"
)
describe_events_for_organization_paginator: DescribeEventsForOrganizationPaginator = (
    client.get_paginator("describe_events_for_organization")
)
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_service_lifecycle_paginator: DescribeServiceLifecyclePaginator = client.get_paginator(
    "describe_service_lifecycle"
)

Literals

mypy_boto3_health.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of Health Literals can be found in docs.

from mypy_boto3_health.literals import DescribeAffectedAccountsForOrganizationPaginatorName


def check_value(value: DescribeAffectedAccountsForOrganizationPaginatorName) -> bool: ...

Type definitions

mypy_boto3_health.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of Health TypeDefs can be found in docs.

# TypedDict usage example
from mypy_boto3_health.type_defs import AccountEntityAggregateTypeDef


def get_value() -> AccountEntityAggregateTypeDef:
    return {
        "accountId": ...,
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers drop-in type annotations for you and makes sure that:

  • All available boto3 services are covered.
  • Each public class and method of every boto3 service gets valid type annotations extracted from botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-health version is the same as related boto3 version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Metadata

Release files for mypy-boto3-health 1.43.107

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mypy-boto3-health 1.43.107
File Size Uploaded
mypy_boto3_health-1.43.107.tar.gz 20.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mypy-boto3-health 1.43.107
File Interpreter ABI Platform
mypy_boto3_health-1.43.107-py3-none-any.whl Python 3 none any Details

Total release size: 48.7 kB

Release files / mypy_boto3_health-1.43.107.tar.gz

Download URL mypy_boto3_health-1.43.107.tar.gz
Size 20.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b899f66db8261b68d0129a49bb0718caf69e740cf0ceb63aa2d76d494702c570
BLAKE2b-256 checksum
How to use checksums
aee64e73d3aa7d2b70231cab1c4a3b4d4ad9850529c552ba8be08f4fed4bf5ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release files / mypy_boto3_health-1.43.107-py3-none-any.whl

Download URL mypy_boto3_health-1.43.107-py3-none-any.whl
Size 28.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aef3fd2c8a6130b04a642206e8a46e3f9566d2a2d33281066c5cae611f354df4
BLAKE2b-256 checksum
How to use checksums
a28893d77f3df2cb0b80edb64d648482ddecf48c5d659ce8764f563db9508891
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.15

Release history Release notifications | RSS feed

This release

1.43.107 This release

2 release files

1.43.0

2 release files

1.41.0

2 release files

1.40.0

2 release files

1.39.0

2 release files

1.38.0

2 release files

1.37.0

2 release files

1.36.0

2 release files

1.35.0

2 release files

1.34.0

2 release files

1.33.0

2 release files

1.29.0

2 release files

1.25.0

2 release files

1.24.0

2 release files

1.23.0

2 release files

1.22.0

2 release files

1.21.0

2 release files

1.19.7

2 release files

1.19.6

2 release files

1.19.5

2 release files

1.19.4

2 release files

1.19.3

2 release files

1.19.2

2 release files

1.19.1

2 release files

1.19.0

2 release files

1.18.9

2 release files

1.18.8

2 release files

1.18.7

2 release files

1.18.6

2 release files

1.18.5

2 release files

1.18.4

2 release files

1.18.3

2 release files

1.18.2

2 release files

1.18.1

2 release files

1.18.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.2

2 release files

0.2.1

1 release file

0.2.0

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page