The Health API provides programmatic access to the Health information that appears in the Personal Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web Services services and resources.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.
You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. 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 Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API in the Health User Guide.
For authentication of requests, Health uses the Signature Version 4 Signing Process.
If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate 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 Health events in the Health User Guide.
When you use the Health API operations to return Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return 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.
Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:
To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.
To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.
For more information, see Event.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
awsAccountId and the eventArn.
locale:
allOf:
- $ref: '#/components/schemas/locale'
- description: The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Event:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/eventArn'
- description: The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
EC2, RDS.
eventTypeCode:
allOf:
- $ref: '#/components/schemas/eventTypeCode'
- description: The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
eventTypeCategory:
allOf:
- $ref: '#/components/schemas/eventTypeCategory'
- description: A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
region:
allOf:
- $ref: '#/components/schemas/region'
- description: The Amazon Web Services Region name of the event.
availabilityZone:
allOf:
- $ref: '#/components/schemas/availabilityZone'
- description: The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
startTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The date and time that the event began.
endTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The date and time that the event ended.
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The most recent date and time that the event was updated.
statusCode:
allOf:
- $ref: '#/components/schemas/eventStatusCode'
- description: The most recent status of the event. Possible values are open, closed, and upcoming.
eventScopeCode:
allOf:
- $ref: '#/components/schemas/eventScopeCode'
- description: This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.
If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
Summary information about an Health event.
Health events can be public or account-specific:
Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.
Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.
You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
A message that describes the error.
If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:
We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.