Menu
AWS Health
User Guide

Supported Operations in AWS Health

AWS Health supports the following operations for getting information about events that affect an AWS account:

  • The event types supported by AWS Health.

  • Information about one or more events that match specified filter criteria.

  • Information about the entities that are affected by one or more events.

  • Categorized counts of events or entities that match specified filter criteria.

All operations are non-mutating; they retrieve data but do not modify it. The following sections summarize the AWS Health operations:

Event Types

The DescribeEventTypes operation retrieves event types that match the optional specified filter. An event type can be understood as a template definition of an event's AWS service, event type code, and category. An event type and event are similar to a class and object in object-oriented programming. The number of event types supported by AWS Health is expected to grow over time.

Events

The DescribeEvents operation retrieves summary information about events that are related to an AWS account. The events can be related to AWS operational issues, scheduled changes to AWS infrastructure, or security and billing notifications. The DescribeEventDetails operation retrieves detailed information about one or more events, such as the AWS service, region, Availability Zone, event start and end times, and a text description.

Affected Entities

The DescribeAffectedEntities operation retrieves information about entities that are affected by one or more events. The results can be filtered by additional criteria, including status and tags that might have been assigned to AWS resources.

Aggregation

The DescribeEventAggregates operation retrieves a count of the events in each event type category, optionally filtered by other criteria. The DescribeEntityAggregates operation retrieves a count of the entities (resources) that are affected by one or more specified events.

For more information about these operations, see the AWS Health API Reference.