sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OpenSearch/ DescribeDomainChangeProgress.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 `DescribeDomainChangeProgress` operation (IAM action
 * `es:DescribeDomainChangeProgress`).
 *
 * Tracks the stage-by-stage progress of a domain's in-flight configuration change (blue/green deployment) — e.g. to report how far along a cluster resize is. Provide the implementation with
 * `Effect.provide(AWS.OpenSearch.DescribeDomainChangeProgressHttp)`.
 * ### Monitoring Domains
 * **Example:** Track a Configuration Change
 * ```typescript
 * const describeDomainChangeProgress = yield* OpenSearch.DescribeDomainChangeProgress();
 *
 * const result = yield* describeDomainChangeProgress({ DomainName: name });
 * // result.ChangeProgressStatus?.Status → "COMPLETED"
 * ```
 *
 * @binding
 */
export interface DescribeDomainChangeProgress extends Binding.Service<
  DescribeDomainChangeProgress,
  "AWS.OpenSearch.DescribeDomainChangeProgress",
  () => Effect.Effect<
    (
      request: opensearch.DescribeDomainChangeProgressRequest,
    ) => Effect.Effect<
      opensearch.DescribeDomainChangeProgressResponse,
      opensearch.DescribeDomainChangeProgressError
    >
  >
> {}
export const DescribeDomainChangeProgress = Binding.Service<DescribeDomainChangeProgress>(
  "AWS.OpenSearch.DescribeDomainChangeProgress",
);