DescribeDomainHealth

Source: src/AWS/OpenSearch/DescribeDomainHealth.ts

Runtime binding for the DescribeDomainHealth operation (IAM action es:DescribeDomainHealth).

Reads a domain’s cluster health — overall status, master eligibility, per-AZ shard and node distribution — for dashboards and automated health checks. Provide the implementation with Effect.provide(AWS.OpenSearch.DescribeDomainHealthHttp).

Monitoring Domains

const describeDomainHealth = yield* OpenSearch.DescribeDomainHealth();

const result = yield* describeDomainHealth({ DomainName: name });
// result.ClusterHealth → "Green"