sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ MediaPackageV2/ CancelHarvestJob.ts

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

/**
 * Runtime binding for `mediapackagev2:CancelHarvestJob`.
 *
 * Cancels a queued or in-progress harvest job on the bound
 * {@link OriginEndpoint} — e.g. aborting a clip export the operator
 * withdrew. The endpoint's group, channel, and name are injected from the
 * binding. Provide the implementation with
 * `Effect.provide(AWS.MediaPackageV2.CancelHarvestJobHttp)`.
 * ### Harvesting Live-to-VOD Clips
 * **Example:** Cancel an In-Progress Harvest Job
 * ```typescript
 * // init — bind the operation to the endpoint
 * const cancelHarvestJob = yield* AWS.MediaPackageV2.CancelHarvestJob(endpoint);
 *
 * // runtime
 * yield* cancelHarvestJob({ HarvestJobName: job.HarvestJobName });
 * ```
 *
 * @binding
 */
export interface CancelHarvestJob extends Binding.Service<
  CancelHarvestJob,
  "AWS.MediaPackageV2.CancelHarvestJob",
  (
    endpoint: OriginEndpoint,
  ) => Effect.Effect<
    (
      request: Omit<
        mediapackagev2.CancelHarvestJobRequest,
        "ChannelGroupName" | "ChannelName" | "OriginEndpointName"
      >,
    ) => Effect.Effect<
      mediapackagev2.CancelHarvestJobResponse,
      mediapackagev2.CancelHarvestJobError
    >
  >
> {}
export const CancelHarvestJob = Binding.Service<CancelHarvestJob>(
  "AWS.MediaPackageV2.CancelHarvestJob",
);