AWS SDK Version 3 for .NET
API Reference

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.

Classes

NameDescription
Class AffectedEntity

Information about an entity that is affected by a Health event.

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

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

Class DescribeAffectedEntitiesResponse

This is the response object from the DescribeAffectedEntities operation.

Class DescribeEntityAggregatesRequest

Container for the parameters to the DescribeEntityAggregates operation. Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.

Class DescribeEntityAggregatesResponse

This is the response object from the DescribeEntityAggregates operation.

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

Class DescribeEventAggregatesResponse

This is the response object from the DescribeEventAggregates operation.

Class DescribeEventDetailsRequest

Container for the parameters to the DescribeEventDetails operation. Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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.

Class DescribeEventDetailsResponse

This is the response object from the DescribeEventDetails operation.

Class 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 lastModifiedTime, starting with the most recent.

Class DescribeEventsResponse

This is the response object from the DescribeEvents operation.

Class DescribeEventTypesRequest

Container for the parameters to the DescribeEventTypes operation. 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.

Class DescribeEventTypesResponse

This is the response object from the DescribeEventTypes operation.

Class EntityAggregate

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

Class EntityFilter

The values to use to filter results from the DescribeAffectedEntities operation.

Class Event

Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.

Class EventAggregate

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

Class EventDescription

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

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

Class EventDetailsErrorItem

Error information returned when a DescribeEventDetails operation cannot find a specified event.

Class EventFilter

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

Class EventType

Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

Class EventTypeFilter

The values to use to filter results from the DescribeEventTypes operation.

Class InvalidPaginationTokenException

AWSHealth exception

Class UnsupportedLocaleException

AWSHealth exception