sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Comprehend/ ContainsPiiEntities.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:ContainsPiiEntities` — check whether the
 * input text contains personally identifiable information, returning the
 * PII entity-type labels present (without offsets; use
 * {@link DetectPiiEntities} to locate them).
 *
 * The binding takes no arguments and grants the action on `*` (the action
 * has no resource-level IAM).
 *
 * ### Real-Time Analysis
 * **Example:** Check a Document for PII
 * ```typescript
 * // init
 * const containsPiiEntities = yield* AWS.Comprehend.ContainsPiiEntities();
 *
 * // runtime
 * const result = yield* containsPiiEntities({
 *   Text: "My name is Jane Doe and my email is jane@example.com.",
 *   LanguageCode: "en",
 * });
 * // result.Labels: [{ Name: "NAME" }, { Name: "EMAIL" }]
 * ```
 *
 * @binding
 */
export interface ContainsPiiEntities extends Binding.Service<
  ContainsPiiEntities,
  "AWS.Comprehend.ContainsPiiEntities",
  () => Effect.Effect<
    (
      request: comprehend.ContainsPiiEntitiesRequest,
    ) => Effect.Effect<comprehend.ContainsPiiEntitiesResponse, comprehend.ContainsPiiEntitiesError>
  >
> {}
export const ContainsPiiEntities = Binding.Service<ContainsPiiEntities>(
  "AWS.Comprehend.ContainsPiiEntities",
);