Skip to content

HealthClient#

Index > Health > HealthClient

Auto-generated documentation for Health type annotations stubs module mypy-boto3-health.

HealthClient#

Type annotations and code completion for boto3.client("health"). boto3 documentation

# HealthClient usage example

from boto3.session import Session
from mypy_boto3_health.client import HealthClient

def get_health_client() -> HealthClient:
    return Session().client("health")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("health").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("health")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.InvalidPaginationToken,
    client.exceptions.UnsupportedLocale,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_health.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("health").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("health").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

describe_affected_accounts_for_organization#

Returns a list of accounts in the organization from Organizations that are affected by the provided event.

Type annotations and code completion for boto3.client("health").describe_affected_accounts_for_organization method. boto3 documentation

# describe_affected_accounts_for_organization method definition

def describe_affected_accounts_for_organization(
    self,
    *,
    eventArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeAffectedAccountsForOrganizationResponseTypeDef:  # (1)
    ...
  1. See DescribeAffectedAccountsForOrganizationResponseTypeDef
# describe_affected_accounts_for_organization method usage example with argument unpacking

kwargs: DescribeAffectedAccountsForOrganizationRequestRequestTypeDef = {  # (1)
    "eventArn": ...,
}

parent.describe_affected_accounts_for_organization(**kwargs)
  1. See DescribeAffectedAccountsForOrganizationRequestRequestTypeDef

describe_affected_entities#

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.

Type annotations and code completion for boto3.client("health").describe_affected_entities method. boto3 documentation

# describe_affected_entities method definition

def describe_affected_entities(
    self,
    *,
    filter: EntityFilterTypeDef,  # (1)
    locale: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeAffectedEntitiesResponseTypeDef:  # (2)
    ...
  1. See EntityFilterTypeDef
  2. See DescribeAffectedEntitiesResponseTypeDef
# describe_affected_entities method usage example with argument unpacking

kwargs: DescribeAffectedEntitiesRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.describe_affected_entities(**kwargs)
  1. See DescribeAffectedEntitiesRequestRequestTypeDef

describe_affected_entities_for_organization#

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria.

Type annotations and code completion for boto3.client("health").describe_affected_entities_for_organization method. boto3 documentation

# describe_affected_entities_for_organization method definition

def describe_affected_entities_for_organization(
    self,
    *,
    organizationEntityFilters: Sequence[EventAccountFilterTypeDef] = ...,  # (1)
    locale: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    organizationEntityAccountFilters: Sequence[EntityAccountFilterTypeDef] = ...,  # (2)
) -> DescribeAffectedEntitiesForOrganizationResponseTypeDef:  # (3)
    ...
  1. See EventAccountFilterTypeDef
  2. See EntityAccountFilterTypeDef
  3. See DescribeAffectedEntitiesForOrganizationResponseTypeDef
# describe_affected_entities_for_organization method usage example with argument unpacking

kwargs: DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef = {  # (1)
    "organizationEntityFilters": ...,
}

parent.describe_affected_entities_for_organization(**kwargs)
  1. See DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef

describe_entity_aggregates#

Returns the number of entities that are affected by each of the specified events.

Type annotations and code completion for boto3.client("health").describe_entity_aggregates method. boto3 documentation

# describe_entity_aggregates method definition

def describe_entity_aggregates(
    self,
    *,
    eventArns: Sequence[str] = ...,
) -> DescribeEntityAggregatesResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityAggregatesResponseTypeDef
# describe_entity_aggregates method usage example with argument unpacking

kwargs: DescribeEntityAggregatesRequestRequestTypeDef = {  # (1)
    "eventArns": ...,
}

parent.describe_entity_aggregates(**kwargs)
  1. See DescribeEntityAggregatesRequestRequestTypeDef

describe_entity_aggregates_for_organization#

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

Type annotations and code completion for boto3.client("health").describe_entity_aggregates_for_organization method. boto3 documentation

# describe_entity_aggregates_for_organization method definition

def describe_entity_aggregates_for_organization(
    self,
    *,
    eventArns: Sequence[str],
    awsAccountIds: Sequence[str] = ...,
) -> DescribeEntityAggregatesForOrganizationResponseTypeDef:  # (1)
    ...
  1. See DescribeEntityAggregatesForOrganizationResponseTypeDef
# describe_entity_aggregates_for_organization method usage example with argument unpacking

kwargs: DescribeEntityAggregatesForOrganizationRequestRequestTypeDef = {  # (1)
    "eventArns": ...,
}

parent.describe_entity_aggregates_for_organization(**kwargs)
  1. See DescribeEntityAggregatesForOrganizationRequestRequestTypeDef

describe_event_aggregates#

Returns the number of events of each event type (issue, scheduled change, and account notification).

Type annotations and code completion for boto3.client("health").describe_event_aggregates method. boto3 documentation

# describe_event_aggregates method definition

def describe_event_aggregates(
    self,
    *,
    aggregateField: eventAggregateFieldType,  # (1)
    filter: EventFilterTypeDef = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeEventAggregatesResponseTypeDef:  # (3)
    ...
  1. See eventAggregateFieldType
  2. See EventFilterTypeDef
  3. See DescribeEventAggregatesResponseTypeDef
# describe_event_aggregates method usage example with argument unpacking

kwargs: DescribeEventAggregatesRequestRequestTypeDef = {  # (1)
    "aggregateField": ...,
}

parent.describe_event_aggregates(**kwargs)
  1. See DescribeEventAggregatesRequestRequestTypeDef

describe_event_details#

Returns detailed information about one or more specified events.

Type annotations and code completion for boto3.client("health").describe_event_details method. boto3 documentation

# describe_event_details method definition

def describe_event_details(
    self,
    *,
    eventArns: Sequence[str],
    locale: str = ...,
) -> DescribeEventDetailsResponseTypeDef:  # (1)
    ...
  1. See DescribeEventDetailsResponseTypeDef
# describe_event_details method usage example with argument unpacking

kwargs: DescribeEventDetailsRequestRequestTypeDef = {  # (1)
    "eventArns": ...,
}

parent.describe_event_details(**kwargs)
  1. See DescribeEventDetailsRequestRequestTypeDef

describe_event_details_for_organization#

Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization.

Type annotations and code completion for boto3.client("health").describe_event_details_for_organization method. boto3 documentation

# describe_event_details_for_organization method definition

def describe_event_details_for_organization(
    self,
    *,
    organizationEventDetailFilters: Sequence[EventAccountFilterTypeDef],  # (1)
    locale: str = ...,
) -> DescribeEventDetailsForOrganizationResponseTypeDef:  # (2)
    ...
  1. See EventAccountFilterTypeDef
  2. See DescribeEventDetailsForOrganizationResponseTypeDef
# describe_event_details_for_organization method usage example with argument unpacking

kwargs: DescribeEventDetailsForOrganizationRequestRequestTypeDef = {  # (1)
    "organizationEventDetailFilters": ...,
}

parent.describe_event_details_for_organization(**kwargs)
  1. See DescribeEventDetailsForOrganizationRequestRequestTypeDef

describe_event_types#

Returns the event types that meet the specified filter criteria.

Type annotations and code completion for boto3.client("health").describe_event_types method. boto3 documentation

# describe_event_types method definition

def describe_event_types(
    self,
    *,
    filter: EventTypeFilterTypeDef = ...,  # (1)
    locale: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeEventTypesResponseTypeDef:  # (2)
    ...
  1. See EventTypeFilterTypeDef
  2. See DescribeEventTypesResponseTypeDef
# describe_event_types method usage example with argument unpacking

kwargs: DescribeEventTypesRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.describe_event_types(**kwargs)
  1. See DescribeEventTypesRequestRequestTypeDef

describe_events#

Returns information about events that meet the specified filter criteria.

Type annotations and code completion for boto3.client("health").describe_events method. boto3 documentation

# describe_events method definition

def describe_events(
    self,
    *,
    filter: EventFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    locale: str = ...,
) -> DescribeEventsResponseTypeDef:  # (2)
    ...
  1. See EventFilterTypeDef
  2. See DescribeEventsResponseTypeDef
# describe_events method usage example with argument unpacking

kwargs: DescribeEventsRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsRequestRequestTypeDef

describe_events_for_organization#

Returns information about events across your organization in Organizations.

Type annotations and code completion for boto3.client("health").describe_events_for_organization method. boto3 documentation

# describe_events_for_organization method definition

def describe_events_for_organization(
    self,
    *,
    filter: OrganizationEventFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    locale: str = ...,
) -> DescribeEventsForOrganizationResponseTypeDef:  # (2)
    ...
  1. See OrganizationEventFilterTypeDef
  2. See DescribeEventsForOrganizationResponseTypeDef
# describe_events_for_organization method usage example with argument unpacking

kwargs: DescribeEventsForOrganizationRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.describe_events_for_organization(**kwargs)
  1. See DescribeEventsForOrganizationRequestRequestTypeDef

describe_health_service_status_for_organization#

This operation provides status information on enabling or disabling Health to work with your organization.

Type annotations and code completion for boto3.client("health").describe_health_service_status_for_organization method.