sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Textract/ GetLendingAnalysisSummary.ts

import type * as textract from "@distilled.cloud/aws/textract";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `textract:GetLendingAnalysisSummary` — read the
 * document-group summary of an asynchronous lending-analysis job started
 * with `StartLendingAnalysis`.
 *
 * ### Asynchronous Lending Analysis
 * **Example:** Summarize a Lending Analysis Job
 * ```typescript
 * // init
 * const getLendingAnalysisSummary =
 *   yield* AWS.Textract.GetLendingAnalysisSummary();
 *
 * // runtime
 * const result = yield* getLendingAnalysisSummary({ JobId: jobId });
 * const groups = result.Summary?.DocumentGroups;
 * ```
 *
 * @binding
 */
export interface GetLendingAnalysisSummary extends Binding.Service<
  GetLendingAnalysisSummary,
  "AWS.Textract.GetLendingAnalysisSummary",
  () => Effect.Effect<
    (
      request: textract.GetLendingAnalysisSummaryRequest,
    ) => Effect.Effect<
      textract.GetLendingAnalysisSummaryResponse,
      textract.GetLendingAnalysisSummaryError
    >
  >
> {}
export const GetLendingAnalysisSummary = Binding.Service<GetLendingAnalysisSummary>(
  "AWS.Textract.GetLendingAnalysisSummary",
);