Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
", + "documentation": "Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
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. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
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. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
This API operation uses pagination. Specify the nextToken parameter 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 AWS Organizations, based on the filter 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 ARN and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
", + "documentation": "Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter 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. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
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.
", + "documentation": "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.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns detailed information about one or more specified events. Information includes standard event data (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 those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
", + "documentation": "Returns detailed information about one or more specified events. Information includes standard event data (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 those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
", "idempotent": true }, "DescribeEventDetailsForOrganization": { @@ -151,7 +151,7 @@ "shape": "UnsupportedLocale" } ], - "documentation": "Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization, a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
", + "documentation": "Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
When you call the DescribeEventDetailsForOrganization operation, you specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences:
If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.
If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization.
For more information, see Event.
", "idempotent": true }, "DescribeEventTypes": { @@ -174,7 +174,7 @@ "shape": "UnsupportedLocale" } ], - "documentation": "Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
", + "documentation": "Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
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 filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.
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 filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.
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.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeAffectedAccountsForOrganization, DescribeEventDetailsForOrganization, and DescribeAffectedEntitiesForOrganization operations.
If no filter criteria are specified, all events across your organization are returned. Results are sorted by lastModifiedTime, starting with the most recent.
Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
", + "documentation": "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 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 AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master AWS account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Calling this operation disables Health from working with AWS Organizations. This does not remove the Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API, or AWS CLI to remove the SLR if desired. 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 master account.
", + "documentation": "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 master AWS account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
This operation doesn't remove the service-linked role (SLR) from the AWS master account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
You 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.
Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service Linked Role (SLR) to the master account in the organization. To learn more about the steps in this process, visit enabling service access for AWS Health in AWS Organizations. 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 master account.
", + "documentation": "Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the 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 master account.
For more information, see Aggregating AWS Health events in the AWS Health User Guide.
", "idempotent": true } }, @@ -298,7 +298,7 @@ }, "tags": { "shape": "tagSet", - "documentation": "A map of entity tags attached to the affected entity.
" + "documentation": "A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
Information about an entity that is affected by a Health event.
" @@ -315,7 +315,7 @@ "documentation": "The ending date and time of a time range.
" } }, - "documentation": "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.
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.
A JSON set of elements of the affected accounts.
" }, "eventScopeCode": { - "shape": "eventScopeCode" + "shape": "eventScopeCode", + "documentation": "This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects 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 specified in the request is invalid or doesn't exist.
A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, statusCode, and tags.
A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.
The number entities that match the criteria for the specified events.
" + "documentation": "The number of entities that match the criteria for the specified events.
" } }, - "documentation": "The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
" + "documentation": "The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
" }, "EntityAggregateList": { "type": "list", @@ -729,14 +730,14 @@ }, "tags": { "shape": "tagFilter", - "documentation": "A map of entity tags attached to the affected entity.
" + "documentation": "A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
The values to use to filter results from the DescribeAffectedEntities operation.
" + "documentation": "The values to use to filter results from the EntityFilter operation.
" }, "EntityList": { "type": "list", @@ -788,10 +789,11 @@ "documentation": "The most recent status of the event. Possible values are open, closed, and upcoming.
This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects 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 specified in the request is invalid or doesn't exist.
Summary information about an AWS Health event.
" + "documentation": "Summary information about an AWS Health event.
AWS Health events can be public or account-specific:
Public events might be service events that are not specific 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-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.
The 12-digit AWS account numbers that contains the affected entities.
" } }, - "documentation": "The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
" + "documentation": "The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
" }, "EventAggregate": { "type": "structure", @@ -822,7 +824,7 @@ "documentation": "The number of events of the associated issue type.
" } }, - "documentation": "The number of events of each issue type. Returned by the DescribeEventAggregates operation.
" + "documentation": "The number of events of each issue type. Returned by the DescribeEventAggregates operation.
" }, "EventAggregateList": { "type": "list", @@ -846,7 +848,7 @@ "documentation": "The most recent description of the event.
" } }, - "documentation": "The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
" + "documentation": "The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
" }, "EventDetails": { "type": "structure", @@ -864,7 +866,7 @@ "documentation": "Additional metadata about the event.
" } }, - "documentation": "Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
" + "documentation": "Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
" }, "EventDetailsErrorItem": { "type": "structure", @@ -882,7 +884,7 @@ "documentation": "A message that describes the error.
" } }, - "documentation": "Error information returned when a DescribeEventDetails operation cannot find a specified event.
" + "documentation": "Error information returned when a DescribeEventDetails operation cannot find a specified event.
" }, "EventFilter": { "type": "structure", @@ -933,14 +935,14 @@ }, "tags": { "shape": "tagFilter", - "documentation": "A map of entity tags attached to the affected entity.
" + "documentation": "A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
A list of event status codes.
" } }, - "documentation": "The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
" + "documentation": "The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
" }, "EventList": { "type": "list", @@ -998,7 +1000,7 @@ "documentation": "A list of event type category codes (issue, scheduledChange, or accountNotification).
The values to use to filter results from the DescribeEventTypes operation.
" + "documentation": "The values to use to filter results from the DescribeEventTypes operation.
" }, "EventTypeList": { "type": "list", @@ -1026,7 +1028,7 @@ "documentation": "The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.
" + "documentation": "Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.
" }, "OrganizationEntityFiltersList": { "type": "list", @@ -1056,7 +1058,8 @@ "documentation": "The category of the event type.
" }, "eventScopeCode": { - "shape": "eventScopeCode" + "shape": "eventScopeCode", + "documentation": "This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects 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 specified in the request is invalid or doesn't exist.
The most recent status of the event. Possible values are open, closed, and upcoming.
Summary information about an event, returned by the DescribeEventsForOrganization operation.
" + "documentation": "Summary information about an event, returned by the DescribeEventsForOrganization operation.
" }, "OrganizationEventDetailFiltersList": { "type": "list", @@ -1107,14 +1110,14 @@ "documentation": "Additional metadata about the event.
" } }, - "documentation": "Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.
" + "documentation": "Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.
" }, "OrganizationEventDetailsErrorItem": { "type": "structure", "members": { "awsAccountId": { "shape": "accountId", - "documentation": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
" + "documentation": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
" }, "eventArn": { "shape": "eventArn", @@ -1129,7 +1132,7 @@ "documentation": "A message that describes the error.
" } }, - "documentation": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
" + "documentation": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
" }, "OrganizationEventFilter": { "type": "structure", @@ -1161,7 +1164,7 @@ }, "entityArns": { "shape": "entityArnList", - "documentation": "REPLACEME
" + "documentation": "A list of entity ARNs (unique identifiers).
" }, "entityValues": { "shape": "entityValueList", @@ -1169,14 +1172,14 @@ }, "eventTypeCategories": { "shape": "eventTypeCategoryList", - "documentation": "REPLACEME
" + "documentation": "A list of event type category codes (issue, scheduledChange, or accountNotification).
" }, "eventStatusCodes": { "shape": "eventStatusCodeList", "documentation": "A list of event status codes.
" } }, - "documentation": "The values to filter results from the DescribeEventsForOrganization operation.
" + "documentation": "The values to filter results from the DescribeEventsForOrganization operation.
" }, "OrganizationEventList": { "type": "list", @@ -1458,5 +1461,5 @@ "type": "timestamp" } }, - "documentation": "The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:
DescribeEvents: Summary information about events.
DescribeEventDetails: Detailed information about one or more events.
DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.
In addition, these operations provide information about event types and summary counts of events or affected entities:
DescribeEventTypes: Information about the kinds of events that AWS Health tracks.
DescribeEventAggregates: A count of the number of events that meet specified criteria.
DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.
AWS Health integrates with AWS Organizations to provide a centralized view of AWS Health events across all accounts in your organization.
DescribeEventsForOrganization: Summary information about events across the organization.
DescribeAffectedAccountsForOrganization: List of accounts in your organization impacted by an event.
DescribeEventDetailsForOrganization: Detailed information about events in your organization.
DescribeAffectedEntitiesForOrganization: Information about AWS resources in your organization that are affected by events.
You can use the following operations to enable or disable AWS Health from working with AWS Organizations.
EnableHealthServiceAccessForOrganization: Enables AWS Health to work with AWS Organizations.
DisableHealthServiceAccessForOrganization: Disables AWS Health from working with AWS Organizations.
DescribeHealthServiceStatusForOrganization: Status information about enabling or disabling AWS Health from working with AWS Organizations.
The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
See the AWS Health User Guide for information about how to use the API.
Service Endpoint
The HTTP endpoint for the AWS Health API is:
https://health.us-east-1.amazonaws.com
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.
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.
AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.
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.
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.