@aws-sdk/client-textract 3.427.0 → 3.428.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +103 -7
- package/dist-cjs/Textract.js +24 -0
- package/dist-cjs/commands/CreateAdapterCommand.js +51 -0
- package/dist-cjs/commands/CreateAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/DeleteAdapterCommand.js +51 -0
- package/dist-cjs/commands/DeleteAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/GetAdapterCommand.js +51 -0
- package/dist-cjs/commands/GetAdapterVersionCommand.js +51 -0
- package/dist-cjs/commands/ListAdapterVersionsCommand.js +51 -0
- package/dist-cjs/commands/ListAdaptersCommand.js +51 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateAdapterCommand.js +51 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/models_0.js +92 -21
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAdapterVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAdaptersPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_json1_1.js +951 -40
- package/dist-es/Textract.js +24 -0
- package/dist-es/commands/CreateAdapterCommand.js +47 -0
- package/dist-es/commands/CreateAdapterVersionCommand.js +47 -0
- package/dist-es/commands/DeleteAdapterCommand.js +47 -0
- package/dist-es/commands/DeleteAdapterVersionCommand.js +47 -0
- package/dist-es/commands/GetAdapterCommand.js +47 -0
- package/dist-es/commands/GetAdapterVersionCommand.js +47 -0
- package/dist-es/commands/ListAdapterVersionsCommand.js +47 -0
- package/dist-es/commands/ListAdaptersCommand.js +47 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateAdapterCommand.js +47 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +84 -17
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAdapterVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListAdaptersPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +927 -40
- package/dist-types/Textract.d.ts +84 -0
- package/dist-types/TextractClient.d.ts +14 -2
- package/dist-types/commands/AnalyzeDocumentCommand.d.ts +11 -0
- package/dist-types/commands/CreateAdapterCommand.d.ts +128 -0
- package/dist-types/commands/CreateAdapterVersionCommand.d.ts +148 -0
- package/dist-types/commands/DeleteAdapterCommand.d.ts +101 -0
- package/dist-types/commands/DeleteAdapterVersionCommand.d.ts +103 -0
- package/dist-types/commands/GetAdapterCommand.d.ts +111 -0
- package/dist-types/commands/GetAdapterVersionCommand.d.ts +140 -0
- package/dist-types/commands/ListAdapterVersionsCommand.d.ts +116 -0
- package/dist-types/commands/ListAdaptersCommand.d.ts +110 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +102 -0
- package/dist-types/commands/StartDocumentAnalysisCommand.d.ts +11 -0
- package/dist-types/commands/TagResourceCommand.d.ts +104 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +101 -0
- package/dist-types/commands/UpdateAdapterCommand.d.ts +114 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +986 -171
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAdapterVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAdaptersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +108 -0
- package/dist-types/ts3.4/Textract.d.ts +204 -0
- package/dist-types/ts3.4/TextractClient.d.ts +74 -2
- package/dist-types/ts3.4/commands/CreateAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateAdapterVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAdapterVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAdapterCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetAdapterVersionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAdapterVersionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAdaptersCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateAdapterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +237 -40
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAdapterVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAdaptersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +144 -0
- package/package.json +34 -32
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { DeleteAdapterVersionRequest, DeleteAdapterVersionResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteAdapterVersionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteAdapterVersionCommandInput extends DeleteAdapterVersionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteAdapterVersionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteAdapterVersionCommandOutput extends DeleteAdapterVersionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a
|
|
27
|
+
* AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { TextractClient, DeleteAdapterVersionCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
32
|
+
* // const { TextractClient, DeleteAdapterVersionCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
33
|
+
* const client = new TextractClient(config);
|
|
34
|
+
* const input = { // DeleteAdapterVersionRequest
|
|
35
|
+
* AdapterId: "STRING_VALUE", // required
|
|
36
|
+
* AdapterVersion: "STRING_VALUE", // required
|
|
37
|
+
* };
|
|
38
|
+
* const command = new DeleteAdapterVersionCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* @param DeleteAdapterVersionCommandInput - {@link DeleteAdapterVersionCommandInput}
|
|
45
|
+
* @returns {@link DeleteAdapterVersionCommandOutput}
|
|
46
|
+
* @see {@link DeleteAdapterVersionCommandInput} for command's `input` shape.
|
|
47
|
+
* @see {@link DeleteAdapterVersionCommandOutput} for command's `response` shape.
|
|
48
|
+
* @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
51
|
+
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
52
|
+
* of an authorized user or IAM role to perform the operation.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerError} (server fault)
|
|
58
|
+
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
61
|
+
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
62
|
+
* an <code>InvalidParameterException</code> exception occurs
|
|
63
|
+
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
64
|
+
* request parameter.
|
|
65
|
+
* Validate your parameter before calling the API operation again.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
68
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
69
|
+
* contact Amazon Textract.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p> Returned when an operation tried to access a nonexistent resource. </p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
75
|
+
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link TextractServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Textract service.</p>
|
|
82
|
+
*
|
|
83
|
+
*/
|
|
84
|
+
export declare class DeleteAdapterVersionCommand extends $Command<DeleteAdapterVersionCommandInput, DeleteAdapterVersionCommandOutput, TextractClientResolvedConfig> {
|
|
85
|
+
readonly input: DeleteAdapterVersionCommandInput;
|
|
86
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
constructor(input: DeleteAdapterVersionCommandInput);
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAdapterVersionCommandInput, DeleteAdapterVersionCommandOutput>;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
private serialize;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
private deserialize;
|
|
103
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetAdapterRequest, GetAdapterResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAdapterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAdapterCommandInput extends GetAdapterRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAdapterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAdapterCommandOutput extends GetAdapterResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description,
|
|
27
|
+
* CreationTime, AutoUpdate status, and FeatureTypes.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { TextractClient, GetAdapterCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
32
|
+
* // const { TextractClient, GetAdapterCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
33
|
+
* const client = new TextractClient(config);
|
|
34
|
+
* const input = { // GetAdapterRequest
|
|
35
|
+
* AdapterId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetAdapterCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetAdapterResponse
|
|
40
|
+
* // AdapterId: "STRING_VALUE",
|
|
41
|
+
* // AdapterName: "STRING_VALUE",
|
|
42
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
43
|
+
* // Description: "STRING_VALUE",
|
|
44
|
+
* // FeatureTypes: [ // FeatureTypes
|
|
45
|
+
* // "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
|
|
46
|
+
* // ],
|
|
47
|
+
* // AutoUpdate: "ENABLED" || "DISABLED",
|
|
48
|
+
* // Tags: { // TagMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetAdapterCommandInput - {@link GetAdapterCommandInput}
|
|
56
|
+
* @returns {@link GetAdapterCommandOutput}
|
|
57
|
+
* @see {@link GetAdapterCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetAdapterCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
63
|
+
* of an authorized user or IAM role to perform the operation.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
69
|
+
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
70
|
+
* an <code>InvalidParameterException</code> exception occurs
|
|
71
|
+
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
72
|
+
* request parameter.
|
|
73
|
+
* Validate your parameter before calling the API operation again.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
76
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
77
|
+
* contact Amazon Textract.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p> Returned when an operation tried to access a nonexistent resource. </p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
83
|
+
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link TextractServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from Textract service.</p>
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
export declare class GetAdapterCommand extends $Command<GetAdapterCommandInput, GetAdapterCommandOutput, TextractClientResolvedConfig> {
|
|
93
|
+
readonly input: GetAdapterCommandInput;
|
|
94
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
constructor(input: GetAdapterCommandInput);
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAdapterCommandInput, GetAdapterCommandOutput>;
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
private serialize;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private deserialize;
|
|
111
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetAdapterVersionRequest, GetAdapterVersionResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAdapterVersionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAdapterVersionCommandInput extends GetAdapterVersionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAdapterVersionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAdapterVersionCommandOutput extends GetAdapterVersionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets configuration information for the specified adapter version, including:
|
|
27
|
+
* AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig,
|
|
28
|
+
* KMSKeyId, OutputConfig, Tags and EvaluationMetrics.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { TextractClient, GetAdapterVersionCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
33
|
+
* // const { TextractClient, GetAdapterVersionCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
34
|
+
* const client = new TextractClient(config);
|
|
35
|
+
* const input = { // GetAdapterVersionRequest
|
|
36
|
+
* AdapterId: "STRING_VALUE", // required
|
|
37
|
+
* AdapterVersion: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetAdapterVersionCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetAdapterVersionResponse
|
|
42
|
+
* // AdapterId: "STRING_VALUE",
|
|
43
|
+
* // AdapterVersion: "STRING_VALUE",
|
|
44
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
45
|
+
* // FeatureTypes: [ // FeatureTypes
|
|
46
|
+
* // "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
|
|
47
|
+
* // ],
|
|
48
|
+
* // Status: "ACTIVE" || "AT_RISK" || "DEPRECATED" || "CREATION_ERROR" || "CREATION_IN_PROGRESS",
|
|
49
|
+
* // StatusMessage: "STRING_VALUE",
|
|
50
|
+
* // DatasetConfig: { // AdapterVersionDatasetConfig
|
|
51
|
+
* // ManifestS3Object: { // S3Object
|
|
52
|
+
* // Bucket: "STRING_VALUE",
|
|
53
|
+
* // Name: "STRING_VALUE",
|
|
54
|
+
* // Version: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // KMSKeyId: "STRING_VALUE",
|
|
58
|
+
* // OutputConfig: { // OutputConfig
|
|
59
|
+
* // S3Bucket: "STRING_VALUE", // required
|
|
60
|
+
* // S3Prefix: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // EvaluationMetrics: [ // AdapterVersionEvaluationMetrics
|
|
63
|
+
* // { // AdapterVersionEvaluationMetric
|
|
64
|
+
* // Baseline: { // EvaluationMetric
|
|
65
|
+
* // F1Score: Number("float"),
|
|
66
|
+
* // Precision: Number("float"),
|
|
67
|
+
* // Recall: Number("float"),
|
|
68
|
+
* // },
|
|
69
|
+
* // AdapterVersion: {
|
|
70
|
+
* // F1Score: Number("float"),
|
|
71
|
+
* // Precision: Number("float"),
|
|
72
|
+
* // Recall: Number("float"),
|
|
73
|
+
* // },
|
|
74
|
+
* // FeatureType: "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // Tags: { // TagMap
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param GetAdapterVersionCommandInput - {@link GetAdapterVersionCommandInput}
|
|
85
|
+
* @returns {@link GetAdapterVersionCommandOutput}
|
|
86
|
+
* @see {@link GetAdapterVersionCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link GetAdapterVersionCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
+
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
92
|
+
* of an authorized user or IAM role to perform the operation.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link InternalServerError} (server fault)
|
|
95
|
+
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
98
|
+
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
99
|
+
* an <code>InvalidParameterException</code> exception occurs
|
|
100
|
+
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
101
|
+
* request parameter.
|
|
102
|
+
* Validate your parameter before calling the API operation again.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
105
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
106
|
+
* contact Amazon Textract.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
109
|
+
* <p> Returned when an operation tried to access a nonexistent resource. </p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
112
|
+
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ValidationException} (client fault)
|
|
115
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link TextractServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from Textract service.</p>
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export declare class GetAdapterVersionCommand extends $Command<GetAdapterVersionCommandInput, GetAdapterVersionCommandOutput, TextractClientResolvedConfig> {
|
|
122
|
+
readonly input: GetAdapterVersionCommandInput;
|
|
123
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
constructor(input: GetAdapterVersionCommandInput);
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAdapterVersionCommandInput, GetAdapterVersionCommandOutput>;
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
private serialize;
|
|
136
|
+
/**
|
|
137
|
+
* @internal
|
|
138
|
+
*/
|
|
139
|
+
private deserialize;
|
|
140
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ListAdapterVersionsRequest, ListAdapterVersionsResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAdapterVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAdapterVersionsCommandInput extends ListAdapterVersionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAdapterVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAdapterVersionsCommandOutput extends ListAdapterVersionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>List all version of an adapter that meet the specified filtration criteria.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { TextractClient, ListAdapterVersionsCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
31
|
+
* // const { TextractClient, ListAdapterVersionsCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
32
|
+
* const client = new TextractClient(config);
|
|
33
|
+
* const input = { // ListAdapterVersionsRequest
|
|
34
|
+
* AdapterId: "STRING_VALUE",
|
|
35
|
+
* AfterCreationTime: new Date("TIMESTAMP"),
|
|
36
|
+
* BeforeCreationTime: new Date("TIMESTAMP"),
|
|
37
|
+
* MaxResults: Number("int"),
|
|
38
|
+
* NextToken: "STRING_VALUE",
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListAdapterVersionsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListAdapterVersionsResponse
|
|
43
|
+
* // AdapterVersions: [ // AdapterVersionList
|
|
44
|
+
* // { // AdapterVersionOverview
|
|
45
|
+
* // AdapterId: "STRING_VALUE",
|
|
46
|
+
* // AdapterVersion: "STRING_VALUE",
|
|
47
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
48
|
+
* // FeatureTypes: [ // FeatureTypes
|
|
49
|
+
* // "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
|
|
50
|
+
* // ],
|
|
51
|
+
* // Status: "ACTIVE" || "AT_RISK" || "DEPRECATED" || "CREATION_ERROR" || "CREATION_IN_PROGRESS",
|
|
52
|
+
* // StatusMessage: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListAdapterVersionsCommandInput - {@link ListAdapterVersionsCommandInput}
|
|
61
|
+
* @returns {@link ListAdapterVersionsCommandOutput}
|
|
62
|
+
* @see {@link ListAdapterVersionsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListAdapterVersionsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
68
|
+
* of an authorized user or IAM role to perform the operation.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerError} (server fault)
|
|
71
|
+
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
+
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
75
|
+
* an <code>InvalidParameterException</code> exception occurs
|
|
76
|
+
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
77
|
+
* request parameter.
|
|
78
|
+
* Validate your parameter before calling the API operation again.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
81
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
82
|
+
* contact Amazon Textract.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p> Returned when an operation tried to access a nonexistent resource. </p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
88
|
+
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link TextractServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from Textract service.</p>
|
|
95
|
+
*
|
|
96
|
+
*/
|
|
97
|
+
export declare class ListAdapterVersionsCommand extends $Command<ListAdapterVersionsCommandInput, ListAdapterVersionsCommandOutput, TextractClientResolvedConfig> {
|
|
98
|
+
readonly input: ListAdapterVersionsCommandInput;
|
|
99
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
constructor(input: ListAdapterVersionsCommandInput);
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAdapterVersionsCommandInput, ListAdapterVersionsCommandOutput>;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private serialize;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
private deserialize;
|
|
116
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ListAdaptersRequest, ListAdaptersResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TextractClientResolvedConfig } from "../TextractClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAdaptersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAdaptersCommandInput extends ListAdaptersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAdaptersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAdaptersCommandOutput extends ListAdaptersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists all adapters that match the specified filtration criteria.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { TextractClient, ListAdaptersCommand } from "@aws-sdk/client-textract"; // ES Modules import
|
|
31
|
+
* // const { TextractClient, ListAdaptersCommand } = require("@aws-sdk/client-textract"); // CommonJS import
|
|
32
|
+
* const client = new TextractClient(config);
|
|
33
|
+
* const input = { // ListAdaptersRequest
|
|
34
|
+
* AfterCreationTime: new Date("TIMESTAMP"),
|
|
35
|
+
* BeforeCreationTime: new Date("TIMESTAMP"),
|
|
36
|
+
* MaxResults: Number("int"),
|
|
37
|
+
* NextToken: "STRING_VALUE",
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListAdaptersCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListAdaptersResponse
|
|
42
|
+
* // Adapters: [ // AdapterList
|
|
43
|
+
* // { // AdapterOverview
|
|
44
|
+
* // AdapterId: "STRING_VALUE",
|
|
45
|
+
* // AdapterName: "STRING_VALUE",
|
|
46
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // FeatureTypes: [ // FeatureTypes
|
|
48
|
+
* // "TABLES" || "FORMS" || "QUERIES" || "SIGNATURES" || "LAYOUT",
|
|
49
|
+
* // ],
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // NextToken: "STRING_VALUE",
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param ListAdaptersCommandInput - {@link ListAdaptersCommandInput}
|
|
58
|
+
* @returns {@link ListAdaptersCommandOutput}
|
|
59
|
+
* @see {@link ListAdaptersCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link ListAdaptersCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link TextractClientResolvedConfig | config} for TextractClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
|
|
65
|
+
* of an authorized user or IAM role to perform the operation.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerError} (server fault)
|
|
68
|
+
* <p>Amazon Textract experienced a service issue. Try your call again.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
71
|
+
* <p>An input parameter violated a constraint. For example, in synchronous operations,
|
|
72
|
+
* an <code>InvalidParameterException</code> exception occurs
|
|
73
|
+
* when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
|
|
74
|
+
* request parameter.
|
|
75
|
+
* Validate your parameter before calling the API operation again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
78
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
|
|
79
|
+
* contact Amazon Textract.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
82
|
+
* <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p> Indicates that a request was not valid. Check request for proper formatting. </p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link TextractServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from Textract service.</p>
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
export declare class ListAdaptersCommand extends $Command<ListAdaptersCommandInput, ListAdaptersCommandOutput, TextractClientResolvedConfig> {
|
|
92
|
+
readonly input: ListAdaptersCommandInput;
|
|
93
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
constructor(input: ListAdaptersCommandInput);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TextractClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAdaptersCommandInput, ListAdaptersCommandOutput>;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private serialize;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private deserialize;
|
|
110
|
+
}
|