| 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:ContainsPiiEntities` — check whether the |
| 7 | * input text contains personally identifiable information, returning the |
| 8 | * PII entity-type labels present (without offsets; use |
| 9 | * {@link DetectPiiEntities} to locate them). |
| 10 | * |
| 11 | * The binding takes no arguments and grants the action on `*` (the action |
| 12 | * has no resource-level IAM). |
| 13 | * |
| 14 | * ### Real-Time Analysis |
| 15 | * **Example:** Check a Document for PII |
| 16 | * ```typescript |
| 17 | * // init |
| 18 | * const containsPiiEntities = yield* AWS.Comprehend.ContainsPiiEntities(); |
| 19 | * |
| 20 | * // runtime |
| 21 | * const result = yield* containsPiiEntities({ |
| 22 | * Text: "My name is Jane Doe and my email is jane@example.com.", |
| 23 | * LanguageCode: "en", |
| 24 | * }); |
| 25 | * // result.Labels: [{ Name: "NAME" }, { Name: "EMAIL" }] |
| 26 | * ``` |
| 27 | * |
| 28 | * @binding |
| 29 | */ |
| 30 | export interface ContainsPiiEntities extends Binding.Service< |
| 31 | ContainsPiiEntities, |
| 32 | "AWS.Comprehend.ContainsPiiEntities", |
| 33 | () => Effect.Effect< |
| 34 | ( |
| 35 | request: comprehend.ContainsPiiEntitiesRequest, |
| 36 | ) => Effect.Effect< |
| 37 | comprehend.ContainsPiiEntitiesResponse, |
| 38 | comprehend.ContainsPiiEntitiesError |
| 39 | > |
| 40 | > |
| 41 | > {} |
| 42 | export const ContainsPiiEntities = Binding.Service<ContainsPiiEntities>( |
| 43 | "AWS.Comprehend.ContainsPiiEntities", |
| 44 | ); |