Type annotations for boto3.Health 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-health
Type annotations for boto3.Health 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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
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.
from mypy_boto3_health import HealthClient
from mypy_boto3_health.paginator import (
DescribeAffectedAccountsForOrganizationPaginator,
DescribeAffectedEntitiesPaginator,
DescribeAffectedEntitiesForOrganizationPaginator,
DescribeEventAggregatesPaginator,
DescribeEventTypesPaginator,
DescribeEventsPaginator,
DescribeEventsForOrganizationPaginator,
)
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.
from mypy_boto3_health.type_defs import AffectedEntityTypeDef, ...
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 expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("health")
session_client = boto3.Session().client("health")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-health-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7de0f71a4958c022ec28437bb79d7cf5434221456874c56c8b77c0a0bdd7b4a |
|
MD5 | e8fda9389dc243ce4e7471bf2d207387 |
|
BLAKE2b-256 | f0f287bed756e46fca6dc831f552be776a338c021758aabc21effbec4aced03b |
Hashes for mypy_boto3_health-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2ac2822ded8909c3fc0ef4ad850895eaa408878f1e0131f1e45103195145dd4 |
|
MD5 | 9cc4bd33d32ca3903429c618b0ae2f30 |
|
BLAKE2b-256 | 4d60335d6883dd8c43cac98cf597985d9c26a949f54546761f16f6b3b1ad1254 |