Health class

The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard. You can use the API operations to get information about AWS Health events that affect your AWS services and resources. AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.

Constructors

Health({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
describeAffectedAccountsForOrganization({required String eventArn, int? maxResults, String? nextToken}) → Future<DescribeAffectedAccountsForOrganizationResponse>
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.
describeAffectedEntities({required EntityFilter filter, String? locale, int? maxResults, String? nextToken}) → Future<DescribeAffectedEntitiesResponse>
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
describeAffectedEntitiesForOrganization({required List<EventAccountFilter> organizationEntityFilters, String? locale, int? maxResults, String? nextToken}) → Future<DescribeAffectedEntitiesForOrganizationResponse>
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.
describeEntityAggregates({List<String>? eventArns}) → Future<DescribeEntityAggregatesResponse>
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
describeEventAggregates({required EventAggregateField aggregateField, EventFilter? filter, int? maxResults, String? nextToken}) → Future<DescribeEventAggregatesResponse>
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
describeEventDetails({required List<String> eventArns, String? locale}) → Future<DescribeEventDetailsResponse>
Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation.
describeEventDetailsForOrganization({required List<EventAccountFilter> organizationEventDetailFilters, String? locale}) → Future<DescribeEventDetailsForOrganizationResponse>
Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
describeEvents({EventFilter? filter, String? locale, int? maxResults, String? nextToken}) → Future<DescribeEventsResponse>
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
describeEventsForOrganization({OrganizationEventFilter? filter, String? locale, int? maxResults, String? nextToken}) → Future<DescribeEventsForOrganizationResponse>
Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
describeEventTypes({EventTypeFilter? filter, String? locale, int? maxResults, String? nextToken}) → Future<DescribeEventTypesResponse>
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
describeHealthServiceStatusForOrganization() → Future<DescribeHealthServiceStatusForOrganizationResponse>
This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
disableHealthServiceAccessForOrganization() → Future<void>
Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master AWS account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
enableHealthServiceAccessForOrganization() → Future<void>
Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited