Skip to content

DescribeDomain

Source: src/AWS/OpenSearch/DescribeDomain.ts

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

Reads a domain’s current status — endpoint, engine version, creation and processing state — e.g. an operational health check that verifies a domain is active before routing search traffic. Provide the implementation with Effect.provide(AWS.OpenSearch.DescribeDomainHttp).

const describeDomain = yield* OpenSearch.DescribeDomain();
const result = yield* describeDomain({ DomainName: name });
// result.DomainStatus.Processing → false