@aws-sdk/client-textract 3.216.0 → 3.222.0

package/dist-types/Textract.d.ts

@@ -6,9 +6,12 @@ import { DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput } from
 import { GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput } from "./commands/GetDocumentAnalysisCommand";
 import { GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput } from "./commands/GetDocumentTextDetectionCommand";
 import { GetExpenseAnalysisCommandInput, GetExpenseAnalysisCommandOutput } from "./commands/GetExpenseAnalysisCommand";
+import { GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput } from "./commands/GetLendingAnalysisCommand";
+import { GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput } from "./commands/GetLendingAnalysisSummaryCommand";
 import { StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput } from "./commands/StartDocumentAnalysisCommand";
 import { StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput } from "./commands/StartDocumentTextDetectionCommand";
 import { StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput } from "./commands/StartExpenseAnalysisCommand";
+import { StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput } from "./commands/StartLendingAnalysisCommand";
 import { TextractClient } from "./TextractClient";
 /**
  * <p>Amazon Textract detects and analyzes text in documents and converts it
@@ -241,6 +244,39 @@ export declare class Textract extends TextractClient {
     getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<GetExpenseAnalysisCommandOutput>;
     getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
     getExpenseAnalysis(args: GetExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void): void;
+    /**
+     * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
+     *             lending document. </p>
+     *         <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
+     *             which returns a job identifier (<code>JobId</code>). When the text analysis operation
+     *             finishes, Amazon Textract publishes a completion status to the Amazon Simple
+     *             Notification Service (Amazon SNS) topic that's registered in the initial call to
+     *                 <code>StartLendingAnalysis</code>. </p>
+     *         <p>To get the results of the text analysis operation, first check that the status value
+     *             published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass
+     *             the job identifier (<code>JobId</code>) from the initial call to
+     *                 <code>StartLendingAnalysis</code>.</p>
+     */
+    getLendingAnalysis(args: GetLendingAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<GetLendingAnalysisCommandOutput>;
+    getLendingAnalysis(args: GetLendingAnalysisCommandInput, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
+    getLendingAnalysis(args: GetLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void): void;
+    /**
+     * <p>Gets summarized results for the <code>StartLendingAnalysis</code> operation, which analyzes
+     *    text in a lending document. The returned summary consists of information about documents grouped
+     *    together by a common document type. Information like detected signatures, page numbers, and split
+     *    documents is returned with respect to the type of grouped document. </p>
+     *          <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>, which
+     *    returns a job identifier (<code>JobId</code>). When the text analysis operation finishes, Amazon
+     *    Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
+     *    topic that's registered in the initial call to <code>StartLendingAnalysis</code>. </p>
+     *          <p>To get the results of the text analysis operation, first check that the status value
+     *    published to the Amazon SNS topic is SUCCEEDED. If so, call
+     *     <code>GetLendingAnalysisSummary</code>, and pass the job identifier (<code>JobId</code>) from
+     *    the initial call to <code>StartLendingAnalysis</code>.</p>
+     */
+    getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetLendingAnalysisSummaryCommandOutput>;
+    getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
+    getLendingAnalysisSummary(args: GetLendingAnalysisSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void): void;
     /**
      * <p>Starts the asynchronous analysis of an input document for relationships between detected
      *          items such as key-value pairs, tables, and selection elements.</p>
@@ -307,4 +343,40 @@ export declare class Textract extends TextractClient {
     startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<StartExpenseAnalysisCommandOutput>;
     startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
     startExpenseAnalysis(args: StartExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void): void;
+    /**
+     * <p>Starts the classification and analysis of an input document.
+     *     <code>StartLendingAnalysis</code> initiates the classification and analysis of a packet of
+     *    lending documents. <code>StartLendingAnalysis</code> operates on a document file located in an
+     *    Amazon S3 bucket.</p>
+     *          <p>
+     *             <code>StartLendingAnalysis</code> can analyze text in documents that are in one of the
+     *    following formats: JPEG, PNG, TIFF, PDF. Use <code>DocumentLocation</code> to specify the bucket
+     *    name and the file name of the document. </p>
+     *          <p>
+     *             <code>StartLendingAnalysis</code> returns a job identifier (<code>JobId</code>) that you use
+     *    to get the results of the operation. When the text analysis is finished, Amazon Textract
+     *    publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that
+     *    you specify in <code>NotificationChannel</code>. To get the results of the text analysis
+     *    operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If
+     *    the status is SUCCEEDED you can call either <code>GetLendingAnalysis</code> or
+     *     <code>GetLendingAnalysisSummary</code> and provide the <code>JobId</code> to obtain the results
+     *    of the analysis.</p>
+     *          <p>If using <code>OutputConfig</code> to specify an Amazon S3 bucket, the output will be contained
+     *    within the specified prefix in a directory labeled with the job-id. In the directory there are 3
+     *    sub-directories: </p>
+     *          <ul>
+     *             <li>
+     *                <p>detailedResponse (contains the GetLendingAnalysis response)</p>
+     *             </li>
+     *             <li>
+     *                <p>summaryResponse (for the GetLendingAnalysisSummary response)</p>
+     *             </li>
+     *             <li>
+     *                <p>splitDocuments (documents split across logical boundaries)</p>
+     *             </li>
+     *          </ul>
+     */
+    startLendingAnalysis(args: StartLendingAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<StartLendingAnalysisCommandOutput>;
+    startLendingAnalysis(args: StartLendingAnalysisCommandInput, cb: (err: any, data?: StartLendingAnalysisCommandOutput) => void): void;
+    startLendingAnalysis(args: StartLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLendingAnalysisCommandOutput) => void): void;
 }

package/dist-types/TextractClient.d.ts

@@ -14,12 +14,15 @@ import { DetectDocumentTextCommandInput, DetectDocumentTextCommandOutput } from
 import { GetDocumentAnalysisCommandInput, GetDocumentAnalysisCommandOutput } from "./commands/GetDocumentAnalysisCommand";
 import { GetDocumentTextDetectionCommandInput, GetDocumentTextDetectionCommandOutput } from "./commands/GetDocumentTextDetectionCommand";
 import { GetExpenseAnalysisCommandInput, GetExpenseAnalysisCommandOutput } from "./commands/GetExpenseAnalysisCommand";
+import { GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput } from "./commands/GetLendingAnalysisCommand";
+import { GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput } from "./commands/GetLendingAnalysisSummaryCommand";
 import { StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput } from "./commands/StartDocumentAnalysisCommand";
 import { StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput } from "./commands/StartDocumentTextDetectionCommand";
 import { StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput } from "./commands/StartExpenseAnalysisCommand";
+import { StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput } from "./commands/StartLendingAnalysisCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
-export declare type ServiceInputTypes = AnalyzeDocumentCommandInput | AnalyzeExpenseCommandInput | AnalyzeIDCommandInput | DetectDocumentTextCommandInput | GetDocumentAnalysisCommandInput | GetDocumentTextDetectionCommandInput | GetExpenseAnalysisCommandInput | StartDocumentAnalysisCommandInput | StartDocumentTextDetectionCommandInput | StartExpenseAnalysisCommandInput;
-export declare type ServiceOutputTypes = AnalyzeDocumentCommandOutput | AnalyzeExpenseCommandOutput | AnalyzeIDCommandOutput | DetectDocumentTextCommandOutput | GetDocumentAnalysisCommandOutput | GetDocumentTextDetectionCommandOutput | GetExpenseAnalysisCommandOutput | StartDocumentAnalysisCommandOutput | StartDocumentTextDetectionCommandOutput | StartExpenseAnalysisCommandOutput;
+export declare type ServiceInputTypes = AnalyzeDocumentCommandInput | AnalyzeExpenseCommandInput | AnalyzeIDCommandInput | DetectDocumentTextCommandInput | GetDocumentAnalysisCommandInput | GetDocumentTextDetectionCommandInput | GetExpenseAnalysisCommandInput | GetLendingAnalysisCommandInput | GetLendingAnalysisSummaryCommandInput | StartDocumentAnalysisCommandInput | StartDocumentTextDetectionCommandInput | StartExpenseAnalysisCommandInput | StartLendingAnalysisCommandInput;
+export declare type ServiceOutputTypes = AnalyzeDocumentCommandOutput | AnalyzeExpenseCommandOutput | AnalyzeIDCommandOutput | DetectDocumentTextCommandOutput | GetDocumentAnalysisCommandOutput | GetDocumentTextDetectionCommandOutput | GetExpenseAnalysisCommandOutput | GetLendingAnalysisCommandOutput | GetLendingAnalysisSummaryCommandOutput | StartDocumentAnalysisCommandOutput | StartDocumentTextDetectionCommandOutput | StartExpenseAnalysisCommandOutput | StartLendingAnalysisCommandOutput;
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.

package/dist-types/commands/GetLendingAnalysisCommand.d.ts

@@ -0,0 +1,47 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetLendingAnalysisRequest, GetLendingAnalysisResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+export interface GetLendingAnalysisCommandInput extends GetLendingAnalysisRequest {
+}
+export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisResponse, __MetadataBearer {
+}
+/**
+ * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
+ *             lending document. </p>
+ *         <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>,
+ *             which returns a job identifier (<code>JobId</code>). When the text analysis operation
+ *             finishes, Amazon Textract publishes a completion status to the Amazon Simple
+ *             Notification Service (Amazon SNS) topic that's registered in the initial call to
+ *                 <code>StartLendingAnalysis</code>. </p>
+ *         <p>To get the results of the text analysis operation, first check that the status value
+ *             published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass
+ *             the job identifier (<code>JobId</code>) from the initial call to
+ *                 <code>StartLendingAnalysis</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, GetLendingAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, GetLendingAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const command = new GetLendingAnalysisCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetLendingAnalysisCommandInput} for command's `input` shape.
+ * @see {@link GetLendingAnalysisCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ */
+export declare class GetLendingAnalysisCommand extends $Command<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput, TextractClientResolvedConfig> {
+    readonly input: GetLendingAnalysisCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: GetLendingAnalysisCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/GetLendingAnalysisSummaryCommand.d.ts

@@ -0,0 +1,48 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetLendingAnalysisSummaryRequest, GetLendingAnalysisSummaryResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+export interface GetLendingAnalysisSummaryCommandInput extends GetLendingAnalysisSummaryRequest {
+}
+export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalysisSummaryResponse, __MetadataBearer {
+}
+/**
+ * <p>Gets summarized results for the <code>StartLendingAnalysis</code> operation, which analyzes
+ *    text in a lending document. The returned summary consists of information about documents grouped
+ *    together by a common document type. Information like detected signatures, page numbers, and split
+ *    documents is returned with respect to the type of grouped document. </p>
+ *          <p>You start asynchronous text analysis by calling <code>StartLendingAnalysis</code>, which
+ *    returns a job identifier (<code>JobId</code>). When the text analysis operation finishes, Amazon
+ *    Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
+ *    topic that's registered in the initial call to <code>StartLendingAnalysis</code>. </p>
+ *          <p>To get the results of the text analysis operation, first check that the status value
+ *    published to the Amazon SNS topic is SUCCEEDED. If so, call
+ *     <code>GetLendingAnalysisSummary</code>, and pass the job identifier (<code>JobId</code>) from
+ *    the initial call to <code>StartLendingAnalysis</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, GetLendingAnalysisSummaryCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, GetLendingAnalysisSummaryCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const command = new GetLendingAnalysisSummaryCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetLendingAnalysisSummaryCommandInput} for command's `input` shape.
+ * @see {@link GetLendingAnalysisSummaryCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ */
+export declare class GetLendingAnalysisSummaryCommand extends $Command<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput, TextractClientResolvedConfig> {
+    readonly input: GetLendingAnalysisSummaryCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: GetLendingAnalysisSummaryCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/StartLendingAnalysisCommand.d.ts

@@ -0,0 +1,67 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { StartLendingAnalysisRequest, StartLendingAnalysisResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+export interface StartLendingAnalysisCommandInput extends StartLendingAnalysisRequest {
+}
+export interface StartLendingAnalysisCommandOutput extends StartLendingAnalysisResponse, __MetadataBearer {
+}
+/**
+ * <p>Starts the classification and analysis of an input document.
+ *     <code>StartLendingAnalysis</code> initiates the classification and analysis of a packet of
+ *    lending documents. <code>StartLendingAnalysis</code> operates on a document file located in an
+ *    Amazon S3 bucket.</p>
+ *          <p>
+ *             <code>StartLendingAnalysis</code> can analyze text in documents that are in one of the
+ *    following formats: JPEG, PNG, TIFF, PDF. Use <code>DocumentLocation</code> to specify the bucket
+ *    name and the file name of the document. </p>
+ *          <p>
+ *             <code>StartLendingAnalysis</code> returns a job identifier (<code>JobId</code>) that you use
+ *    to get the results of the operation. When the text analysis is finished, Amazon Textract
+ *    publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that
+ *    you specify in <code>NotificationChannel</code>. To get the results of the text analysis
+ *    operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If
+ *    the status is SUCCEEDED you can call either <code>GetLendingAnalysis</code> or
+ *     <code>GetLendingAnalysisSummary</code> and provide the <code>JobId</code> to obtain the results
+ *    of the analysis.</p>
+ *          <p>If using <code>OutputConfig</code> to specify an Amazon S3 bucket, the output will be contained
+ *    within the specified prefix in a directory labeled with the job-id. In the directory there are 3
+ *    sub-directories: </p>
+ *          <ul>
+ *             <li>
+ *                <p>detailedResponse (contains the GetLendingAnalysis response)</p>
+ *             </li>
+ *             <li>
+ *                <p>summaryResponse (for the GetLendingAnalysisSummary response)</p>
+ *             </li>
+ *             <li>
+ *                <p>splitDocuments (documents split across logical boundaries)</p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, StartLendingAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, StartLendingAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const command = new StartLendingAnalysisCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link StartLendingAnalysisCommandInput} for command's `input` shape.
+ * @see {@link StartLendingAnalysisCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ */
+export declare class StartLendingAnalysisCommand extends $Command<StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput, TextractClientResolvedConfig> {
+    readonly input: StartLendingAnalysisCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: StartLendingAnalysisCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -5,6 +5,9 @@ export * from "./DetectDocumentTextCommand";
 export * from "./GetDocumentAnalysisCommand";
 export * from "./GetDocumentTextDetectionCommand";
 export * from "./GetExpenseAnalysisCommand";
+export * from "./GetLendingAnalysisCommand";
+export * from "./GetLendingAnalysisSummaryCommand";
 export * from "./StartDocumentAnalysisCommand";
 export * from "./StartDocumentTextDetectionCommand";
 export * from "./StartExpenseAnalysisCommand";
+export * from "./StartLendingAnalysisCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region?: string;
+    Region: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;