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.

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.OpenSearchService.Model.DescribeDomainHealthResponse

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

Syntax

C# 
public class DescribeDomainHealthResponse : AmazonWebServiceResponse

The DescribeDomainHealthResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeDomainHealthResponse()

Properties

NameTypeDescription
Public Property ActiveAvailabilityZoneCount System.String

Gets and sets the property ActiveAvailabilityZoneCount.

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

Public Property AvailabilityZoneCount System.String

Gets and sets the property AvailabilityZoneCount.

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

Public Property ClusterHealth Amazon.OpenSearchService.DomainHealth

Gets and sets the property ClusterHealth.

The current health status of your cluster.

  • Red - At least one primary shard is not allocated to any node.

  • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

  • Green - All primary shards and their replicas are allocated to nodes.

  • NotAvailable - Unable to retrieve cluster health.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DataNodeCount System.String

Gets and sets the property DataNodeCount.

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

Public Property DedicatedMaster System.Boolean

Gets and sets the property DedicatedMaster.

A boolean that indicates if dedicated master nodes are activated for the domain.

Public Property DomainState Amazon.OpenSearchService.DomainState

Gets and sets the property DomainState.

The current state of the domain.

  • Processing - The domain has updates in progress.

  • Active - Requested changes have been processed and deployed to the domain.

Public Property EnvironmentInformation System.Collections.Generic.List<Amazon.OpenSearchService.Model.EnvironmentInfo>

Gets and sets the property EnvironmentInformation.

A list of EnvironmentInfo for the domain.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property MasterEligibleNodeCount System.String

Gets and sets the property MasterEligibleNodeCount.

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

Public Property MasterNode Amazon.OpenSearchService.MasterNodeStatus

Gets and sets the property MasterNode.

Indicates whether the domain has an elected master node.

  • Available - The domain has an elected master node.

  • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StandByAvailabilityZoneCount System.String

Gets and sets the property StandByAvailabilityZoneCount.

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

Public Property TotalShards System.String

Gets and sets the property TotalShards.

The total number of primary and replica shards for the domain.

Public Property TotalUnAssignedShards System.String

Gets and sets the property TotalUnAssignedShards.

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

Public Property WarmNodeCount System.String

Gets and sets the property WarmNodeCount.

The number of warm nodes configured for the domain.

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, 3.5