The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:
DescribeEvents: Summary information about events.
DescribeEventDetails: Detailed information about one or more events.
DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.
In addition, these operations provide information about event types and summary counts of events or affected entities:
DescribeEventTypes: Information about the kinds of events that AWS Health tracks.
DescribeEventAggregates: A count of the number of events that meet specified criteria.
DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.
The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
See the AWS Health User Guide for information about how to use the API.
The HTTP endpoint for the AWS Health API is:
A client for the AWSHealth API.
Information about an entity that is affected by a Health event.
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
The values to use to filter results from the DescribeAffectedEntities operation.
Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.
The number of events of each issue type. Returned by the DescribeEventAggregates operation.
Error information returned when a DescribeEventDetails operation cannot find a specified event.
The values to use to filter results from the DescribeEventTypes operation.
Errors returned by DescribeAffectedEntities
Errors returned by DescribeEntityAggregates
Errors returned by DescribeEventAggregates
Errors returned by DescribeEventDetails
Errors returned by DescribeEventTypes
Errors returned by DescribeEvents
Trait representing the capabilities of the AWSHealth API. AWSHealth clients implement this trait.