sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Comprehend/ StopPiiEntitiesDetectionJob.ts

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

/**
 * Runtime binding for `comprehend:StopPiiEntitiesDetectionJob` — request termination
 * of an in-progress asynchronous PII entity detection job. The job moves to
 * `STOP_REQUESTED` and then `STOPPED`; documents already processed are
 * written to the output location.
 *
 * The binding takes no arguments and grants the action on `*` (job APIs
 * have no resource-level IAM).
 *
 * ### Stopping Analysis Jobs
 * **Example:** Stop a Running PiiEntitiesDetection Job
 * ```typescript
 * // init
 * const stopPiiEntitiesDetectionJob = yield* AWS.Comprehend.StopPiiEntitiesDetectionJob();
 *
 * // runtime
 * const result = yield* stopPiiEntitiesDetectionJob({ JobId: jobId });
 * // result.JobStatus === "STOP_REQUESTED"
 * ```
 *
 * @binding
 */
export interface StopPiiEntitiesDetectionJob extends Binding.Service<
  StopPiiEntitiesDetectionJob,
  "AWS.Comprehend.StopPiiEntitiesDetectionJob",
  () => Effect.Effect<
    (
      request: comprehend.StopPiiEntitiesDetectionJobRequest,
    ) => Effect.Effect<
      comprehend.StopPiiEntitiesDetectionJobResponse,
      comprehend.StopPiiEntitiesDetectionJobError
    >
  >
> {}
export const StopPiiEntitiesDetectionJob = Binding.Service<StopPiiEntitiesDetectionJob>(
  "AWS.Comprehend.StopPiiEntitiesDetectionJob",
);