sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OpenSearch/ DescribeDomainNodes.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 `DescribeDomainNodes` operation (IAM action
 * `es:DescribeDomainNodes`).
 *
 * Lists a domain's individual nodes — type (data/master/UltraWarm), Availability Zone, instance type, and storage — for node-level diagnostics. Provide the implementation with
 * `Effect.provide(AWS.OpenSearch.DescribeDomainNodesHttp)`.
 * ### Monitoring Domains
 * **Example:** List a Domain's Nodes
 * ```typescript
 * const describeDomainNodes = yield* OpenSearch.DescribeDomainNodes();
 *
 * const result = yield* describeDomainNodes({ DomainName: name });
 * // result.DomainNodesStatusList → one entry per node
 * ```
 *
 * @binding
 */
export interface DescribeDomainNodes extends Binding.Service<
  DescribeDomainNodes,
  "AWS.OpenSearch.DescribeDomainNodes",
  () => Effect.Effect<
    (
      request: opensearch.DescribeDomainNodesRequest,
    ) => Effect.Effect<opensearch.DescribeDomainNodesResponse, opensearch.DescribeDomainNodesError>
  >
> {}
export const DescribeDomainNodes = Binding.Service<DescribeDomainNodes>(
  "AWS.OpenSearch.DescribeDomainNodes",
);