Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws ]

health

Description

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:

  • describe-events : Summary information about events.
  • describe-event-details : Detailed information about one or more events.
  • describe-affected-entities : 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:

  • describe-event-types : Information about the kinds of events that AWS Health tracks.
  • describe-event-aggregates : A count of the number of events that meet specified criteria.
  • describe-entity-aggregates : 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 SubscriptionRequiredException .

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.

Service Endpoint

The HTTP endpoint for the AWS Health API is: