@aws-sdk/client-textract 3.296.0 → 3.298.0

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

@@ -4,24 +4,29 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetLendingAnalysisRequest, GetLendingAnalysisResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link GetLendingAnalysisCommand}.
  */
 export interface GetLendingAnalysisCommandInput extends GetLendingAnalysisRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetLendingAnalysisCommand}.
  */
 export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>,
+ *          <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
+ *          <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>
@@ -35,6 +40,8 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param GetLendingAnalysisCommandInput - {@link GetLendingAnalysisCommandInput}
+ * @returns {@link GetLendingAnalysisCommandOutput}
  * @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.
@@ -78,11 +85,20 @@ export interface GetLendingAnalysisCommandOutput extends GetLendingAnalysisRespo
 export declare class GetLendingAnalysisCommand extends $Command<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput, TextractClientResolvedConfig> {
     readonly input: GetLendingAnalysisCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetLendingAnalysisCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisCommandInput, GetLendingAnalysisCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetLendingAnalysisSummaryRequest, GetLendingAnalysisSummaryResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link GetLendingAnalysisSummaryCommand}.
  */
 export interface GetLendingAnalysisSummaryCommandInput extends GetLendingAnalysisSummaryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetLendingAnalysisSummaryCommand}.
  */
 export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalysisSummaryResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -36,6 +41,8 @@ export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalys
  * const response = await client.send(command);
  * ```
  *
+ * @param GetLendingAnalysisSummaryCommandInput - {@link GetLendingAnalysisSummaryCommandInput}
+ * @returns {@link GetLendingAnalysisSummaryCommandOutput}
  * @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.
@@ -79,11 +86,20 @@ export interface GetLendingAnalysisSummaryCommandOutput extends GetLendingAnalys
 export declare class GetLendingAnalysisSummaryCommand extends $Command<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput, TextractClientResolvedConfig> {
     readonly input: GetLendingAnalysisSummaryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetLendingAnalysisSummaryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLendingAnalysisSummaryCommandInput, GetLendingAnalysisSummaryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartDocumentAnalysisRequest, StartDocumentAnalysisResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link StartDocumentAnalysisCommand}.
  */
 export interface StartDocumentAnalysisCommandInput extends StartDocumentAnalysisRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartDocumentAnalysisCommand}.
  */
 export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysisResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts the asynchronous analysis of an input document for relationships between detected
  *          items such as key-value pairs, tables, and selection elements.</p>
- *
  *          <p>
  *             <code>StartDocumentAnalysis</code> can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The
  *          documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
@@ -42,6 +46,8 @@ export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysi
  * const response = await client.send(command);
  * ```
  *
+ * @param StartDocumentAnalysisCommandInput - {@link StartDocumentAnalysisCommandInput}
+ * @returns {@link StartDocumentAnalysisCommandOutput}
  * @see {@link StartDocumentAnalysisCommandInput} for command's `input` shape.
  * @see {@link StartDocumentAnalysisCommandOutput} for command's `response` shape.
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -107,11 +113,20 @@ export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysi
 export declare class StartDocumentAnalysisCommand extends $Command<StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartDocumentAnalysisCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartDocumentAnalysisCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDocumentAnalysisCommandInput, StartDocumentAnalysisCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartDocumentTextDetectionRequest, StartDocumentTextDetectionResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link StartDocumentTextDetectionCommand}.
  */
 export interface StartDocumentTextDetectionCommandInput extends StartDocumentTextDetectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartDocumentTextDetectionCommand}.
  */
 export interface StartDocumentTextDetectionCommandOutput extends StartDocumentTextDetectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of
  *          text and the words that make up a line of text.</p>
  *          <p>
@@ -41,6 +46,8 @@ export interface StartDocumentTextDetectionCommandOutput extends StartDocumentTe
  * const response = await client.send(command);
  * ```
  *
+ * @param StartDocumentTextDetectionCommandInput - {@link StartDocumentTextDetectionCommandInput}
+ * @returns {@link StartDocumentTextDetectionCommandOutput}
  * @see {@link StartDocumentTextDetectionCommandInput} for command's `input` shape.
  * @see {@link StartDocumentTextDetectionCommandOutput} for command's `response` shape.
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -106,11 +113,20 @@ export interface StartDocumentTextDetectionCommandOutput extends StartDocumentTe
 export declare class StartDocumentTextDetectionCommand extends $Command<StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartDocumentTextDetectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartDocumentTextDetectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDocumentTextDetectionCommandInput, StartDocumentTextDetectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartExpenseAnalysisRequest, StartExpenseAnalysisResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link StartExpenseAnalysisCommand}.
  */
 export interface StartExpenseAnalysisCommandInput extends StartExpenseAnalysisRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartExpenseAnalysisCommand}.
  */
 export interface StartExpenseAnalysisCommandOutput extends StartExpenseAnalysisResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts the asynchronous analysis of invoices or receipts for data like contact information,
  *    items purchased, and vendor names.</p>
- *
  *          <p>
  *             <code>StartExpenseAnalysis</code> can analyze text in documents that are in JPEG, PNG, and
  *    PDF format. The documents must be stored in an Amazon S3 bucket. Use the <a>DocumentLocation</a> parameter to specify the name of your S3 bucket and the name of the
@@ -40,6 +44,8 @@ export interface StartExpenseAnalysisCommandOutput extends StartExpenseAnalysisR
  * const response = await client.send(command);
  * ```
  *
+ * @param StartExpenseAnalysisCommandInput - {@link StartExpenseAnalysisCommandInput}
+ * @returns {@link StartExpenseAnalysisCommandOutput}
  * @see {@link StartExpenseAnalysisCommandInput} for command's `input` shape.
  * @see {@link StartExpenseAnalysisCommandOutput} for command's `response` shape.
  * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
@@ -105,11 +111,20 @@ export interface StartExpenseAnalysisCommandOutput extends StartExpenseAnalysisR
 export declare class StartExpenseAnalysisCommand extends $Command<StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartExpenseAnalysisCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartExpenseAnalysisCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartExpenseAnalysisCommandInput, StartExpenseAnalysisCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartLendingAnalysisRequest, StartLendingAnalysisResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
 /**
+ * @public
+ *
  * The input for {@link StartLendingAnalysisCommand}.
  */
 export interface StartLendingAnalysisCommandInput extends StartLendingAnalysisRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartLendingAnalysisCommand}.
  */
 export interface StartLendingAnalysisCommandOutput extends StartLendingAnalysisResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -55,6 +60,8 @@ export interface StartLendingAnalysisCommandOutput extends StartLendingAnalysisR
  * const response = await client.send(command);
  * ```
  *
+ * @param StartLendingAnalysisCommandInput - {@link StartLendingAnalysisCommandInput}
+ * @returns {@link StartLendingAnalysisCommandOutput}
  * @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.
@@ -120,11 +127,20 @@ export interface StartLendingAnalysisCommandOutput extends StartLendingAnalysisR
 export declare class StartLendingAnalysisCommand extends $Command<StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput, TextractClientResolvedConfig> {
     readonly input: StartLendingAnalysisCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartLendingAnalysisCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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;

package/dist-types/models/TextractServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Textract service.
  */
 export declare class TextractServiceException extends __ServiceException {