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.
You must have a Business or Enterprise support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise support plan, you receive a
AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
When you use the AWS Health API operations to return AWS Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return AWS Health events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call the
DescribeEventsForOrganizationoperation to get all events in your organization, you might receive several page results. Specify the
nextTokenin the next request to return more results.
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 EntityFilter operation.
Summary information about an AWS Health event.
AWS Health events can be public or account-specific:
You can determine if an event is public or account-specific by using the
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.
Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.
Summary information about an event, returned by the DescribeEventsForOrganization operation.
Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.
Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
The values to filter results from the DescribeEventsForOrganization operation.
Errors returned by DescribeAffectedAccountsForOrganization
Errors returned by DescribeAffectedEntities
Errors returned by DescribeAffectedEntitiesForOrganization
Errors returned by DescribeEntityAggregates
Errors returned by DescribeEventAggregates
Errors returned by DescribeEventDetails
Errors returned by DescribeEventDetailsForOrganization
Errors returned by DescribeEventTypes
Errors returned by DescribeEvents
Errors returned by DescribeEventsForOrganization
Errors returned by DescribeHealthServiceStatusForOrganization
Errors returned by DisableHealthServiceAccessForOrganization
Errors returned by EnableHealthServiceAccessForOrganization
Trait representing the capabilities of the AWSHealth API. AWSHealth clients implement this trait.