sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Glue/ GetJobRun.ts

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

export interface GetJobRunRequest extends Omit<glue.GetJobRunRequest, "JobName"> {}

/**
 * Runtime binding for `glue:GetJobRun`.
 *
 * Reads the metadata of a single run of the bound {@link Job} — its
 * `JobRunState` (`RUNNING`, `SUCCEEDED`, `FAILED`, `TIMEOUT`, …), timings,
 * and error message — so a function can poll a run it started to a terminal
 * state. The job name is injected from the binding. Provide the
 * implementation with `Effect.provide(AWS.Glue.GetJobRunHttp)`.
 * ### Running Jobs
 * **Example:** Poll a Run to a Terminal State
 * ```typescript
 * // init
 * const getJobRun = yield* AWS.Glue.GetJobRun(job);
 *
 * // runtime
 * const { JobRun } = yield* getJobRun({ RunId: runId });
 * if (JobRun?.JobRunState === "FAILED") {
 *   yield* Effect.logError(JobRun.ErrorMessage ?? "run failed");
 * }
 * ```
 *
 * @binding
 */
export interface GetJobRun extends Binding.Service<
  GetJobRun,
  "AWS.Glue.GetJobRun",
  (
    job: Job,
  ) => Effect.Effect<
    (request: GetJobRunRequest) => Effect.Effect<glue.GetJobRunResponse, glue.GetJobRunError>
  >
> {}

export const GetJobRun = Binding.Service<GetJobRun>("AWS.Glue.GetJobRun");