sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OpenSearch/ DescribeDomains.ts

import type * as opensearch from "@distilled.cloud/aws/opensearch";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for the `DescribeDomains` operation (IAM action
 * `es:DescribeDomains`).
 *
 * Reads the current status of up to five domains in one call — the batch form of `DescribeDomain`. Provide the implementation with
 * `Effect.provide(AWS.OpenSearch.DescribeDomainsHttp)`.
 * ### Monitoring Domains
 * **Example:** Check Several Domains at Once
 * ```typescript
 * const describeDomains = yield* OpenSearch.DescribeDomains();
 *
 * const result = yield* describeDomains({ DomainNames: [a, b] });
 * // result.DomainStatusList → one status per domain
 * ```
 *
 * @binding
 */
export interface DescribeDomains extends Binding.Service<
  DescribeDomains,
  "AWS.OpenSearch.DescribeDomains",
  () => Effect.Effect<
    (
      request: opensearch.DescribeDomainsRequest,
    ) => Effect.Effect<opensearch.DescribeDomainsResponse, opensearch.DescribeDomainsError>
  >
> {}
export const DescribeDomains = Binding.Service<DescribeDomains>("AWS.OpenSearch.DescribeDomains");