[ aws ]

health

Description

The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard . You can use the API operations to get information about AWS Health events that affect your AWS services and resources.

Note

• You must have a Business or Enterprise Support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn’t have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error.

• You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the AWS Health API operations. AWS Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which AWS Region is active, so that you can get the latest information from the API. For more information, see Accessing the AWS Health API in the AWS Health User Guide .

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process .

If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating AWS Health events in the AWS Health User Guide .

Note

When you use the AWS Health API operations to return AWS Health events, see the following recommendations:

• Use the eventScopeCode parameter to specify whether to return AWS Health events that are public or account-specific.

• Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.

Available Commands

• describe-affected-accounts-for-organization
• describe-affected-entities
• describe-affected-entities-for-organization
• describe-entity-aggregates
• describe-event-aggregates
• describe-event-details
• describe-event-details-for-organization
• describe-event-types
• describe-events
• describe-events-for-organization
• describe-health-service-status-for-organization
• disable-health-service-access-for-organization
• enable-health-service-access-for-organization