| 1 | import type * as opensearch from "@distilled.cloud/aws/opensearch"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | |
| 5 | /** |
| 6 | * Runtime binding for the `DescribeDomain` operation (IAM action |
| 7 | * `es:DescribeDomain`). |
| 8 | * |
| 9 | * 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 |
| 10 | * `Effect.provide(AWS.OpenSearch.DescribeDomainHttp)`. |
| 11 | * ### Monitoring Domains |
| 12 | * **Example:** Check a Domain's Status |
| 13 | * ```typescript |
| 14 | * const describeDomain = yield* OpenSearch.DescribeDomain(); |
| 15 | * |
| 16 | * const result = yield* describeDomain({ DomainName: name }); |
| 17 | * // result.DomainStatus.Processing → false |
| 18 | * ``` |
| 19 | * |
| 20 | * @binding |
| 21 | */ |
| 22 | export interface DescribeDomain extends Binding.Service< |
| 23 | DescribeDomain, |
| 24 | "AWS.OpenSearch.DescribeDomain", |
| 25 | () => Effect.Effect< |
| 26 | ( |
| 27 | request: opensearch.DescribeDomainRequest, |
| 28 | ) => Effect.Effect< |
| 29 | opensearch.DescribeDomainResponse, |
| 30 | opensearch.DescribeDomainError |
| 31 | > |
| 32 | > |
| 33 | > {} |
| 34 | export const DescribeDomain = Binding.Service<DescribeDomain>( |
| 35 | "AWS.OpenSearch.DescribeDomain", |
| 36 | ); |