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 AccountEntityAggregate

The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.

Class AffectedEntity

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

Class AWSHealthPaginatorFactory

Paginators for the AWSHealth service

Class ConcurrentModificationException

EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

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 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 nextToken parameter in the next request to return more results.

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

  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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

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

  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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

Class DescribeAffectedEntitiesResponse

This is the response object from the DescribeAffectedEntities operation.

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

Class DescribeEntityAggregatesForOrganizationResponse

This is the response object from the DescribeEntityAggregatesForOrganization 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.

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.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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 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 DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

  • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.

  • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

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.

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

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 Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent 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 nextToken parameter in the next request to return more results.

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

  • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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. 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 nextToken parameter in the next request to return more results.

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 Health to work with your organization. To call this operation, you must use the organization's management account.

Class DescribeHealthServiceStatusForOrganizationResponse

This is the response object from the DescribeHealthServiceStatusForOrganization operation.

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

Class DisableHealthServiceAccessForOrganizationResponse

This is the response object from the DisableHealthServiceAccessForOrganization operation.

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

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

  • You must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples.

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.

Class EnableHealthServiceAccessForOrganizationResponse

This is the response object from the EnableHealthServiceAccessForOrganization operation.

Class EntityAccountFilter

A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.

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

Health events can be public or account-specific:

  • Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, 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 Amazon Web Services 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, 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.

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

Class EventFilter

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

Class EventType

Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

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.

Class EventTypeFilter

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

Class InvalidPaginationTokenException

The specified pagination token (nextToken) is not valid.

Class OrganizationAffectedEntitiesErrorItem

Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.

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

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

Class OrganizationEventFilter

The values to filter results from the DescribeEventsForOrganization operation.

Class UnsupportedLocaleException

The specified locale is not supported.

Interfaces

NameDescription
Interface IAWSHealthPaginatorFactory

Paginators for the AWSHealth service

Interface IDescribeAffectedAccountsForOrganizationPaginator

Paginator for the DescribeAffectedAccountsForOrganization operation

Interface IDescribeAffectedEntitiesForOrganizationPaginator

Paginator for the DescribeAffectedEntitiesForOrganization operation

Interface IDescribeAffectedEntitiesPaginator

Paginator for the DescribeAffectedEntities operation

Interface IDescribeEventAggregatesPaginator

Paginator for the DescribeEventAggregates operation

Interface IDescribeEventsForOrganizationPaginator

Paginator for the DescribeEventsForOrganization operation

Interface IDescribeEventsPaginator

Paginator for the DescribeEvents operation

Interface IDescribeEventTypesPaginator

Paginator for the DescribeEventTypes operation