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

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

/**
 * Runtime binding for `osis:ValidatePipeline`.
 *
 * Checks whether a Data Prepper pipeline configuration body is valid prior to
 * creation — the building block of config-authoring tooling (validate a
 * generated configuration before calling `CreatePipeline`, or lint
 * user-submitted configs in a self-service portal). Account-level: no
 * resource argument. Provide the implementation with
 * `Effect.provide(AWS.OSIS.ValidatePipelineHttp)`.
 * ### Authoring Pipeline Configurations
 * **Example:** Validate a Configuration Body
 * ```typescript
 * // init — account-level binding, no resource argument
 * const validatePipeline = yield* AWS.OSIS.ValidatePipeline();
 *
 * // runtime
 * const { isValid, Errors } = yield* validatePipeline({
 *   PipelineConfigurationBody: configYaml,
 * });
 * if (!isValid) {
 *   yield* Effect.logError(Errors?.map((e) => e.Message).join("\n") ?? "");
 * }
 * ```
 *
 * @binding
 */
export interface ValidatePipeline extends Binding.Service<
  ValidatePipeline,
  "AWS.OSIS.ValidatePipeline",
  () => Effect.Effect<
    (
      request: osis.ValidatePipelineRequest,
    ) => Effect.Effect<osis.ValidatePipelineResponse, osis.ValidatePipelineError>
  >
> {}
export const ValidatePipeline = Binding.Service<ValidatePipeline>("AWS.OSIS.ValidatePipeline");