@aws-sdk/client-textract 3.427.0 → 3.428.0

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

@@ -0,0 +1,102 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListTagsForResourceCommand}.
+ */
+export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListTagsForResourceCommand}.
+ */
+export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists all tags for an Amazon Textract resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, ListTagsForResourceCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, ListTagsForResourceCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const input = { // ListTagsForResourceRequest
+ *   ResourceARN: "STRING_VALUE", // required
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * // { // ListTagsForResourceResponse
+ * //   Tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
+ *             of an authorized user or IAM role to perform the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Textract experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An input parameter violated a constraint. For example, in synchronous operations,
+ *        an <code>InvalidParameterException</code> exception occurs
+ *       when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
+ *       request parameter.
+ *        Validate your parameter before calling the API operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
+ *          contact Amazon Textract.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> Returned when an operation tried to access a nonexistent resource. </p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>  Indicates that a request was not valid. Check request for proper formatting. </p>
+ *
+ * @throws {@link TextractServiceException}
+ * <p>Base exception class for all service exceptions from Textract service.</p>
+ *
+ */
+export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TextractClientResolvedConfig> {
+    readonly input: ListTagsForResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListTagsForResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -79,6 +79,17 @@ export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysi
  *       },
  *     ],
  *   },
+ *   AdaptersConfig: { // AdaptersConfig
+ *     Adapters: [ // Adapters // required
+ *       { // Adapter
+ *         AdapterId: "STRING_VALUE", // required
+ *         Pages: [ // AdapterPages
+ *           "STRING_VALUE",
+ *         ],
+ *         Version: "STRING_VALUE", // required
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new StartDocumentAnalysisCommand(input);
  * const response = await client.send(command);

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

@@ -0,0 +1,104 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Adds one or more tags to the specified resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, TagResourceCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, TagResourceCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const input = { // TagResourceRequest
+ *   ResourceARN: "STRING_VALUE", // required
+ *   Tags: { // TagMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
+ *             of an authorized user or IAM role to perform the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Textract experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An input parameter violated a constraint. For example, in synchronous operations,
+ *        an <code>InvalidParameterException</code> exception occurs
+ *       when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
+ *       request parameter.
+ *        Validate your parameter before calling the API operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
+ *          contact Amazon Textract.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> Returned when an operation tried to access a nonexistent resource. </p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Returned when a request cannot be completed as it would exceed a maximum service quota.</p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>  Indicates that a request was not valid. Check request for proper formatting. </p>
+ *
+ * @throws {@link TextractServiceException}
+ * <p>Base exception class for all service exceptions from Textract service.</p>
+ *
+ */
+export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TextractClientResolvedConfig> {
+    readonly input: TagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: TagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,101 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Removes any tags with the specified keys from the specified resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, UntagResourceCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, UntagResourceCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const input = { // UntagResourceRequest
+ *   ResourceARN: "STRING_VALUE", // required
+ *   TagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
+ *             of an authorized user or IAM role to perform the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Textract experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An input parameter violated a constraint. For example, in synchronous operations,
+ *        an <code>InvalidParameterException</code> exception occurs
+ *       when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
+ *       request parameter.
+ *        Validate your parameter before calling the API operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
+ *          contact Amazon Textract.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> Returned when an operation tried to access a nonexistent resource. </p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>  Indicates that a request was not valid. Check request for proper formatting. </p>
+ *
+ * @throws {@link TextractServiceException}
+ * <p>Base exception class for all service exceptions from Textract service.</p>
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TextractClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,114 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateAdapterRequest, UpdateAdapterResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAdapterCommand}.
+ */
+export interface UpdateAdapterCommandInput extends UpdateAdapterRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAdapterCommand}.
+ */
+export interface UpdateAdapterCommandOutput extends UpdateAdapterResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Update the configuration for an adapter. FeatureTypes configurations cannot be updated.
+ *          At least one new parameter must be specified as an argument.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TextractClient, UpdateAdapterCommand } from "@aws-sdk/client-textract"; // ES Modules import
+ * // const { TextractClient, UpdateAdapterCommand } = require("@aws-sdk/client-textract"); // CommonJS import
+ * const client = new TextractClient(config);
+ * const input = { // UpdateAdapterRequest
+ *   AdapterId: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   AdapterName: "STRING_VALUE",
+ *   AutoUpdate: "ENABLED" || "DISABLED",
+ * };
+ * const command = new UpdateAdapterCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAdapterResponse
+ * //   AdapterId: "STRING_VALUE",
+ * //   AdapterName: "STRING_VALUE",
+ * //   CreationTime: new Date("TIMESTAMP"),
+ * //   Description: "STRING_VALUE",
+ * //   FeatureTypes: [ // FeatureTypes
+ * //     "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
+ * //   ],
+ * //   AutoUpdate: "ENABLED" || "DISABLED",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateAdapterCommandInput - {@link UpdateAdapterCommandInput}
+ * @returns {@link UpdateAdapterCommandOutput}
+ * @see {@link UpdateAdapterCommandInput} for command's `input` shape.
+ * @see {@link UpdateAdapterCommandOutput} for command's `response` shape.
+ * @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
+ *             of an authorized user or IAM role to perform the operation.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Textract experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An input parameter violated a constraint. For example, in synchronous operations,
+ *        an <code>InvalidParameterException</code> exception occurs
+ *       when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
+ *       request parameter.
+ *        Validate your parameter before calling the API operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
+ *          contact Amazon Textract.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> Returned when an operation tried to access a nonexistent resource. </p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>  Indicates that a request was not valid. Check request for proper formatting. </p>
+ *
+ * @throws {@link TextractServiceException}
+ * <p>Base exception class for all service exceptions from Textract service.</p>
+ *
+ */
+export declare class UpdateAdapterCommand extends $Command<UpdateAdapterCommandInput, UpdateAdapterCommandOutput, TextractClientResolvedConfig> {
+    readonly input: UpdateAdapterCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateAdapterCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAdapterCommandInput, UpdateAdapterCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,13 +1,25 @@
 export * from "./AnalyzeDocumentCommand";
 export * from "./AnalyzeExpenseCommand";
 export * from "./AnalyzeIDCommand";
+export * from "./CreateAdapterCommand";
+export * from "./CreateAdapterVersionCommand";
+export * from "./DeleteAdapterCommand";
+export * from "./DeleteAdapterVersionCommand";
 export * from "./DetectDocumentTextCommand";
+export * from "./GetAdapterCommand";
+export * from "./GetAdapterVersionCommand";
 export * from "./GetDocumentAnalysisCommand";
 export * from "./GetDocumentTextDetectionCommand";
 export * from "./GetExpenseAnalysisCommand";
 export * from "./GetLendingAnalysisCommand";
 export * from "./GetLendingAnalysisSummaryCommand";
+export * from "./ListAdapterVersionsCommand";
+export * from "./ListAdaptersCommand";
+export * from "./ListTagsForResourceCommand";
 export * from "./StartDocumentAnalysisCommand";
 export * from "./StartDocumentTextDetectionCommand";
 export * from "./StartExpenseAnalysisCommand";
 export * from "./StartLendingAnalysisCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateAdapterCommand";

package/dist-types/index.d.ts

@@ -9,5 +9,6 @@ export * from "./TextractClient";
 export * from "./Textract";
 export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
+export * from "./pagination";
 export * from "./models";
 export { TextractServiceException } from "./models/TextractServiceException";