mypy-boto3-health 1.14.29.0

Type annotations for boto3.Health 1.14.29 service, generated by mypy-boto3-buider 2.2.0

mypy-boto3-health

Type annotations for boto3.Health 1.14.29 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.2.0.

More information can be found on boto3-stubs page.

How to install

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for Health service.

python -m pip install boto3-stubs[health]

How to use

Client annotations

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

import boto3

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

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

# now client usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: HealthClient = session.client("health")

Paginators annotations

mypy_boto3_health.paginator module contains type annotations for all paginators.

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

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

Typed dictionations

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

def get_structure() -> AffectedEntityTypeDef:
    return {
      ...
    }

Dynamic type annotations

mypy_boto3 command generates boto3.client/resource type annotations for mypy_boto3_health and other installed services.

# Run this command after you add or remove service packages
python -m mypy_boto3

Generated type annotations provide overloads for boto3.client and boto3.resource, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
• VSCode does not currently support function overloads, use explicit type annotations

# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("health")

session_client = boto3.Session().client("health")