[−][src]Crate rusoto_health
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
If you're using the service, you're probably looking for AWSHealthClient and AWSHealth.
Structs
AWSHealthClient | A client for the AWSHealth API. |
AffectedEntity | Information about an entity that is affected by a Health event. |
DateTimeRange | A range of dates and times that is used by the EventFilter and EntityFilter objects. If |
DescribeAffectedAccountsForOrganizationRequest | |
DescribeAffectedAccountsForOrganizationResponse | |
DescribeAffectedEntitiesForOrganizationRequest | |
DescribeAffectedEntitiesForOrganizationResponse | |
DescribeAffectedEntitiesRequest | |
DescribeAffectedEntitiesResponse | |
DescribeEntityAggregatesRequest | |
DescribeEntityAggregatesResponse | |
DescribeEventAggregatesRequest | |
DescribeEventAggregatesResponse | |
DescribeEventDetailsForOrganizationRequest | |
DescribeEventDetailsForOrganizationResponse | |
DescribeEventDetailsRequest | |
DescribeEventDetailsResponse | |
DescribeEventTypesRequest | |
DescribeEventTypesResponse | |
DescribeEventsForOrganizationRequest | |
DescribeEventsForOrganizationResponse | |
DescribeEventsRequest | |
DescribeEventsResponse | |
DescribeHealthServiceStatusForOrganizationResponse | |
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 AWS Health event. |
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. |
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 cannot find a specified event. |
EventFilter | The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations. |
EventTypeFilter | The values to use to filter results from the DescribeEventTypes operation. |
OrganizationAffectedEntitiesErrorItem | Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity. |
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 cannot find a specified event. |
OrganizationEventFilter | The values to filter results from the DescribeEventsForOrganization operation. |
Enums
DescribeAffectedAccountsForOrganizationError | Errors returned by DescribeAffectedAccountsForOrganization |
DescribeAffectedEntitiesError | Errors returned by DescribeAffectedEntities |
DescribeAffectedEntitiesForOrganizationError | Errors returned by DescribeAffectedEntitiesForOrganization |
DescribeEntityAggregatesError | Errors returned by DescribeEntityAggregates |
DescribeEventAggregatesError | Errors returned by DescribeEventAggregates |
DescribeEventDetailsError | Errors returned by DescribeEventDetails |
DescribeEventDetailsForOrganizationError | Errors returned by DescribeEventDetailsForOrganization |
DescribeEventTypesError | Errors returned by DescribeEventTypes |
DescribeEventsError | Errors returned by DescribeEvents |
DescribeEventsForOrganizationError | Errors returned by DescribeEventsForOrganization |
DescribeHealthServiceStatusForOrganizationError | Errors returned by DescribeHealthServiceStatusForOrganization |
DisableHealthServiceAccessForOrganizationError | Errors returned by DisableHealthServiceAccessForOrganization |
EnableHealthServiceAccessForOrganizationError | Errors returned by EnableHealthServiceAccessForOrganization |
Traits
AWSHealth | Trait representing the capabilities of the AWSHealth API. AWSHealth clients implement this trait. |