Crate rusoto_health

Expand description

AWS Health

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.
You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the AWS Health API operations. AWS Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which AWS Region is active, so that you can get the latest information from the API. For more information, see Accessing the AWS Health API in the AWS Health User Guide.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.

If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS Health events in real time to identify accounts in your organization that are 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.

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

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 EntityFilter operation.

Event

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.

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 can't 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 can't 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 can't find a specified event.

OrganizationEventFilter

The values to filter results from the DescribeEventsForOrganization operation.