AWS Health

(1)

AWS Health

API Reference

API Version 2016-08-04

(2)

AWS Health: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

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

Note

• You must have a Business, Enterprise On-Ramp, 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, Enterprise On-Ramp, 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 conﬁguration. 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 aﬀected by an operational event or get notiﬁed 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.

NoteWhen 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-speciﬁc.

• 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.

This document was last published on March 6, 2022.

(7)

Actions

The following actions are supported:

• DescribeAﬀectedAccountsForOrganization (p. 3)

• DescribeAﬀectedEntities (p. 6)

• DescribeAﬀectedEntitiesForOrganization (p. 9)

• DescribeEntityAggregates (p. 13)

• DescribeEventAggregates (p. 15)

• DescribeEventDetails (p. 18)

• DescribeEventDetailsForOrganization (p. 21)

• DescribeEvents (p. 24)

• DescribeEventsForOrganization (p. 28)

• DescribeEventTypes (p. 32)

• DescribeHealthServiceStatusForOrganization (p. 35)

• DisableHealthServiceAccessForOrganization (p. 36)

• EnableHealthServiceAccessForOrganization (p. 37)

(8)

DescribeAﬀectedAccountsForOrganization

Returns a list of accounts in the organization from AWS Organizations that are aﬀected by the provided event. For more information about the diﬀerent types of AWS Health events, see Event.

Before you can call this operation, you must ﬁrst enable AWS Health to work with AWS Organizations.

To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

NoteThis API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Request Syntax

{ "eventArn": "string", "maxResults": number, "nextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 72).

The request accepts the following data in JSON format.

eventArn (p. 3)

The unique identiﬁer 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 Type: String

Length Constraints: Maximum length of 1600.

Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}

Required: Yes maxResults (p. 3)

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No nextToken (p. 3)

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

(9)

Response Syntax

request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{

"affectedAccounts": [ "string" ], "eventScopeCode": "string", "nextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

aﬀectedAccounts (p. 4)

A JSON set of elements of the aﬀected accounts.

Type: Array of strings

Pattern: ^\S+$

eventScopeCode (p. 4)

This parameter speciﬁes if the AWS Health event is a public AWS service event or an account-speciﬁc 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 aﬀected AWS accounts in your organization. For example, if an event aﬀects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response.

• If the eventScopeCode value is NONE, then the eventArn that you speciﬁed in the request is invalid or doesn't exist.

Type: String

Valid Values: PUBLIC | ACCOUNT_SPECIFIC | NONE nextToken (p. 4)

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.

(10)

Errors

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

For information about the errors that are common to all actions, see Common Errors (p. 74).

InvalidPaginationToken

The speciﬁed pagination token (nextToken) is not valid.

HTTP Status Code: 400

DescribeAﬀectedEntities

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

Note

• This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

• This operation supports resource-level permissions. You can use this operation to allow or deny access to speciﬁc AWS Health events. For more information, see Resource- and action- based conditions in the AWS Health User Guide.

Request Syntax

{

"filter": {

"entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ], "lastUpdatedTimes": [ {

"from": number, "to": number }

],

"statusCodes": [ "string" ], "tags": [

{

"string" : "string"

} ] },

"locale": "string", "maxResults": number, "nextToken": "string"

}

Request Parameters

ﬁlter (p. 6)

Values to narrow the results returned. At least one event ARN is required.

Type: EntityFilter (p. 43) object Required: Yes

(12)

Response Syntax

locale (p. 6)

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Type: String

Pattern: .{2,256}

Required: No maxResults (p. 6)

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{ "entities": [ {

"awsAccountId": "string", "entityArn": "string", "entityUrl": "string", "entityValue": "string", "eventArn": "string", "lastUpdatedTime": number, "statusCode": "string", "tags": {

"string" : "string"

} } ],

"nextToken": "string"

}

Response Elements

(13)

Errors

entities (p. 7)

The entities that match the ﬁlter criteria.

Type: Array of AﬀectedEntity (p. 39) objects nextToken (p. 7)

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

HTTP Status Code: 400 UnsupportedLocale

The speciﬁed locale is not supported.

DescribeAﬀectedEntitiesForOrganization

Returns a list of entities that have been aﬀected by one or more events for one or more accounts in your organization in AWS Organizations, based on the ﬁlter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

At least one event Amazon Resource Name (ARN) and account ID are required.

Note

• This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to speciﬁc AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.

Request Syntax

{ "locale": "string", "maxResults": number, "nextToken": "string",

"organizationEntityFilters": [ {

"awsAccountId": "string", "eventArn": "string"

} ]}

Request Parameters

locale (p. 9)

Type: String

Pattern: .{2,256}

(15)

Response Syntax

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

organizationEntityFilters (p. 9)

A JSON set of elements including the awsAccountId and the eventArn.

Type: Array of EventAccountFilter (p. 48) objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax

{ "entities": [ {

"awsAccountId": "string", "entityArn": "string", "entityUrl": "string", "entityValue": "string", "eventArn": "string", "lastUpdatedTime": number, "statusCode": "string", "tags": {

"string" : "string"

} } ],

"failedSet": [ {

"awsAccountId": "string", "errorMessage": "string", "errorName": "string", "eventArn": "string"

} ],

}

Response Elements

(16)

Errors

entities (p. 10)

A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.

Type: Array of AﬀectedEntity (p. 39) objects failedSet (p. 10)

A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.

Type: Array of OrganizationAﬀectedEntitiesErrorItem (p. 60) objects nextToken (p. 10)

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

DescribeEntityAggregates

Returns the number of entities that are aﬀected by each of the speciﬁed events.

Request Syntax

{ "eventArns": [ "string" ] }

Request Parameters

eventArns (p. 13)

A list of event ARNs (unique identiﬁers). For example: "arn:aws:health:us- east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/

EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us- west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Required: No

Response Syntax

{ "entityAggregates": [ {

"count": number, "eventArn": "string"

} ]}

Response Elements

entityAggregates (p. 13)

The number of entities that are aﬀected by each of the speciﬁed events.

(19)

Errors

Type: Array of EntityAggregate (p. 42) objects

Errors

DescribeEventAggregates

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

Request Syntax

{ "aggregateField": "string", "filter": {

"availabilityZones": [ "string" ], "endTimes": [

{

],

"entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ],

"eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTimes": [

{

],

"regions": [ "string" ], "services": [ "string" ], "startTimes": [

{

],

"tags": [ {

"string" : "string"

} ] },

"maxResults": number, "nextToken": "string"

}

Request Parameters

aggregateField (p. 15)

The only currently supported value is eventTypeCategory.

(21)

Response Syntax

Type: String

Valid Values: eventTypeCategory Required: Yes

ﬁlter (p. 15)

Values to narrow the results returned.

Type: EventFilter (p. 53) object Required: No

maxResults (p. 15)

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{ "eventAggregates": [ {

"aggregateValue": "string", "count": number

} ],

}

Response Elements

eventAggregates (p. 16)

The number of events in each category that meet the optional ﬁlter criteria.

(22)

Errors

Type: Array of EventAggregate (p. 49) objects nextToken (p. 16)

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

DescribeEventDetails

Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a speciﬁed event can't be retrieved, an error message is returned for that event.

NoteThis operation supports resource-level permissions. You can use this operation to allow or deny access to speciﬁc AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.

Request Syntax

{

"eventArns": [ "string" ], "locale": "string"

}

Request Parameters

eventArns (p. 18)

Required: Yes locale (p. 18)

Type: String

Pattern: .{2,256}

Required: No

(24)

Response Syntax

{ "failedSet": [ {

"errorMessage": "string", "errorName": "string", "eventArn": "string"

} ],

"successfulSet": [ {

"event": {

"arn": "string",

"availabilityZone": "string", "endTime": number,

"eventScopeCode": "string", "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string"

},

"eventDescription": {

"latestDescription": "string"

},

"eventMetadata": { "string" : "string"

} } ]}

Response Elements

failedSet (p. 19)

Error messages for any events that could not be retrieved.

Type: Array of EventDetailsErrorItem (p. 52) objects successfulSet (p. 19)

Information about the events that could be retrieved.

Type: Array of EventDetails (p. 51) objects

Errors

UnsupportedLocale

(25)

DescribeEventDetailsForOrganization

Returns detailed information about one or more specified events for one or more AWS accounts in your organization. This information includes standard event data (such as the AWS 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.

NoteBefore you can call this operation, you must ﬁrst enable AWS Health to work with AWS 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 AWS Health event type, note the following diﬀerences:

• 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, AWS Health returns an error message because public events aren't speciﬁc to an account.

• To return event details for an event that is speciﬁc to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, AWS Health returns an error message because the event is speciﬁc to an account in your organization.

For more information, see Event.

NoteThis operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to speciﬁc AWS Health events. For more information, see Resource- and action- based conditions in the AWS Health User Guide.

Request Syntax

{ "locale": "string",

"organizationEventDetailFilters": [ {

"awsAccountId": "string", "eventArn": "string"

} ] }

Request Parameters

locale (p. 21)

Type: String

(27)

Response Syntax

Pattern: .{2,256}

Required: No

organizationEventDetailFilters (p. 21)

A set of JSON elements that includes the awsAccountId and the eventArn.

Type: Array of EventAccountFilter (p. 48) objects

Required: Yes

Response Syntax

{

"failedSet": [ {

"awsAccountId": "string", "errorMessage": "string", "errorName": "string", "eventArn": "string"

} ],

"successfulSet": [ {

"awsAccountId": "string", "event": {

"arn": "string",

"eventScopeCode": "string", "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string"

},

"eventDescription": {

"latestDescription": "string"

},

"eventMetadata": { "string" : "string"

} } ]}

Response Elements

failedSet (p. 22)

Error messages for any events that could not be retrieved.

(28)

Errors

Type: Array of OrganizationEventDetailsErrorItem (p. 67) objects successfulSet (p. 22)

Information about the events that could be retrieved.

Type: Array of OrganizationEventDetails (p. 65) objects

Errors

UnsupportedLocale

DescribeEvents

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no ﬁlter criteria are speciﬁed, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

Note

• When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

Request Syntax

{ "filter": {

"availabilityZones": [ "string" ], "endTimes": [

{

],

"entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ],

"eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTimes": [

{

],

"regions": [ "string" ], "services": [ "string" ], "startTimes": [

{

],

"tags": [ {

"string" : "string"

} ] },

"locale": "string", "maxResults": number,

(30)

Request Parameters

}

Request Parameters

ﬁlter (p. 24)

Type: EventFilter (p. 53) object Required: No

locale (p. 24)

Type: String

Pattern: .{2,256}

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{

"events": [ {

(31)

Response Elements

"arn": "string",

"eventScopeCode": "string", "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string",

"service": "string", "startTime": number, "statusCode": "string"

} ],

}

Response Elements

events (p. 25)

The events that match the speciﬁed ﬁlter criteria.

Type: Array of Event (p. 45) objects nextToken (p. 25)

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

DescribeEventsForOrganization

Returns information about events across your organization in AWS 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 aﬀected accounts, detailed description, any additional metadata that depends on the event type, or any aﬀected resources. To retrieve that information, use the following operations:

• DescribeAﬀectedAccountsForOrganization

• DescribeEventDetailsForOrganization

• DescribeAﬀectedEntitiesForOrganization

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 diﬀerent types of AWS Health events, see Event.

Request Syntax

{ "filter": {

"awsAccountIds": [ "string" ], "endTime": {

"from": number, "to": number },

"entityArns": [ "string" ], "entityValues": [ "string" ], "eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTime": {

"from": number, "to": number },

"regions": [ "string" ], "services": [ "string" ], "startTime": {

},

}

(34)

Request Parameters

ﬁlter (p. 28)

Type: OrganizationEventFilter (p. 69) object Required: No

locale (p. 28)

Type: String

Pattern: .{2,256}

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{

"events": [ {

"arn": "string", "endTime": number,

"eventScopeCode": "string",

(35)

Response Elements

"eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string",

"service": "string", "startTime": number, "statusCode": "string"

} ],

}

Response Elements

events (p. 29)

The events that match the speciﬁed ﬁlter criteria.

Type: Array of OrganizationEvent (p. 62) objects nextToken (p. 29)

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

DescribeEventTypes

Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object.

If you don't specify a ﬁlter criteria, the API operation returns all event types, in no particular order.

Request Syntax

{ "filter": {

"eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "services": [ "string" ] },

}

Request Parameters

ﬁlter (p. 32)

Type: EventTypeFilter (p. 59) object Required: No

locale (p. 32)

Type: String

Pattern: .{2,256}

NoteIf you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.

(38)

Response Syntax

Type: Integer

Type: String

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{ "eventTypes": [ {

"category": "string", "code": "string", "service": "string"

} ],

}

Response Elements

eventTypes (p. 33)

A list of event types that match the ﬁlter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS,

DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

Type: Array of EventType (p. 57) objects nextToken (p. 33)

Type: String

(39)

Errors

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

DescribeHealthServiceStatusForOrganization

This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account.

Response Syntax

{

"healthServiceAccessStatusForOrganization": "string"

}

Response Elements

healthServiceAccessStatusForOrganization (p. 35)

Information about the status of enabling or disabling the AWS Health organizational view feature in your organization.

Valid values are ENABLED | DISABLED | PENDING.

Type: String

Errors

DisableHealthServiceAccessForOrganization

Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.

This operation doesn't remove the service-linked role from the management account in your

organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide.

NoteYou can also disable the organizational feature by using the Organizations

DisableAWSServiceAccess API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

ConcurrentModiﬁcationException

EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

EnableHealthServiceAccessForOrganization

Enables AWS Health to work with AWS Organizations. You can use the organizational view feature to aggregate events from all AWS accounts in your organization in a centralized location.

This operation also creates a service-linked role for the management account in the organization.

NoteTo call this operation, you must meet the following requirements:

• You must have a Business, Enterprise On-Ramp, 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, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

• You must have permission to call this operation from the organization's management account.

For example IAM policies, see AWS Health identity-based policy examples.

If you don't have the required support plan, you can instead use the AWS Health console to enable the organizational view feature. For more information, see Aggregating AWS Health events in the AWS Health User Guide.

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

ConcurrentModiﬁcationException

EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

Data Types

The AWS Health API contains several data types that various actions use. This section describes each data type in detail.

Note

The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:

• AﬀectedEntity (p. 39)

• DateTimeRange (p. 41)

• EntityAggregate (p. 42)

• EntityFilter (p. 43)

• Event (p. 45)

• EventAccountFilter (p. 48)

• EventAggregate (p. 49)

• EventDescription (p. 50)

• EventDetails (p. 51)

• EventDetailsErrorItem (p. 52)

• EventFilter (p. 53)

• EventType (p. 57)

• EventTypeFilter (p. 59)

• OrganizationAﬀectedEntitiesErrorItem (p. 60)

• OrganizationEvent (p. 62)

• OrganizationEventDetails (p. 65)

• OrganizationEventDetailsErrorItem (p. 67)

• OrganizationEventFilter (p. 69)

(44)

AﬀectedEntity

Information about an entity that is aﬀected by a Health event.

DateTimeRange

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.

EntityAggregate

The number of entities that are aﬀected by one or more events. Returned by the DescribeEntityAggregates operation.

EntityFilter

The values to use to ﬁlter results from the DescribeAﬀectedEntities operation.

Event

Summary information about an AWS Health event.

AWS Health events can be public or account-speciﬁc:

• Public events might be service events that are not speciﬁc to an AWS account. For example, if there is an issue with an AWS Region, AWS 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 AWS 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, AWS Health provides information about the event and the affected resources in the account.

You can determine if an event is public or account-speciﬁc by using the eventScopeCode parameter. For more information, see eventScopeCode.

AWS Health

AWS Health

API Reference

API Version 2016-08-04

AWS Health: API Reference

Table of Contents

Welcome

Actions

DescribeAﬀectedAccountsForOrganization

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeAﬀectedEntities

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeAﬀectedEntitiesForOrganization

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEntityAggregates

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEventAggregates

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEventDetails

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEventDetailsForOrganization

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEvents

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEventsForOrganization

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeEventTypes

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeHealthServiceStatusForOrganization

Response Syntax