Welcome - Amazon Health
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Welcome

The Amazon Health API provides programmatic access to the Amazon Health information that appears in the Amazon Health Dashboard. You can use the API operations to get information about events that might affect your Amazon services and resources.

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Amazon Health API. If you call the Amazon Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

You can use the Amazon Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Amazon Health API operations. Amazon Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Amazon Health API in the Amazon Health User Guide.

For authentication of requests, Amazon Health uses the Signature Version 4 Signing Process.

If your Amazon Web Services account is part of Amazon Organizations, you can use the Amazon Health organizational view feature. This feature provides a centralized view of Amazon Health events across all accounts in your organization. You can aggregate Amazon 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 Amazon Health events in the Amazon Health User Guide.

Note

When you use the Amazon Health API operations to return Amazon Health events, see the following recommendations:

  • Use the eventScopeCode parameter to specify whether to return Amazon Health events that are public or account-specific.

  • Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.

This document was last published on November 17, 2022.