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.
Interface for accessing AWSHealth
HealthThe Health API provides access to the Health information that appears in the Health Dashboard. You can use the API operations to get information about events that might affect your Amazon Web Services and resources.
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.
For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys in the Amazon Web Services General Reference.
You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. 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 Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API in the Health User Guide.
For authentication of requests, Health uses the Signature Version 4 Signing Process.
If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate 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 Health events in the Health User Guide.
When you use the Health API operations to return Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return 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.
Namespace: Amazon.AWSHealth
Assembly: AWSSDK.AWSHealth.dll
Version: 3.x.y.z
public interface IAmazonAWSHealth IAmazonService, IDisposable
The IAmazonAWSHealth type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.AWSHealth.Model.IAWSHealthPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
DescribeAffectedAccountsForOrganization(DescribeAffectedAccountsForOrganizationRequest) |
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 |
|
DescribeAffectedAccountsForOrganizationAsync(DescribeAffectedAccountsForOrganizationRequest, CancellationToken) |
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 |
|
DescribeAffectedEntities(DescribeAffectedEntitiesRequest) |
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.
|
|
DescribeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest, CancellationToken) |
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.
|
|
DescribeAffectedEntitiesForOrganization(DescribeAffectedEntitiesForOrganizationRequest) |
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.
|
|
DescribeAffectedEntitiesForOrganizationAsync(DescribeAffectedEntitiesForOrganizationRequest, CancellationToken) |
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.
|
|
DescribeEntityAggregates(DescribeEntityAggregatesRequest) |
Returns the number of entities that are affected by each of the specified events. |
|
DescribeEntityAggregatesAsync(DescribeEntityAggregatesRequest, CancellationToken) |
Returns the number of entities that are affected by each of the specified events. |
|
DescribeEntityAggregatesForOrganization(DescribeEntityAggregatesForOrganizationRequest) |
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events. |
|
DescribeEntityAggregatesForOrganizationAsync(DescribeEntityAggregatesForOrganizationRequest, CancellationToken) |
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events. |
|
DescribeEventAggregates(DescribeEventAggregatesRequest) |
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 |
|
DescribeEventAggregatesAsync(DescribeEventAggregatesRequest, CancellationToken) |
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 |
|
DescribeEventDetails(DescribeEventDetailsRequest) |
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. |
|
DescribeEventDetailsAsync(DescribeEventDetailsRequest, CancellationToken) |
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. |
|
DescribeEventDetailsForOrganization(DescribeEventDetailsForOrganizationRequest) |
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
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. |
|
DescribeEventDetailsForOrganizationAsync(DescribeEventDetailsForOrganizationRequest, CancellationToken) |
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
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. |
|
DescribeEvents(DescribeEventsRequest) |
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
|
|
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) |
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
|
|
DescribeEventsForOrganization(DescribeEventsForOrganizationRequest) |
Returns information about events across your organization in Organizations. You can
use the
If you don't specify a 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 |
|
DescribeEventsForOrganizationAsync(DescribeEventsForOrganizationRequest, CancellationToken) |
Returns information about events across your organization in Organizations. You can
use the
If you don't specify a 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 |
|
DescribeEventTypes(DescribeEventTypesRequest) |
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 |
|
DescribeEventTypesAsync(DescribeEventTypesRequest, CancellationToken) |
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 |
|
DescribeHealthServiceStatusForOrganization(DescribeHealthServiceStatusForOrganizationRequest) |
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. |
|
DescribeHealthServiceStatusForOrganizationAsync(DescribeHealthServiceStatusForOrganizationRequest, CancellationToken) |
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. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisableHealthServiceAccessForOrganization(DisableHealthServiceAccessForOrganizationRequest) |
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. |
|
DisableHealthServiceAccessForOrganizationAsync(DisableHealthServiceAccessForOrganizationRequest, CancellationToken) |
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. |
|
EnableHealthServiceAccessForOrganization(EnableHealthServiceAccessForOrganizationRequest) |
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:
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. |
|
EnableHealthServiceAccessForOrganizationAsync(EnableHealthServiceAccessForOrganizationRequest, CancellationToken) |
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:
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5