Supported operations in Amazon Health - 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 (PDF).

Supported operations in Amazon Health

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

  • The event types supported by Amazon 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. That is, they retrieve data but do not modify it. The following sections summarize the Amazon Health operations:

Event types

The DescribeEventTypes operation retrieves event types that match the optional specified filter. An event type is a template definition of an event's Amazon 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 Amazon Health grows over time.

Events

The DescribeEvents operation retrieves summary information about events that are related to an Amazon account. The events can be related to Amazon operational issues, scheduled changes to Amazon infrastructure, or security and billing notifications. The DescribeEventDetails operation retrieves detailed information about one or more events, such as the Amazon 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, such as status, that might be assigned to Amazon 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.

DescribeHealthServiceStatusForOrganization

DescribeHealthServiceStatusForOrganization operation provides status information on enabling or disabling Amazon Health to work with your organization

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