Health module
Index > Health
Auto-generated documentation for Health type annotations stubs module mypy-boto3-health.
How to install
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
Usage
Code samples can be found in Examples.
HealthClient
Type annotations and code completion for boto3.client("health")
as HealthClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_health.client import HealthClient
def get_client() -> HealthClient:
return Session().client("health")
Paginators
Type annotations and code completion for paginators
from boto3.client("health").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_health.paginator import DescribeAffectedAccountsForOrganizationPaginator
def get_describe_affected_accounts_for_organization_paginator() -> DescribeAffectedAccountsForOrganizationPaginator:
return Session().client("health").get_paginator("describe_affected_accounts_for_organization"))
- DescribeAffectedAccountsForOrganizationPaginator
- DescribeAffectedEntitiesPaginator
- DescribeAffectedEntitiesForOrganizationPaginator
- DescribeEventAggregatesPaginator
- DescribeEventTypesPaginator
- DescribeEventsPaginator
- DescribeEventsForOrganizationPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_health.literals import DescribeAffectedAccountsForOrganizationPaginatorName
def get_value() -> DescribeAffectedAccountsForOrganizationPaginatorName:
return "describe_affected_accounts_for_organization"
- DescribeAffectedAccountsForOrganizationPaginatorName
- DescribeAffectedEntitiesForOrganizationPaginatorName
- DescribeAffectedEntitiesPaginatorName
- DescribeEventAggregatesPaginatorName
- DescribeEventTypesPaginatorName
- DescribeEventsForOrganizationPaginatorName
- DescribeEventsPaginatorName
- entityStatusCodeType
- eventAggregateFieldType
- eventScopeCodeType
- eventStatusCodeType
- eventTypeCategoryType
- HealthServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_health.type_defs import AffectedEntityTypeDef
def get_value() -> AffectedEntityTypeDef:
return {
"entityArn": ...,
}
- AffectedEntityTypeDef
- DateTimeRangeTypeDef
- PaginatorConfigTypeDef
- DescribeAffectedAccountsForOrganizationRequestRequestTypeDef
- ResponseMetadataTypeDef
- EventAccountFilterTypeDef
- OrganizationAffectedEntitiesErrorItemTypeDef
- DescribeEntityAggregatesRequestRequestTypeDef
- EntityAggregateTypeDef
- EventAggregateTypeDef
- OrganizationEventDetailsErrorItemTypeDef
- DescribeEventDetailsRequestRequestTypeDef
- EventDetailsErrorItemTypeDef
- EventTypeFilterTypeDef
- EventTypeTypeDef
- OrganizationEventTypeDef
- EventTypeDef
- EventDescriptionTypeDef
- EntityFilterTypeDef
- EventFilterTypeDef
- OrganizationEventFilterTypeDef
- DescribeAffectedAccountsForOrganizationRequestDescribeAffectedAccountsForOrganizationPaginateTypeDef
- DescribeAffectedAccountsForOrganizationResponseTypeDef
- DescribeAffectedEntitiesResponseTypeDef
- DescribeHealthServiceStatusForOrganizationResponseTypeDef
- EmptyResponseMetadataTypeDef
- DescribeAffectedEntitiesForOrganizationRequestDescribeAffectedEntitiesForOrganizationPaginateTypeDef
- DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef
- DescribeEventDetailsForOrganizationRequestRequestTypeDef
- DescribeAffectedEntitiesForOrganizationResponseTypeDef
- DescribeEntityAggregatesResponseTypeDef
- DescribeEventAggregatesResponseTypeDef
- DescribeEventTypesRequestDescribeEventTypesPaginateTypeDef
- DescribeEventTypesRequestRequestTypeDef
- DescribeEventTypesResponseTypeDef
- DescribeEventsForOrganizationResponseTypeDef
- DescribeEventsResponseTypeDef
- EventDetailsTypeDef
- OrganizationEventDetailsTypeDef
- DescribeAffectedEntitiesRequestDescribeAffectedEntitiesPaginateTypeDef
- DescribeAffectedEntitiesRequestRequestTypeDef
- DescribeEventAggregatesRequestDescribeEventAggregatesPaginateTypeDef
- DescribeEventAggregatesRequestRequestTypeDef
- DescribeEventsRequestDescribeEventsPaginateTypeDef
- DescribeEventsRequestRequestTypeDef
- DescribeEventsForOrganizationRequestDescribeEventsForOrganizationPaginateTypeDef
- DescribeEventsForOrganizationRequestRequestTypeDef
- DescribeEventDetailsResponseTypeDef
- DescribeEventDetailsForOrganizationResponseTypeDef