Menu
AWS Health
User Guide

Accessing the AWS Health API

AWS Health is a RESTful web service that uses HTTPS as a transport and JavaScript Object Notation (JSON) as a message serialization format. Your application code can make requests directly to the AWS Health web service API. When using the REST API directly, you must write the necessary code to sign and authenticate your requests. For more information about the API, see the AWS Health API Reference.

Note

You must have a Business or Enterprise support plan to use the AWS Health API.

Alternatively, you can simplify application development by using the AWS SDKs that wrap the AWS Health REST API calls. You provide your credentials, and these libraries take care of authentication and request signing.

AWS Health also provides a Personal Health Dashboard in the AWS Management Console that is available to all AWS customers. You can use the Personal Health Dashboard to view and search for events and affected entities.

Endpoints

AWS Health has a single global endpoint: https://health.us-east-1.amazonaws.com

You can view events in specific AWS regions by using the filters supported by the API. For more information about AWS endpoints and regions for all services, see AWS Regions and Endpoints in the AWS General Reference.

Signing AWS Health API Requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS root account credentials for regular access to AWS Health. You can use the credentials for an IAM user.

To sign your API requests, we recommend using AWS Signature Version 4. For more information, see Signing AWS API Requests in the AWS General Reference.