sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ OSIS/ GetPipelineBlueprint.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:GetPipelineBlueprint`.
 *
 * Retrieves one Data Prepper blueprint's full configuration template so
 * config-authoring tooling can render or specialize it (pair with
 * {@link ListPipelineBlueprints} to discover blueprint names). Account-level:
 * no resource argument. Provide the implementation with
 * `Effect.provide(AWS.OSIS.GetPipelineBlueprintHttp)`.
 * ### Authoring Pipeline Configurations
 * **Example:** Fetch a Blueprint's Template
 * ```typescript
 * // init — account-level binding, no resource argument
 * const getPipelineBlueprint = yield* AWS.OSIS.GetPipelineBlueprint();
 *
 * // runtime
 * const { Blueprint } = yield* getPipelineBlueprint({
 *   BlueprintName: "AWS-ApacheLogPipeline",
 * });
 * // Blueprint?.PipelineConfigurationBody — the YAML template
 * ```
 *
 * @binding
 */
export interface GetPipelineBlueprint extends Binding.Service<
  GetPipelineBlueprint,
  "AWS.OSIS.GetPipelineBlueprint",
  () => Effect.Effect<
    (
      request: osis.GetPipelineBlueprintRequest,
    ) => Effect.Effect<osis.GetPipelineBlueprintResponse, osis.GetPipelineBlueprintError>
  >
> {}
export const GetPipelineBlueprint = Binding.Service<GetPipelineBlueprint>(
  "AWS.OSIS.GetPipelineBlueprint",
);