sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OSIS/ StartPipeline.ts

import type * as osis from "@distilled.cloud/aws/osis";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Pipeline } from "./Pipeline.ts";

/**
 * Runtime binding for `osis:StartPipeline`.
 *
 * Starts the bound {@link Pipeline} after it was stopped — e.g. resuming
 * ingestion on a schedule or in response to an operational signal. Starting
 * takes several minutes; the response reports the transitional `STARTING`
 * status. The pipeline name is injected from the binding. Provide the
 * implementation with `Effect.provide(AWS.OSIS.StartPipelineHttp)`.
 * ### Controlling a Pipeline
 * **Example:** Resume Ingestion
 * ```typescript
 * // init — bind the operation to the pipeline
 * const startPipeline = yield* AWS.OSIS.StartPipeline(pipeline);
 *
 * // runtime
 * const { Pipeline } = yield* startPipeline();
 * // Pipeline?.Status === "STARTING"
 * ```
 *
 * @binding
 */
export interface StartPipeline extends Binding.Service<
  StartPipeline,
  "AWS.OSIS.StartPipeline",
  (
    pipeline: Pipeline,
  ) => Effect.Effect<() => Effect.Effect<osis.StartPipelineResponse, osis.StartPipelineError>>
> {}
export const StartPipeline = Binding.Service<StartPipeline>("AWS.OSIS.StartPipeline");