| 1 | import type * as comprehendmedical from "@distilled.cloud/aws/comprehendmedical"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | |
| 5 | /** |
| 6 | * Runtime binding for `comprehendmedical:DescribePHIDetectionJob` — get the properties and status of an asynchronous protected health information (PHI) detection job. |
| 7 | * |
| 8 | * Comprehend Medical has no resource-level IAM, so the binding takes no |
| 9 | * arguments and grants `comprehendmedical:DescribePHIDetectionJob` on `*`. Provide the |
| 10 | * implementation with `Effect.provide(AWS.ComprehendMedical.DescribePHIDetectionJobHttp)`. |
| 11 | * |
| 12 | * ### Batch PHI Detection Jobs |
| 13 | * **Example:** Poll a Job's Status |
| 14 | * ```typescript |
| 15 | * // init |
| 16 | * const describePHIDetectionJob = yield* AWS.ComprehendMedical.DescribePHIDetectionJob(); |
| 17 | * |
| 18 | * // runtime |
| 19 | * const status = yield* describePHIDetectionJob({ JobId: jobId }); |
| 20 | * console.log(status.ComprehendMedicalAsyncJobProperties?.JobStatus); |
| 21 | * ``` |
| 22 | * |
| 23 | * @binding |
| 24 | */ |
| 25 | export interface DescribePHIDetectionJob extends Binding.Service< |
| 26 | DescribePHIDetectionJob, |
| 27 | "AWS.ComprehendMedical.DescribePHIDetectionJob", |
| 28 | () => Effect.Effect< |
| 29 | ( |
| 30 | request: comprehendmedical.DescribePHIDetectionJobRequest, |
| 31 | ) => Effect.Effect< |
| 32 | comprehendmedical.DescribePHIDetectionJobResponse, |
| 33 | comprehendmedical.DescribePHIDetectionJobError |
| 34 | > |
| 35 | > |
| 36 | > {} |
| 37 | export const DescribePHIDetectionJob = Binding.Service<DescribePHIDetectionJob>( |
| 38 | "AWS.ComprehendMedical.DescribePHIDetectionJob", |
| 39 | ); |