@aws-sdk/client-textract 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ 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>
  *
@@ -42,6 +47,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 +114,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,16 +4,21 @@ 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>
  *
@@ -40,6 +45,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 +112,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/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 {