sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ImageBuilder/ GetWorkflowStepExecution.ts

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

/**
 * Runtime binding for `imagebuilder:GetWorkflowStepExecution`.
 *
 * Reads the runtime state of one workflow step — its action, status,
 * rollback status, inputs/outputs, and message. Step executions are created
 * dynamically by builds, so this is an account-level binding: pass an id
 * from `ListWorkflowStepExecutions` or `ListWaitingWorkflowSteps`. Provide
 * the implementation with
 * `Effect.provide(AWS.ImageBuilder.GetWorkflowStepExecutionHttp)`.
 * ### Workflow Monitoring
 * **Example:** Read a Workflow Step's State
 * ```typescript
 * // init — account-level binding, no resource argument
 * const getWorkflowStepExecution =
 *   yield* AWS.ImageBuilder.GetWorkflowStepExecution();
 *
 * // runtime
 * const step = yield* getWorkflowStepExecution({ stepExecutionId });
 * yield* Effect.log(`step ${step.name} is ${step.status}`);
 * ```
 *
 * @binding
 */
export interface GetWorkflowStepExecution extends Binding.Service<
  GetWorkflowStepExecution,
  "AWS.ImageBuilder.GetWorkflowStepExecution",
  () => Effect.Effect<
    (
      request: imagebuilder.GetWorkflowStepExecutionRequest,
    ) => Effect.Effect<
      imagebuilder.GetWorkflowStepExecutionResponse,
      imagebuilder.GetWorkflowStepExecutionError
    >
  >
> {}
export const GetWorkflowStepExecution = Binding.Service<GetWorkflowStepExecution>(
  "AWS.ImageBuilder.GetWorkflowStepExecution",
);