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.

Implementation for accessing AWSHealth AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

In addition, these operations provide information about event types and summary counts of events or affected entities:

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

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

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AWSHealth.AmazonAWSHealthClient

Namespace: Amazon.AWSHealth
Assembly: AWSSDK.AWSHealth.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAWSHealthClient : AmazonServiceClient
         IAmazonAWSHealth, IAmazonService, IDisposable

The AmazonAWSHealthClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAWSHealthClient()

Constructs AmazonAWSHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAWSHealthClient(RegionEndpoint)

Constructs AmazonAWSHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAWSHealthClient(AmazonAWSHealthConfig)

Constructs AmazonAWSHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAWSHealthClient(AWSCredentials)

Constructs AmazonAWSHealthClient with AWS Credentials

Public Method AmazonAWSHealthClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAWSHealthClient with AWS Credentials

Public Method AmazonAWSHealthClient(AWSCredentials, AmazonAWSHealthConfig)

Constructs AmazonAWSHealthClient with AWS Credentials and an AmazonAWSHealthClient Configuration object.

Public Method AmazonAWSHealthClient(string, string)

Constructs AmazonAWSHealthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAWSHealthClient(string, string, RegionEndpoint)

Constructs AmazonAWSHealthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAWSHealthClient(string, string, AmazonAWSHealthConfig)

Constructs AmazonAWSHealthClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSHealthClient Configuration object.

Public Method AmazonAWSHealthClient(string, string, string)

Constructs AmazonAWSHealthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAWSHealthClient(string, string, string, RegionEndpoint)

Constructs AmazonAWSHealthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAWSHealthClient(string, string, string, AmazonAWSHealthConfig)

Constructs AmazonAWSHealthClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSHealthClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method 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 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.

Public Method DescribeAffectedEntitiesAsync(DescribeAffectedEntitiesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAffectedEntities operation.

Public Method DescribeEntityAggregates(DescribeEntityAggregatesRequest)

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.

Public Method DescribeEntityAggregatesAsync(DescribeEntityAggregatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEntityAggregates operation.

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

Public Method DescribeEventAggregatesAsync(DescribeEventAggregatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventAggregates operation.

Public Method DescribeEventDetails(DescribeEventDetailsRequest)

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.

Public Method DescribeEventDetailsAsync(DescribeEventDetailsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventDetails operation.

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

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEvents operation.

Public Method DescribeEventTypes(DescribeEventTypesRequest)

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.

Public Method DescribeEventTypesAsync(DescribeEventTypesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEventTypes operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms