AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccountEntityAggregate |
The number of entities in an account that are impacted by a specific event aggregated by the entity status codes. |
|
AffectedEntity |
Information about an entity that is affected by a Health event. |
|
AWSHealthPaginatorFactory |
Paginators for the AWSHealth service |
|
ConcurrentModificationException |
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation. |
|
DateTimeRange |
A range of dates and times that is used by the EventFilter
and EntityFilter
objects. If |
|
DescribeAffectedAccountsForOrganizationRequest |
Container for the parameters to the DescribeAffectedAccountsForOrganization operation. 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 |
|
DescribeAffectedAccountsForOrganizationResponse |
This is the response object from the DescribeAffectedAccountsForOrganization operation. |
|
DescribeAffectedEntitiesForOrganizationRequest |
Container for the parameters to the DescribeAffectedEntitiesForOrganization operation. 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.
|
|
DescribeAffectedEntitiesForOrganizationResponse |
This is the response object from the DescribeAffectedEntitiesForOrganization operation. |
|
DescribeAffectedEntitiesRequest |
Container for the parameters to the DescribeAffectedEntities operation. 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.
|
|
DescribeAffectedEntitiesResponse |
This is the response object from the DescribeAffectedEntities operation. |
|
DescribeEntityAggregatesForOrganizationRequest |
Container for the parameters to the DescribeEntityAggregatesForOrganization operation. Returns a list of entity aggregates for your Organizations that are affected by each of the specified events. |
|
DescribeEntityAggregatesForOrganizationResponse |
This is the response object from the DescribeEntityAggregatesForOrganization operation. |
|
DescribeEntityAggregatesRequest |
Container for the parameters to the DescribeEntityAggregates operation. Returns the number of entities that are affected by each of the specified events. |
|
DescribeEntityAggregatesResponse |
This is the response object from the DescribeEntityAggregates operation. |
|
DescribeEventAggregatesRequest |
Container for the parameters to the DescribeEventAggregates operation.
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 |
|
DescribeEventAggregatesResponse |
This is the response object from the DescribeEventAggregates operation. |
|
DescribeEventDetailsForOrganizationRequest |
Container for the parameters to the DescribeEventDetailsForOrganization operation.
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
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. |
|
DescribeEventDetailsForOrganizationResponse |
This is the response object from the DescribeEventDetailsForOrganization operation. |
|
DescribeEventDetailsRequest |
Container for the parameters to the DescribeEventDetails operation. 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. |
|
DescribeEventDetailsResponse |
This is the response object from the DescribeEventDetails operation. |
|
DescribeEventsForOrganizationRequest |
Container for the parameters to the DescribeEventsForOrganization operation.
Returns information about events across your organization in Organizations. You can
use the
If you don't specify a 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 |
|
DescribeEventsForOrganizationResponse |
This is the response object from the DescribeEventsForOrganization operation. |
|
DescribeEventsRequest |
Container for the parameters to the DescribeEvents operation. 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
|
|
DescribeEventsResponse |
This is the response object from the DescribeEvents operation. |
|
DescribeEventTypesRequest |
Container for the parameters to the DescribeEventTypes operation. 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 |
|
DescribeEventTypesResponse |
This is the response object from the DescribeEventTypes operation. |
|
DescribeHealthServiceStatusForOrganizationRequest |
Container for the parameters to the DescribeHealthServiceStatusForOrganization operation. 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. |
|
DescribeHealthServiceStatusForOrganizationResponse |
This is the response object from the DescribeHealthServiceStatusForOrganization operation. |
|
DisableHealthServiceAccessForOrganizationRequest |
Container for the parameters to the DisableHealthServiceAccessForOrganization operation. 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. |
|
DisableHealthServiceAccessForOrganizationResponse |
This is the response object from the DisableHealthServiceAccessForOrganization operation. |
|
EnableHealthServiceAccessForOrganizationRequest |
Container for the parameters to the EnableHealthServiceAccessForOrganization operation. 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:
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. |
|
EnableHealthServiceAccessForOrganizationResponse |
This is the response object from the EnableHealthServiceAccessForOrganization operation. |
|
EntityAccountFilter |
A JSON set of elements including the |
|
EntityAggregate |
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation. |
|
EntityFilter |
The values to use to filter results from the DescribeAffectedEntities operation. |
|
Event |
Summary information about an Health event. Health events can be public or account-specific:
You can determine if an event is public or account-specific by using the |
|
EventAccountFilter |
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations. |
|
EventAggregate |
The number of events of each issue type. Returned by the DescribeEventAggregates operation. |
|
EventDescription |
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation. |
|
EventDetails |
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 |
Error information returned when a DescribeEventDetails operation can't find a specified event. |
|
EventFilter |
The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations. |
|
EventType |
Contains the metadata about a type of event that is reported by Health. The 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. |
|
EventTypeFilter |
The values to use to filter results from the DescribeEventTypes operation. |
|
InvalidPaginationTokenException |
The specified pagination token ( |
|
OrganizationAffectedEntitiesErrorItem |
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity. |
|
OrganizationEntityAggregate |
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. |
|
OrganizationEvent |
Summary information about an event, returned by the DescribeEventsForOrganization operation. |
|
OrganizationEventDetails |
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 |
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event. |
|
OrganizationEventFilter |
The values to filter results from the DescribeEventsForOrganization operation. |
|
UnsupportedLocaleException |
The specified locale is not supported. |
Name | Description | |
---|---|---|
IAWSHealthPaginatorFactory |
Paginators for the AWSHealth service |
|
IDescribeAffectedAccountsForOrganizationPaginator |
Paginator for the DescribeAffectedAccountsForOrganization operation |
|
IDescribeAffectedEntitiesForOrganizationPaginator |
Paginator for the DescribeAffectedEntitiesForOrganization operation |
|
IDescribeAffectedEntitiesPaginator |
Paginator for the DescribeAffectedEntities operation |
|
IDescribeEventAggregatesPaginator |
Paginator for the DescribeEventAggregates operation |
|
IDescribeEventsForOrganizationPaginator |
Paginator for the DescribeEventsForOrganization operation |
|
IDescribeEventsPaginator |
Paginator for the DescribeEvents operation |
|
IDescribeEventTypesPaginator |
Paginator for the DescribeEventTypes operation |