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 information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.
For more information about the different types of Health events, see Event.
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.
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.
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.
eventStatusCode:
type: string
enum:
- open
- closed
- upcoming
entityValueList:
type: array
items:
$ref: '#/components/schemas/entityValue'
minItems: 1
maxItems: 99
eventTypeList:
type: array
items:
$ref: '#/components/schemas/eventType'
minItems: 1
maxItems: 10
entityArn:
type: string
pattern: .{0,1600}
maxLength: 1600
DescribeEventsForOrganizationResponse:
type: object
properties:
events:
allOf:
- $ref: '#/components/schemas/OrganizationEventList'
- description: The events that match the specified filter criteria.
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.
timestamp:
type: string
format: date-time
region:
type: string
pattern: '[^:/]{2,25}'
minLength: 2
maxLength: 25
eventTypeCode:
type: string
pattern: '[a-zA-Z0-9\_\-]{3,100}'
minLength: 3
maxLength: 100
nextToken:
type: string
pattern: '[a-zA-Z0-9=/+_.-]{4,10000}'
minLength: 4
maxLength: 10000
eventTypeCategory:
type: string
enum:
- issue
- accountNotification
- scheduledChange
- investigation
minLength: 3
maxLength: 255
OrganizationEventList:
type: array
items:
$ref: '#/components/schemas/OrganizationEvent'
OrganizationEvent:
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
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.
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.
open, closed, and upcoming.
description: Summary information about an event, returned by the DescribeEventsForOrganization operation.
entityValue:
type: string
pattern: .{0,1224}
maxLength: 1224
awsAccountIdsList:
type: array
items:
$ref: '#/components/schemas/accountId'
minItems: 1
maxItems: 50
serviceList:
type: array
items:
$ref: '#/components/schemas/service'
minItems: 1
maxItems: 10
DateTimeRange:
type: object
properties:
from:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The starting date and time of a time range.
to:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The ending date and time of a time range.
description: 'A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.'
maxResultsLowerRange:
type: integer
minimum: 1
maximum: 100
regionList:
type: array
items:
$ref: '#/components/schemas/region'
minItems: 1
maxItems: 10
eventType:
type: string
pattern: '[^:/]{3,100}'
minLength: 3
maxLength: 100
eventStatusCodeList:
type: array
items:
$ref: '#/components/schemas/eventStatusCode'
minItems: 1
maxItems: 6
eventTypeCategoryList:
type: array
items:
$ref: '#/components/schemas/eventTypeCategory'
minItems: 1
maxItems: 10
UnsupportedLocale: {}
entityArnList:
type: array
items:
$ref: '#/components/schemas/entityArn'
minItems: 1
maxItems: 99
service:
type: string
pattern: '[^:/]{2,30}'
minLength: 2
maxLength: 30
OrganizationEventFilter:
type: object
properties:
eventTypeCodes:
allOf:
- $ref: '#/components/schemas/eventTypeList'
- description: 'A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". '
awsAccountIds:
allOf:
- $ref: '#/components/schemas/awsAccountIdsList'
- description: A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
services:
allOf:
- $ref: '#/components/schemas/serviceList'
- description: The Amazon Web Services services associated with the event. For example, EC2, RDS.
regions:
allOf:
- $ref: '#/components/schemas/regionList'
- description: A list of Amazon Web Services Regions.
startTime:
$ref: '#/components/schemas/DateTimeRange'
endTime:
$ref: '#/components/schemas/DateTimeRange'
lastUpdatedTime:
$ref: '#/components/schemas/DateTimeRange'
entityArns:
allOf:
- $ref: '#/components/schemas/entityArnList'
- description: A list of entity ARNs (unique identifiers).
entityValues:
allOf:
- $ref: '#/components/schemas/entityValueList'
- description: A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
eventTypeCategories:
allOf:
- $ref: '#/components/schemas/eventTypeCategoryList'
- 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.
eventStatusCodes:
allOf:
- $ref: '#/components/schemas/eventStatusCodeList'
- description: A list of event status codes.
description: The values to filter results from the DescribeEventsForOrganization operation.
InvalidPaginationToken: {}
locale:
type: string
pattern: .{2,256}
minLength: 2
maxLength: 256
eventArn:
type: string
pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
maxLength: 1600
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
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