sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Comprehend/ ListPiiEntitiesDetectionJobs.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:ListPiiEntitiesDetectionJobs` — list the account's
 * asynchronous PII entity detection jobs, with optional status/name/time filters.
 *
 * The binding takes no arguments and grants the action on `*` (job APIs
 * have no resource-level IAM).
 *
 * ### Monitoring Analysis Jobs
 * **Example:** List Recent PiiEntitiesDetection Jobs
 * ```typescript
 * // init
 * const listPiiEntitiesDetectionJobs = yield* AWS.Comprehend.ListPiiEntitiesDetectionJobs();
 *
 * // runtime
 * const page = yield* listPiiEntitiesDetectionJobs({
 *   Filter: { JobStatus: "IN_PROGRESS" },
 *   MaxResults: 25,
 * });
 * // page.PiiEntitiesDetectionJobPropertiesList
 * ```
 *
 * @binding
 */
export interface ListPiiEntitiesDetectionJobs extends Binding.Service<
  ListPiiEntitiesDetectionJobs,
  "AWS.Comprehend.ListPiiEntitiesDetectionJobs",
  () => Effect.Effect<
    (
      request?: comprehend.ListPiiEntitiesDetectionJobsRequest,
    ) => Effect.Effect<
      comprehend.ListPiiEntitiesDetectionJobsResponse,
      comprehend.ListPiiEntitiesDetectionJobsError
    >
  >
> {}
export const ListPiiEntitiesDetectionJobs = Binding.Service<ListPiiEntitiesDetectionJobs>(
  "AWS.Comprehend.ListPiiEntitiesDetectionJobs",
);