sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ StepFunctions/ DescribeExecution.ts

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

export interface DescribeExecutionRequest extends sfn.DescribeExecutionInput {}

/**
 * Runtime binding for `states:DescribeExecution`.
 *
 * Bind this operation to a {@link StateMachine} inside a function runtime to
 * poll the status and output of that machine's executions. IAM access is
 * scoped to executions of the bound state machine.
 * ### Polling Executions
 * **Example:** Check an execution's status
 * ```typescript
 * const describeExecution = yield* StepFunctions.DescribeExecution(machine);
 *
 * const execution = yield* describeExecution({ executionArn });
 * // execution.status: "RUNNING" | "SUCCEEDED" | "FAILED" | ...
 * ```
 *
 * @binding
 */
export interface DescribeExecution extends Binding.Service<
  DescribeExecution,
  "AWS.StepFunctions.DescribeExecution",
  (
    stateMachine: StateMachine,
  ) => Effect.Effect<
    (
      request: DescribeExecutionRequest,
    ) => Effect.Effect<sfn.DescribeExecutionOutput, sfn.DescribeExecutionError>
  >
> {}
export const DescribeExecution = Binding.Service<DescribeExecution>(
  "AWS.StepFunctions.DescribeExecution",
);