sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Personalize/ DescribeBatchInferenceJob.ts

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

/**
 * Runtime binding for `personalize:DescribeBatchInferenceJob` — Polls a batch inference job for completion — pairs with
 * {@link CreateBatchInferenceJob}.
 * Provide the implementation with
 * `Effect.provide(AWS.Personalize.DescribeBatchInferenceJobHttp)`.
 *
 * ### Batch Inference
 * **Example:** Poll a Batch Job
 * ```typescript
 * // init
 * const describeBatchInferenceJob = yield* Personalize.DescribeBatchInferenceJob();
 *
 * const { batchInferenceJob } = yield* describeBatchInferenceJob({
 *   batchInferenceJobArn,
 * });
 * const done = batchInferenceJob?.status === "ACTIVE";
 * ```
 *
 * @binding
 */
export interface DescribeBatchInferenceJob extends Binding.Service<
  DescribeBatchInferenceJob,
  "AWS.Personalize.DescribeBatchInferenceJob",
  () => Effect.Effect<
    (
      request: personalize.DescribeBatchInferenceJobRequest,
    ) => Effect.Effect<
      personalize.DescribeBatchInferenceJobResponse,
      personalize.DescribeBatchInferenceJobError
    >
  >
> {}
export const DescribeBatchInferenceJob = Binding.Service<DescribeBatchInferenceJob>(
  "AWS.Personalize.DescribeBatchInferenceJob",
);