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 ConcurrentModificationException

AWSHealth exception

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 DescribeAffectedAccountsForOrganizationRequest

Container for the parameters to the DescribeAffectedAccountsForOrganization operation. Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Class DescribeAffectedAccountsForOrganizationResponse

This is the response object from the DescribeAffectedAccountsForOrganization operation.

Class 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 AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

At least one event ARN and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Class DescribeAffectedEntitiesForOrganizationResponse

This is the response object from the DescribeAffectedEntitiesForOrganization operation.

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 DescribeEventDetailsForOrganizationRequest

Container for the parameters to the DescribeEventDetailsForOrganization operation. Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization, 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 DescribeAffectedEntitiesForOrganization operation.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Class DescribeEventDetailsForOrganizationResponse

This is the response object from the DescribeEventDetailsForOrganization 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, 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 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 DescribeEventsForOrganizationRequest

Container for the parameters to the DescribeEventsForOrganization operation. Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeAffectedAccountsForOrganization, DescribeEventDetailsForOrganization, and DescribeAffectedEntitiesForOrganization operations.

If no filter criteria are specified, all events across your organization are returned. Results are sorted by lastModifiedTime, starting with the most recent.

Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.

Class DescribeEventsForOrganizationResponse

This is the response object from the DescribeEventsForOrganization 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 DescribeHealthServiceStatusForOrganizationRequest

Container for the parameters to the DescribeHealthServiceStatusForOrganization operation. This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Class DescribeHealthServiceStatusForOrganizationResponse

This is the response object from the DescribeHealthServiceStatusForOrganization operation.

Class DisableHealthServiceAccessForOrganizationRequest

Container for the parameters to the DisableHealthServiceAccessForOrganization operation. Calling this operation disables Health from working with AWS Organizations. This does not remove the Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API, or AWS CLI to remove the SLR if desired. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Class DisableHealthServiceAccessForOrganizationResponse

This is the response object from the DisableHealthServiceAccessForOrganization operation.

Class EnableHealthServiceAccessForOrganizationRequest

Container for the parameters to the EnableHealthServiceAccessForOrganization operation. Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service Linked Role (SLR) to the master account in the organization. To learn more about the steps in this process, visit enabling service access for AWS Health in AWS Organizations. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.

Class EnableHealthServiceAccessForOrganizationResponse

This is the response object from the EnableHealthServiceAccessForOrganization 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 AWS Health event.

Class EventAccountFilter

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

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 OrganizationAffectedEntitiesErrorItem

Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.

Class OrganizationEvent

Summary information about an event, returned by the DescribeEventsForOrganization operation.

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

Class OrganizationEventDetailsErrorItem

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

Class OrganizationEventFilter

The values to filter results from the DescribeEventsForOrganization operation.

Class UnsupportedLocaleException

AWSHealth exception