Supported operations in AWS Health - AWS Health

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. That is, 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 is 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 grows 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, such as status, that might be 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.

AWS Organizations and Organization View

DescribeEventsForOrganization

DescribeEventsForOrganization returns summary information about events across the AWS Organizations, meeting the specified filter criteria.

DescribeAffectedAccountsForOrganization

DescribeAffectedAccountsForOrganization returns a list of AWS accounts in the AWS Organizations that are affected by the provided event.

DescribeEventDetailsForOrganization

DescribeEventDetailsForOrganization returns detailed information about one or more specified events for one or more accounts in AWS Organizations.

DescribeAffectedEntitiesForOrganization

DescribeAffectedEntitiesForOrganization returns a list of entities that have been affected by one or more events for one or more accounts in your organization, based on the filter criteria.

EnableHealthServiceAccessForOrganization

EnableHealthServiceAccessForOrganization operation grants the AWS Health service permission to interact with AWS Organizations on the customer’s behalf and applies a Service Linked Role to the management account in your organization.

DisableHealthServiceAccessForOrganization

DisableHealthServiceAccessForOrganization operation revokes permission for the AWS Health service to interact with AWS Organizations on the customer's behalf.

DescribeHealthServiceStatusForOrganization

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

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