| 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:DescribeDocumentClassificationJob` — get the |
| 7 | * properties (status, input/output config, timings) of an asynchronous |
| 8 | * document classification job started with {@link StartDocumentClassificationJob}. |
| 9 | * |
| 10 | * The binding takes no arguments and grants the action on `*` (job APIs |
| 11 | * have no resource-level IAM). |
| 12 | * |
| 13 | * ### Monitoring Analysis Jobs |
| 14 | * **Example:** Poll a DocumentClassification Job |
| 15 | * ```typescript |
| 16 | * // init |
| 17 | * const describeDocumentClassificationJob = yield* AWS.Comprehend.DescribeDocumentClassificationJob(); |
| 18 | * |
| 19 | * // runtime |
| 20 | * const job = yield* describeDocumentClassificationJob({ JobId: jobId }); |
| 21 | * // job.DocumentClassificationJobProperties?.JobStatus: "SUBMITTED" | "IN_PROGRESS" | "COMPLETED" | … |
| 22 | * ``` |
| 23 | * |
| 24 | * @binding |
| 25 | */ |
| 26 | export interface DescribeDocumentClassificationJob extends Binding.Service< |
| 27 | DescribeDocumentClassificationJob, |
| 28 | "AWS.Comprehend.DescribeDocumentClassificationJob", |
| 29 | () => Effect.Effect< |
| 30 | ( |
| 31 | request: comprehend.DescribeDocumentClassificationJobRequest, |
| 32 | ) => Effect.Effect< |
| 33 | comprehend.DescribeDocumentClassificationJobResponse, |
| 34 | comprehend.DescribeDocumentClassificationJobError |
| 35 | > |
| 36 | > |
| 37 | > {} |
| 38 | export const DescribeDocumentClassificationJob = |
| 39 | Binding.Service<DescribeDocumentClassificationJob>( |
| 40 | "AWS.Comprehend.DescribeDocumentClassificationJob", |
| 41 | ); |