Returns a list of accounts in the organization from Organizations that are affected by the provided 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.
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 Amazon Web 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.
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 specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
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 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.
Returns the number of entities that are affected by each of the specified events.
", "idempotent": true }, "DescribeEntityAggregatesForOrganization": { "name": "DescribeEntityAggregatesForOrganization", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEntityAggregatesForOrganizationRequest" }, "output": { "shape": "DescribeEntityAggregatesForOrganizationResponse" }, "documentation": "Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
", "idempotent": true }, "DescribeEventAggregates": { "name": "DescribeEventAggregates", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEventAggregatesRequest" }, "output": { "shape": "DescribeEventAggregatesResponse" }, "errors": [ { "shape": "InvalidPaginationToken" } ], "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 (Amazon Web Services 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 specified event can't be retrieved, an error message is returned for that event.
This operation supports resource-level permissions. You can 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.
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.
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, 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 event.
When you call the DescribeEvents operation and specify an entity for the entityValues parameter, 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, 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 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.
This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
", "idempotent": true }, "DisableHealthServiceAccessForOrganization": { "name": "DisableHealthServiceAccessForOrganization", "http": { "method": "POST", "requestUri": "/" }, "errors": [ { "shape": "ConcurrentModificationException" } ], "documentation": "Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the 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 Command Line Interface (CLI) to remove the service-linked role. 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, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.
Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
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 must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples.
If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events in the Health User Guide.
", "idempotent": true } }, "shapes": { "AccountEntityAggregate": { "type": "structure", "members": { "accountId": { "shape": "eventArn", "documentation": "The 12-digit Amazon Web Services account numbers that contains the affected entities.
" }, "count": { "shape": "count", "documentation": "The number of entities that match the filter criteria for the specified events.
" }, "statuses": { "shape": "entityStatuses", "documentation": "The number of affected entities aggregated by the entity status codes.
" } }, "documentation": "The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.
" }, "AccountEntityAggregatesList": { "type": "list", "member": { "shape": "AccountEntityAggregate" } }, "AffectedEntity": { "type": "structure", "members": { "entityArn": { "shape": "entityArn", "documentation": "The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
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 ID of the affected entity.
" }, "entityUrl": { "shape": "entityUrl", "documentation": "The URL of the affected entity.
" }, "awsAccountId": { "shape": "accountId", "documentation": "The 12-digit Amazon Web Services account number that contains the affected entity.
" }, "lastUpdatedTime": { "shape": "timestamp", "documentation": "The most recent time that the entity was updated.
" }, "statusCode": { "shape": "entityStatusCode", "documentation": "The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
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.
" }, "DateTimeRange": { "type": "structure", "members": { "from": { "shape": "timestamp", "documentation": "The starting date and time of a time range.
" }, "to": { "shape": "timestamp", "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.
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
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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" } } }, "DescribeAffectedAccountsForOrganizationResponse": { "type": "structure", "members": { "affectedAccounts": { "shape": "affectedAccountsList", "documentation": "A JSON set of elements of the affected accounts.
" }, "eventScopeCode": { "shape": "eventScopeCode", "documentation": "This parameter specifies if the Health event is a public Amazon Web 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.
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.
A JSON set of elements including the awsAccountId and the eventArn.
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" }, "organizationEntityAccountFilters": { "shape": "OrganizationEntityAccountFiltersList", "documentation": "A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.
A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.
A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
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.
Values to narrow the results returned. At least one event ARN is required.
" }, "locale": { "shape": "locale", "documentation": "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" } } }, "DescribeAffectedEntitiesResponse": { "type": "structure", "members": { "entities": { "shape": "EntityList", "documentation": "The entities that match the filter criteria.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
A list of event ARNs (unique identifiers). 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\"
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
" } } }, "DescribeEntityAggregatesForOrganizationResponse": { "type": "structure", "members": { "organizationEntityAggregates": { "shape": "OrganizationEntityAggregatesList", "documentation": "The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.
" } } }, "DescribeEntityAggregatesRequest": { "type": "structure", "members": { "eventArns": { "shape": "EventArnsList", "documentation": "A list of event ARNs (unique identifiers). 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\"
The number of entities that are affected by each of the specified events.
" } } }, "DescribeEventAggregatesRequest": { "type": "structure", "required": [ "aggregateField" ], "members": { "filter": { "shape": "EventFilter", "documentation": "Values to narrow the results returned.
" }, "aggregateField": { "shape": "eventAggregateField", "documentation": "The only currently supported value is eventTypeCategory.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The number of events in each category that meet the optional filter criteria.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
A set of JSON elements that includes the awsAccountId and the eventArn.
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" } } }, "DescribeEventDetailsForOrganizationResponse": { "type": "structure", "members": { "successfulSet": { "shape": "DescribeEventDetailsForOrganizationSuccessfulSet", "documentation": "Information about the events that could be retrieved.
" }, "failedSet": { "shape": "DescribeEventDetailsForOrganizationFailedSet", "documentation": "Error messages for any events that could not be retrieved.
" } } }, "DescribeEventDetailsForOrganizationSuccessfulSet": { "type": "list", "member": { "shape": "OrganizationEventDetails" } }, "DescribeEventDetailsRequest": { "type": "structure", "required": [ "eventArns" ], "members": { "eventArns": { "shape": "eventArnList", "documentation": "A list of event ARNs (unique identifiers). 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\"
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" } } }, "DescribeEventDetailsResponse": { "type": "structure", "members": { "successfulSet": { "shape": "DescribeEventDetailsSuccessfulSet", "documentation": "Information about the events that could be retrieved.
" }, "failedSet": { "shape": "DescribeEventDetailsFailedSet", "documentation": "Error messages for any events that could not be retrieved.
" } } }, "DescribeEventDetailsSuccessfulSet": { "type": "list", "member": { "shape": "EventDetails" } }, "DescribeEventTypesRequest": { "type": "structure", "members": { "filter": { "shape": "EventTypeFilter", "documentation": "Values to narrow the results returned.
" }, "locale": { "shape": "locale", "documentation": "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
If you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.
A list of event types that match the filter 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).
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.
Values to narrow the results returned.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" }, "locale": { "shape": "locale", "documentation": "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" } } }, "DescribeEventsForOrganizationResponse": { "type": "structure", "members": { "events": { "shape": "OrganizationEventList", "documentation": "The events that match the specified filter criteria.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
Values to narrow the results returned.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
" }, "locale": { "shape": "locale", "documentation": "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
" } } }, "DescribeEventsResponse": { "type": "structure", "members": { "events": { "shape": "EventList", "documentation": "The events that match the specified filter criteria.
" }, "nextToken": { "shape": "nextToken", "documentation": "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.
Information about the status of enabling or disabling the Health organizational view feature in your organization.
Valid values are ENABLED | DISABLED | PENDING.
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 12-digit Amazon Web Services account numbers that contains the affected entities.
" }, "statusCodes": { "shape": "entityStatusCodeList", "documentation": "A list of entity status codes.
" } }, "documentation": "A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.
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 number of entities that match the criteria for the specified events.
" }, "statuses": { "shape": "entityStatuses", "documentation": "The number of affected entities aggregated by the entity status codes.
" } }, "documentation": "The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
" }, "EntityAggregateList": { "type": "list", "member": { "shape": "EntityAggregate" } }, "EntityFilter": { "type": "structure", "required": [ "eventArns" ], "members": { "eventArns": { "shape": "eventArnList", "documentation": "A list of event ARNs (unique identifiers). 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\"
A list of entity ARNs (unique identifiers).
" }, "entityValues": { "shape": "entityValueList", "documentation": "A list of IDs for affected entities.
" }, "lastUpdatedTimes": { "shape": "dateTimeRangeList", "documentation": "A list of the most recent dates and times that the entity was updated.
" }, "tags": { "shape": "tagFilter", "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.
" }, "EntityList": { "type": "list", "member": { "shape": "AffectedEntity" } }, "Event": { "type": "structure", "members": { "arn": { "shape": "eventArn", "documentation": "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 Amazon Web Service that is affected by the event. For example, EC2, RDS.
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
The Amazon Web Services Region name of the event.
" }, "availabilityZone": { "shape": "availabilityZone", "documentation": "The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
" }, "startTime": { "shape": "timestamp", "documentation": "The date and time that the event began.
" }, "endTime": { "shape": "timestamp", "documentation": "The date and time that the event ended.
" }, "lastUpdatedTime": { "shape": "timestamp", "documentation": "The most recent date and time that the event was updated.
" }, "statusCode": { "shape": "eventStatusCode", "documentation": "The most recent status of the event. Possible values are open, closed, and upcoming.
This parameter specifies if the Health event is a public Amazon Web 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
The 12-digit Amazon Web Services account numbers that contains the affected entities.
" } }, "documentation": "The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
" }, "EventAggregate": { "type": "structure", "members": { "aggregateValue": { "shape": "aggregateValue", "documentation": "The issue type for the associated count.
" }, "count": { "shape": "count", "documentation": "The number of events of the associated issue type.
" } }, "documentation": "The number of events of each issue type. Returned by the DescribeEventAggregates operation.
" }, "EventAggregateList": { "type": "list", "member": { "shape": "EventAggregate" } }, "EventArnsList": { "type": "list", "member": { "shape": "eventArn" }, "max": 50, "min": 1 }, "EventDescription": { "type": "structure", "members": { "latestDescription": { "shape": "eventDescription", "documentation": "The most recent description of the event.
" } }, "documentation": "The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
" }, "EventDetails": { "type": "structure", "members": { "event": { "shape": "Event", "documentation": "Summary information about the event.
" }, "eventDescription": { "shape": "EventDescription", "documentation": "The most recent description of the event.
" }, "eventMetadata": { "shape": "eventMetadata", "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.
" }, "EventDetailsErrorItem": { "type": "structure", "members": { "eventArn": { "shape": "eventArn", "documentation": "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 name of the error.
" }, "errorMessage": { "shape": "string", "documentation": "A message that describes the error.
" } }, "documentation": "Error information returned when a DescribeEventDetails operation can't find a specified event.
" }, "EventFilter": { "type": "structure", "members": { "eventArns": { "shape": "eventArnList", "documentation": "A list of event ARNs (unique identifiers). 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\"
A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".
The Amazon Web Services associated with the event. For example, EC2, RDS.
A list of Amazon Web Services Regions.
" }, "availabilityZones": { "shape": "availabilityZones", "documentation": "A list of Amazon Web Services Availability Zones.
" }, "startTimes": { "shape": "dateTimeRangeList", "documentation": "A list of dates and times that the event began.
" }, "endTimes": { "shape": "dateTimeRangeList", "documentation": "A list of dates and times that the event ended.
" }, "lastUpdatedTimes": { "shape": "dateTimeRangeList", "documentation": "A list of dates and times that the event was last updated.
" }, "entityArns": { "shape": "entityArnList", "documentation": "A list of entity ARNs (unique identifiers).
" }, "entityValues": { "shape": "entityValueList", "documentation": "A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
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.
" }, "EventList": { "type": "list", "member": { "shape": "Event" } }, "EventType": { "type": "structure", "members": { "service": { "shape": "service", "documentation": "The Amazon Web Service that is affected by the event. For example, EC2, RDS.
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.
You can use the DescribeEventTypes API operation to return this information about an event.
You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide.
" }, "EventTypeCategoryList": { "type": "list", "member": { "shape": "eventTypeCategory" }, "max": 10, "min": 1 }, "EventTypeCodeList": { "type": "list", "member": { "shape": "eventTypeCode" }, "max": 10, "min": 1 }, "EventTypeFilter": { "type": "structure", "members": { "eventTypeCodes": { "shape": "EventTypeCodeList", "documentation": "A list of event type codes.
" }, "services": { "shape": "serviceList", "documentation": "The Amazon Web Services associated with the event. For example, EC2, RDS.
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
The values to use to filter results from the DescribeEventTypes operation.
" }, "EventTypeList": { "type": "list", "member": { "shape": "EventType" } }, "OrganizationAccountIdsList": { "type": "list", "member": { "shape": "accountId" }, "max": 25, "min": 1 }, "OrganizationAffectedEntitiesErrorItem": { "type": "structure", "members": { "awsAccountId": { "shape": "accountId", "documentation": "The 12-digit Amazon Web Services account numbers that contains the affected entities.
" }, "eventArn": { "shape": "eventArn", "documentation": "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 name of the error.
" }, "errorMessage": { "shape": "string", "documentation": "A message that describes the error. Follow the error message and retry your request.
For example, the InvalidAccountInputError error message appears if you call the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific value for the EventScopeCode parameter, but don't specify an Amazon Web Services account.
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
" }, "OrganizationEntityAccountFiltersList": { "type": "list", "member": { "shape": "EntityAccountFilter" }, "max": 10, "min": 1 }, "OrganizationEntityAggregate": { "type": "structure", "members": { "eventArn": { "shape": "eventArn", "documentation": "A list of event ARNs (unique identifiers). 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\"
The number of entities for the organization that match the filter criteria for the specified events.
" }, "statuses": { "shape": "entityStatuses", "documentation": "The number of affected entities aggregated by the entitiy status codes.
" }, "accounts": { "shape": "AccountEntityAggregatesList", "documentation": "A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no awsAccountIds provided in the request, this field will be empty in the response.
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
" }, "OrganizationEntityAggregatesList": { "type": "list", "member": { "shape": "OrganizationEntityAggregate" } }, "OrganizationEntityFiltersList": { "type": "list", "member": { "shape": "EventAccountFilter" }, "max": 10, "min": 1 }, "OrganizationEvent": { "type": "structure", "members": { "arn": { "shape": "eventArn", "documentation": "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 Amazon Web Service that is affected by the event, such as EC2 and RDS.
" }, "eventTypeCode": { "shape": "eventTypeCode", "documentation": "The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
This parameter specifies if the Health event is a public Amazon Web 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.
The Amazon Web Services Region name of the event.
" }, "startTime": { "shape": "timestamp", "documentation": "The date and time that the event began.
" }, "endTime": { "shape": "timestamp", "documentation": "The date and time that the event ended.
" }, "lastUpdatedTime": { "shape": "timestamp", "documentation": "The most recent date and time that the event was updated.
" }, "statusCode": { "shape": "eventStatusCode", "documentation": "The most recent status of the event. Possible values are open, closed, and upcoming.
Summary information about an event, returned by the DescribeEventsForOrganization operation.
" }, "OrganizationEventArnsList": { "type": "list", "member": { "shape": "eventArn" }, "max": 25, "min": 1 }, "OrganizationEventDetailFiltersList": { "type": "list", "member": { "shape": "EventAccountFilter" }, "max": 10, "min": 1 }, "OrganizationEventDetails": { "type": "structure", "members": { "awsAccountId": { "shape": "accountId", "documentation": "The 12-digit Amazon Web Services account numbers that contains the affected entities.
" }, "event": { "shape": "Event" }, "eventDescription": { "shape": "EventDescription" }, "eventMetadata": { "shape": "eventMetadata", "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.
" }, "OrganizationEventDetailsErrorItem": { "type": "structure", "members": { "awsAccountId": { "shape": "accountId", "documentation": "Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
" }, "eventArn": { "shape": "eventArn", "documentation": "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 name of the error.
" }, "errorMessage": { "shape": "string", "documentation": "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.
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
" }, "OrganizationEventFilter": { "type": "structure", "members": { "eventTypeCodes": { "shape": "eventTypeList", "documentation": "A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
" }, "services": { "shape": "serviceList", "documentation": "The Amazon Web Services associated with the event. For example, EC2, RDS.
A list of Amazon Web Services Regions.
" }, "startTime": { "shape": "DateTimeRange" }, "endTime": { "shape": "DateTimeRange" }, "lastUpdatedTime": { "shape": "DateTimeRange" }, "entityArns": { "shape": "entityArnList", "documentation": "A list of entity ARNs (unique identifiers).
" }, "entityValues": { "shape": "entityValueList", "documentation": "A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
" }, "eventTypeCategories": { "shape": "eventTypeCategoryList", "documentation": "A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
A list of event status codes.
" } }, "documentation": "The values to filter results from the DescribeEventsForOrganization operation.
" }, "OrganizationEventList": { "type": "list", "member": { "shape": "OrganizationEvent" } }, "accountId": { "type": "string", "max": 12, "pattern": "^\\S+$" }, "affectedAccountsList": { "type": "list", "member": { "shape": "accountId" } }, "aggregateValue": { "type": "string" }, "availabilityZone": { "type": "string", "max": 18, "min": 6, "pattern": "[a-z]{2}\\-[0-9a-z\\-]{4,16}" }, "availabilityZones": { "type": "list", "member": { "shape": "availabilityZone" } }, "awsAccountIdsList": { "type": "list", "member": { "shape": "accountId" }, "max": 50, "min": 1 }, "count": { "type": "integer" }, "dateTimeRangeList": { "type": "list", "member": { "shape": "DateTimeRange" }, "max": 10, "min": 1 }, "entityArn": { "type": "string", "max": 1600, "pattern": ".{0,1600}" }, "entityArnList": { "type": "list", "member": { "shape": "entityArn" }, "max": 99, "min": 1 }, "entityStatusCode": { "type": "string", "enum": [ "IMPAIRED", "UNIMPAIRED", "UNKNOWN", "PENDING", "RESOLVED" ] }, "entityStatusCodeList": { "type": "list", "member": { "shape": "entityStatusCode" }, "max": 5, "min": 1 }, "entityStatuses": { "type": "map", "key": { "shape": "entityStatusCode" }, "value": { "shape": "count" } }, "entityUrl": { "type": "string" }, "entityValue": { "type": "string", "max": 1224, "pattern": ".{0,1224}" }, "entityValueList": { "type": "list", "member": { "shape": "entityValue" }, "max": 99, "min": 1 }, "eventAggregateField": { "type": "string", "enum": [ "eventTypeCategory" ] }, "eventArn": { "type": "string", "max": 1600, "pattern": "arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\\w-]+){3}" }, "eventArnList": { "type": "list", "member": { "shape": "eventArn" }, "max": 10, "min": 1 }, "eventDescription": { "type": "string" }, "eventMetadata": { "type": "map", "key": { "shape": "metadataKey" }, "value": { "shape": "metadataValue" } }, "eventScopeCode": { "type": "string", "enum": [ "PUBLIC", "ACCOUNT_SPECIFIC", "NONE" ] }, "eventStatusCode": { "type": "string", "enum": [ "open", "closed", "upcoming" ] }, "eventStatusCodeList": { "type": "list", "member": { "shape": "eventStatusCode" }, "max": 6, "min": 1 }, "eventType": { "type": "string", "max": 100, "min": 3, "pattern": "[^:/]{3,100}" }, "eventTypeCategory": { "type": "string", "enum": [ "issue", "accountNotification", "scheduledChange", "investigation" ], "max": 255, "min": 3 }, "eventTypeCategoryList": { "type": "list", "member": { "shape": "eventTypeCategory" }, "max": 10, "min": 1 }, "eventTypeCode": { "type": "string", "max": 100, "min": 3, "pattern": "[a-zA-Z0-9\\_\\-]{3,100}" }, "eventTypeList": { "type": "list", "member": { "shape": "eventType" }, "max": 10, "min": 1 }, "healthServiceAccessStatusForOrganization": { "type": "string" }, "locale": { "type": "string", "max": 256, "min": 2, "pattern": ".{2,256}" }, "maxResults": { "type": "integer", "max": 100, "min": 10 }, "maxResultsLowerRange": { "type": "integer", "max": 100, "min": 1 }, "metadataKey": { "type": "string", "max": 32766 }, "metadataValue": { "type": "string", "max": 32766 }, "nextToken": { "type": "string", "max": 10000, "min": 4, "pattern": "[a-zA-Z0-9=/+_.-]{4,10000}" }, "region": { "type": "string", "max": 25, "min": 2, "pattern": "[^:/]{2,25}" }, "regionList": { "type": "list", "member": { "shape": "region" }, "max": 10, "min": 1 }, "service": { "type": "string", "max": 30, "min": 2, "pattern": "[^:/]{2,30}" }, "serviceList": { "type": "list", "member": { "shape": "service" }, "max": 10, "min": 1 }, "string": { "type": "string" }, "tagFilter": { "type": "list", "member": { "shape": "tagSet" }, "max": 50 }, "tagKey": { "type": "string", "max": 127, "pattern": ".{0,127}" }, "tagSet": { "type": "map", "key": { "shape": "tagKey" }, "value": { "shape": "tagValue" }, "max": 50 }, "tagValue": { "type": "string", "max": 255, "pattern": ".{0,255}" }, "timestamp": { "type": "timestamp" } }, "documentation": "The Health API provides access to the Health information that appears in the Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web 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.
For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys in the Amazon Web Services General Reference.
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.