| 1 | import type * as comprehend from "@distilled.cloud/aws/comprehend"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | |
| 5 | /** |
| 6 | * Runtime binding for `comprehend:StopSentimentDetectionJob` — request termination |
| 7 | * of an in-progress asynchronous sentiment detection job. The job moves to |
| 8 | * `STOP_REQUESTED` and then `STOPPED`; documents already processed are |
| 9 | * written to the output location. |
| 10 | * |
| 11 | * The binding takes no arguments and grants the action on `*` (job APIs |
| 12 | * have no resource-level IAM). |
| 13 | * |
| 14 | * ### Stopping Analysis Jobs |
| 15 | * **Example:** Stop a Running SentimentDetection Job |
| 16 | * ```typescript |
| 17 | * // init |
| 18 | * const stopSentimentDetectionJob = yield* AWS.Comprehend.StopSentimentDetectionJob(); |
| 19 | * |
| 20 | * // runtime |
| 21 | * const result = yield* stopSentimentDetectionJob({ JobId: jobId }); |
| 22 | * // result.JobStatus === "STOP_REQUESTED" |
| 23 | * ``` |
| 24 | * |
| 25 | * @binding |
| 26 | */ |
| 27 | export interface StopSentimentDetectionJob extends Binding.Service< |
| 28 | StopSentimentDetectionJob, |
| 29 | "AWS.Comprehend.StopSentimentDetectionJob", |
| 30 | () => Effect.Effect< |
| 31 | ( |
| 32 | request: comprehend.StopSentimentDetectionJobRequest, |
| 33 | ) => Effect.Effect< |
| 34 | comprehend.StopSentimentDetectionJobResponse, |
| 35 | comprehend.StopSentimentDetectionJobError |
| 36 | > |
| 37 | > |
| 38 | > {} |
| 39 | export const StopSentimentDetectionJob = |
| 40 | Binding.Service<StopSentimentDetectionJob>( |
| 41 | "AWS.Comprehend.StopSentimentDetectionJob", |
| 42 | ); |