sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ FIS/ GetExperiment.ts

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

/**
 * Runtime binding for `fis:GetExperiment`.
 *
 * Reads a running or finished experiment — its state (`pending`,
 * `initiating`, `running`, `completed`, `stopped`, `failed`), per-action
 * progress, and log/report configuration. Experiments are created
 * dynamically, so this is an account-level binding addressed by experiment
 * id. Provide the implementation with
 * `Effect.provide(AWS.FIS.GetExperimentHttp)`.
 * ### Running Experiments
 * **Example:** Poll an Experiment's State
 * ```typescript
 * // init — account-level binding, no resource argument
 * const getExperiment = yield* AWS.FIS.GetExperiment();
 *
 * // runtime
 * const { experiment } = yield* getExperiment({ id: experimentId });
 * console.log(experiment?.state?.status);
 * ```
 *
 * @binding
 */
export interface GetExperiment extends Binding.Service<
  GetExperiment,
  "AWS.FIS.GetExperiment",
  () => Effect.Effect<
    (
      request: fis.GetExperimentRequest,
    ) => Effect.Effect<fis.GetExperimentResponse, fis.GetExperimentError>
  >
> {}
export const GetExperiment = Binding.Service<GetExperiment>("AWS.FIS.GetExperiment");