HealthClient#
Auto-generated documentation for Health type annotations stubs module types-aiobotocore-health.
HealthClient#
Type annotations and code completion for session.create_client("health")
boto3 documentation
HealthClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_health.client import HealthClient
session = get_session()
async with session.create_client("health") as client:
client: HealthClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("health").exceptions
structure.
HealthClient.exceptions usage example
async with session.create_client("health") as client:
try:
do_something(client)
except (
client.ClientError,
client.ConcurrentModificationException,
client.InvalidPaginationToken,
client.UnsupportedLocale,
) as e:
print(e)
HealthClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("health").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("health").describe_affected_accounts_for_organization
method.
boto3 documentation
# describe_affected_accounts_for_organization method definition
await def describe_affected_accounts_for_organization(
self,
*,
eventArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeAffectedAccountsForOrganizationResponseTypeDef: # (1)
...
# describe_affected_accounts_for_organization method usage example with argument unpacking
kwargs: DescribeAffectedAccountsForOrganizationRequestRequestTypeDef = { # (1)
"eventArn": ...,
}
parent.describe_affected_accounts_for_organization(**kwargs)
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 session.create_client("health").describe_affected_entities
method.
boto3 documentation
# describe_affected_entities method definition
await def describe_affected_entities(
self,
*,
filter: EntityFilterTypeDef, # (1)
locale: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeAffectedEntitiesResponseTypeDef: # (2)
...
# describe_affected_entities method usage example with argument unpacking
kwargs: DescribeAffectedEntitiesRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.describe_affected_entities(**kwargs)
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 session.create_client("health").describe_affected_entities_for_organization
method.
boto3 documentation
# describe_affected_entities_for_organization method definition
await def describe_affected_entities_for_organization(
self,
*,
organizationEntityFilters: Sequence[EventAccountFilterTypeDef], # (1)
locale: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeAffectedEntitiesForOrganizationResponseTypeDef: # (2)
...
# describe_affected_entities_for_organization method usage example with argument unpacking
kwargs: DescribeAffectedEntitiesForOrganizationRequestRequestTypeDef = { # (1)
"organizationEntityFilters": ...,
}
parent.describe_affected_entities_for_organization(**kwargs)
describe_entity_aggregates#
Returns the number of entities that are affected by each of the specified events.
Type annotations and code completion for session.create_client("health").describe_entity_aggregates
method.
boto3 documentation
# describe_entity_aggregates method definition
await def describe_entity_aggregates(
self,
*,
eventArns: Sequence[str] = ...,
) -> DescribeEntityAggregatesResponseTypeDef: # (1)
...
# describe_entity_aggregates method usage example with argument unpacking
kwargs: DescribeEntityAggregatesRequestRequestTypeDef = { # (1)
"eventArns": ...,
}
parent.describe_entity_aggregates(**kwargs)
describe_event_aggregates#
Returns the number of events of each event type (issue, scheduled change, and account notification).
Type annotations and code completion for session.create_client("health").describe_event_aggregates
method.
boto3 documentation
# describe_event_aggregates method definition
await def describe_event_aggregates(
self,
*,
aggregateField: eventAggregateFieldType, # (1)
filter: EventFilterTypeDef = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeEventAggregatesResponseTypeDef: # (3)
...
# describe_event_aggregates method usage example with argument unpacking
kwargs: DescribeEventAggregatesRequestRequestTypeDef = { # (1)
"aggregateField": ...,
}
parent.describe_event_aggregates(**kwargs)
describe_event_details#
Returns detailed information about one or more specified events.
Type annotations and code completion for session.create_client("health").describe_event_details
method.
boto3 documentation
# describe_event_details method definition
await def describe_event_details(
self,
*,
eventArns: Sequence[str],
locale: str = ...,
) -> DescribeEventDetailsResponseTypeDef: # (1)
...
# describe_event_details method usage example with argument unpacking
kwargs: DescribeEventDetailsRequestRequestTypeDef = { # (1)
"eventArns": ...,
}
parent.describe_event_details(**kwargs)
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 session.create_client("health").describe_event_details_for_organization
method.
boto3 documentation
# describe_event_details_for_organization method definition
await def describe_event_details_for_organization(
self,
*,
organizationEventDetailFilters: Sequence[EventAccountFilterTypeDef], # (1)
locale: str = ...,
) -> DescribeEventDetailsForOrganizationResponseTypeDef: # (2)
...
# describe_event_details_for_organization method usage example with argument unpacking
kwargs: DescribeEventDetailsForOrganizationRequestRequestTypeDef = { # (1)
"organizationEventDetailFilters": ...,
}
parent.describe_event_details_for_organization(**kwargs)
describe_event_types#
Returns the event types that meet the specified filter criteria.
Type annotations and code completion for session.create_client("health").describe_event_types
method.
boto3 documentation
# describe_event_types method definition
await def describe_event_types(
self,
*,
filter: EventTypeFilterTypeDef = ..., # (1)
locale: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeEventTypesResponseTypeDef: # (2)
...
# describe_event_types method usage example with argument unpacking
kwargs: DescribeEventTypesRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.describe_event_types(**kwargs)
describe_events#
Returns information about events that meet the specified filter criteria.
Type annotations and code completion for session.create_client("health").describe_events
method.
boto3 documentation
# describe_events method definition
await def describe_events(
self,
*,
filter: EventFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
locale: str = ...,
) -> DescribeEventsResponseTypeDef: # (2)
...
# describe_events method usage example with argument unpacking
kwargs: DescribeEventsRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.describe_events(**kwargs)
describe_events_for_organization#
Returns information about events across your organization in Organizations.
Type annotations and code completion for session.create_client("health").describe_events_for_organization
method.
boto3 documentation
# describe_events_for_organization method definition
await def describe_events_for_organization(
self,
*,
filter: OrganizationEventFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
locale: str = ...,
) -> DescribeEventsForOrganizationResponseTypeDef: # (2)
...
# describe_events_for_organization method usage example with argument unpacking
kwargs: DescribeEventsForOrganizationRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.describe_events_for_organization(**kwargs)
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 session.create_client("health").describe_health_service_status_for_organization
method.
boto3 documentation
# describe_health_service_status_for_organization method definition
await def describe_health_service_status_for_organization(
self,
) -> DescribeHealthServiceStatusForOrganizationResponseTypeDef: # (1)
...
disable_health_service_access_for_organization#
Disables Health from working with Organizations.
Type annotations and code completion for session.create_client("health").disable_health_service_access_for_organization
method.
boto3 documentation
# disable_health_service_access_for_organization method definition
await def disable_health_service_access_for_organization(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
enable_health_service_access_for_organization#
Enables Health to work with Organizations.
Type annotations and code completion for session.create_client("health").enable_health_service_access_for_organization
method.
boto3 documentation
# enable_health_service_access_for_organization method definition
await def enable_health_service_access_for_organization(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("health").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
__aenter__#
Type annotations and code completion for session.create_client("health").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> HealthClient:
...
__aexit__#
Type annotations and code completion for session.create_client("health").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("health").get_paginator
method with overloads.
client.get_paginator("describe_affected_accounts_for_organization")
-> DescribeAffectedAccountsForOrganizationPaginatorclient.get_paginator("describe_affected_entities")
-> DescribeAffectedEntitiesPaginatorclient.get_paginator("describe_affected_entities_for_organization")
-> DescribeAffectedEntitiesForOrganizationPaginatorclient.get_paginator("describe_event_aggregates")
-> DescribeEventAggregatesPaginatorclient.get_paginator("describe_event_types")
-> DescribeEventTypesPaginatorclient.get_paginator("describe_events")
-> DescribeEventsPaginatorclient.get_paginator("describe_events_for_organization")
-> DescribeEventsForOrganizationPaginator