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.

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeDomainHealth and EndDescribeDomainHealth.

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

Syntax

C#
public abstract Task<DescribeDomainHealthResponse> DescribeDomainHealthAsync(
         DescribeDomainHealthRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.OpenSearchService.Model.DescribeDomainHealthRequest

Container for the necessary parameters to execute the DescribeDomainHealth service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeDomainHealth service method, as returned by OpenSearchService.

Exceptions

ExceptionCondition
BaseException An error occurred while processing the request.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also