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 a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.
At least one event Amazon Resource Name (ARN) and account ID are required.
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.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
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.
arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K '
eventArn:
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
IMPAIRED, UNIMPAIRED, and UNKNOWN.
tags:
allOf:
- $ref: '#/components/schemas/tagSet'
- description: A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
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
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
AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
description: Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
DescribeAffectedEntitiesForOrganizationFailedSet:
type: array
items:
$ref: '#/components/schemas/OrganizationAffectedEntitiesErrorItem'
maxResultsLowerRange:
type: integer
minimum: 1
maximum: 100
DescribeAffectedEntitiesForOrganizationRequest:
type: object
required:
- organizationEntityFilters
title: DescribeAffectedEntitiesForOrganizationRequest
properties:
organizationEntityFilters:
allOf:
- $ref: '#/components/schemas/OrganizationEntityFiltersList'
- description: A JSON set of elements including the 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.
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
maxResults:
allOf:
- $ref: '#/components/schemas/maxResultsLowerRange'
- description: The maximum number of items to return in one batch, between 10 and 100, inclusive.
entityUrl:
type: string
EntityList:
type: array
items:
$ref: '#/components/schemas/AffectedEntity'
tagSet:
type: object
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/tagValue'
tagValue:
type: string
pattern: .{0,255}
maxLength: 255
InvalidPaginationToken: {}
DescribeAffectedEntitiesForOrganizationResponse:
type: object
properties:
entities:
allOf:
- $ref: '#/components/schemas/EntityList'
- description: A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.
failedSet:
allOf:
- $ref: '#/components/schemas/DescribeAffectedEntitiesForOrganizationFailedSet'
- description: A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
UnsupportedLocale: {}
string:
type: string
eventArn:
type: string
pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
maxLength: 1600
locale:
type: string
pattern: .{2,256}
minLength: 2
maxLength: 256
entityStatusCode:
type: string
enum:
- IMPAIRED
- UNIMPAIRED
- UNKNOWN
OrganizationEntityFiltersList:
type: array
items:
$ref: '#/components/schemas/EventAccountFilter'
minItems: 1
maxItems: 10
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/health/
x-hasEquivalentPaths: true