aws-sdk-textract 1.21.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +138 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-textract.rb +2 -2
- data/lib/aws-sdk-textract/client.rb +140 -2
- data/lib/aws-sdk-textract/client_api.rb +84 -1
- data/lib/aws-sdk-textract/errors.rb +12 -1
- data/lib/aws-sdk-textract/resource.rb +1 -1
- data/lib/aws-sdk-textract/types.rb +272 -5
- metadata +11 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4407b51ac41473054e7a4ecf865a72886d9564aef97c1525f8ac29b3c878afd3
|
4
|
+
data.tar.gz: 0ab236473f861694b100af2c06a4e40bcb29557d33ce0f7c307b3bc7cdc23a0d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1100d59f3f1f051e175289087cd599562850d2524bb51ed46e96a1b46e31d5d5a2bb78d15e1f54a754998f2c5db52dede16297296d1c82420abbe43c92180db1
|
7
|
+
data.tar.gz: f2a03d26c08509cf5ef86858ef1922620be657be09cc46d8e863fc6c8a23ff61f6cf71c0d031d198b2529796b8cf2f97dc7e9bbc3a2249aead5a5ec2ba13a7ed
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,138 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.25.0 (2021-07-26)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds support for AnalyzeExpense, a new API to extract relevant data such as contact information, items purchased, and vendor name, from almost any invoice or receipt without the need for any templates or configuration.
|
8
|
+
|
9
|
+
1.24.0 (2021-03-10)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.23.0 (2021-02-02)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.22.0 (2020-11-13)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS Textract now allows customers to specify their own KMS key to be used for asynchronous jobs output results, AWS Textract now also recognizes handwritten text from English documents.
|
23
|
+
|
24
|
+
1.21.0 (2020-09-30)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.20.0 (2020-09-24)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - AWS Textract now supports output results for asynchronous jobs to customer specified s3 bucket.
|
33
|
+
|
34
|
+
1.19.0 (2020-09-15)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.18.0 (2020-08-25)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.17.0 (2020-06-23)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
48
|
+
|
49
|
+
1.16.1 (2020-06-11)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
53
|
+
|
54
|
+
1.16.0 (2020-06-10)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Issue - This version has been yanked. (#2327).
|
58
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
59
|
+
|
60
|
+
1.15.0 (2020-05-28)
|
61
|
+
------------------
|
62
|
+
|
63
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
64
|
+
|
65
|
+
1.14.0 (2020-05-07)
|
66
|
+
------------------
|
67
|
+
|
68
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
69
|
+
|
70
|
+
1.13.0 (2020-03-09)
|
71
|
+
------------------
|
72
|
+
|
73
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
74
|
+
|
75
|
+
1.12.0 (2019-12-03)
|
76
|
+
------------------
|
77
|
+
|
78
|
+
* Feature - This SDK Release introduces Amazon Augmented AI support for Amazon Textract AnalyzeDocument API. Image byte payloads for synchronous operations have increased from 5 MB to 10 MB.
|
79
|
+
|
80
|
+
1.11.0 (2019-10-23)
|
81
|
+
------------------
|
82
|
+
|
83
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
84
|
+
|
85
|
+
1.10.0 (2019-07-25)
|
86
|
+
------------------
|
87
|
+
|
88
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
89
|
+
|
90
|
+
1.9.0 (2019-07-01)
|
91
|
+
------------------
|
92
|
+
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
94
|
+
|
95
|
+
1.8.0 (2019-06-17)
|
96
|
+
------------------
|
97
|
+
|
98
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
99
|
+
|
100
|
+
1.7.0 (2019-05-21)
|
101
|
+
------------------
|
102
|
+
|
103
|
+
* Feature - API update.
|
104
|
+
|
105
|
+
1.6.0 (2019-05-15)
|
106
|
+
------------------
|
107
|
+
|
108
|
+
* Feature - API update.
|
109
|
+
|
110
|
+
1.5.0 (2019-05-14)
|
111
|
+
------------------
|
112
|
+
|
113
|
+
* Feature - API update.
|
114
|
+
|
115
|
+
1.4.0 (2019-04-24)
|
116
|
+
------------------
|
117
|
+
|
118
|
+
* Feature - API update.
|
119
|
+
|
120
|
+
1.3.0 (2019-03-21)
|
121
|
+
------------------
|
122
|
+
|
123
|
+
* Feature - API update.
|
124
|
+
|
125
|
+
1.2.0 (2019-03-18)
|
126
|
+
------------------
|
127
|
+
|
128
|
+
* Feature - API update.
|
129
|
+
|
130
|
+
1.1.0 (2019-03-14)
|
131
|
+
------------------
|
132
|
+
|
133
|
+
* Feature - API update.
|
134
|
+
|
135
|
+
1.0.0 (2019-03-05)
|
136
|
+
------------------
|
137
|
+
|
138
|
+
* Feature - Initial release of `aws-sdk-textract`.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.25.0
|
data/lib/aws-sdk-textract.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-textract/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::Textract
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.25.0'
|
52
52
|
|
53
53
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -431,6 +431,7 @@ module Aws::Textract
|
|
431
431
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
432
432
|
# resp.blocks[0].confidence #=> Float
|
433
433
|
# resp.blocks[0].text #=> String
|
434
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
434
435
|
# resp.blocks[0].row_index #=> Integer
|
435
436
|
# resp.blocks[0].column_index #=> Integer
|
436
437
|
# resp.blocks[0].row_span #=> Integer
|
@@ -466,6 +467,124 @@ module Aws::Textract
|
|
466
467
|
req.send_request(options)
|
467
468
|
end
|
468
469
|
|
470
|
+
# Analyzes an input document for financially related relationships
|
471
|
+
# between text.
|
472
|
+
#
|
473
|
+
# Information is returned as `ExpenseDocuments` and seperated as
|
474
|
+
# follows.
|
475
|
+
#
|
476
|
+
# * `LineItemGroups`- A data set containing `LineItems` which store
|
477
|
+
# information about the lines of text, such as an item purchased and
|
478
|
+
# its price on a receipt.
|
479
|
+
#
|
480
|
+
# * `SummaryFields`- Contains all other information a receipt, such as
|
481
|
+
# header information or the vendors name.
|
482
|
+
#
|
483
|
+
# @option params [required, Types::Document] :document
|
484
|
+
# The input document, either as bytes or as an S3 object.
|
485
|
+
#
|
486
|
+
# You pass image bytes to an Amazon Textract API operation by using the
|
487
|
+
# `Bytes` property. For example, you would use the `Bytes` property to
|
488
|
+
# pass a document loaded from a local file system. Image bytes passed by
|
489
|
+
# using the `Bytes` property must be base64 encoded. Your code might not
|
490
|
+
# need to encode document file bytes if you're using an AWS SDK to call
|
491
|
+
# Amazon Textract API operations.
|
492
|
+
#
|
493
|
+
# You pass images stored in an S3 bucket to an Amazon Textract API
|
494
|
+
# operation by using the `S3Object` property. Documents stored in an S3
|
495
|
+
# bucket don't need to be base64 encoded.
|
496
|
+
#
|
497
|
+
# The AWS Region for the S3 bucket that contains the S3 object must
|
498
|
+
# match the AWS Region that you use for Amazon Textract operations.
|
499
|
+
#
|
500
|
+
# If you use the AWS CLI to call Amazon Textract operations, passing
|
501
|
+
# image bytes using the Bytes property isn't supported. You must first
|
502
|
+
# upload the document to an Amazon S3 bucket, and then call the
|
503
|
+
# operation using the S3Object property.
|
504
|
+
#
|
505
|
+
# For Amazon Textract to process an S3 object, the user must have
|
506
|
+
# permission to access the S3 object.
|
507
|
+
#
|
508
|
+
# @return [Types::AnalyzeExpenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
509
|
+
#
|
510
|
+
# * {Types::AnalyzeExpenseResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
511
|
+
# * {Types::AnalyzeExpenseResponse#expense_documents #expense_documents} => Array<Types::ExpenseDocument>
|
512
|
+
#
|
513
|
+
# @example Request syntax with placeholder values
|
514
|
+
#
|
515
|
+
# resp = client.analyze_expense({
|
516
|
+
# document: { # required
|
517
|
+
# bytes: "data",
|
518
|
+
# s3_object: {
|
519
|
+
# bucket: "S3Bucket",
|
520
|
+
# name: "S3ObjectName",
|
521
|
+
# version: "S3ObjectVersion",
|
522
|
+
# },
|
523
|
+
# },
|
524
|
+
# })
|
525
|
+
#
|
526
|
+
# @example Response structure
|
527
|
+
#
|
528
|
+
# resp.document_metadata.pages #=> Integer
|
529
|
+
# resp.expense_documents #=> Array
|
530
|
+
# resp.expense_documents[0].expense_index #=> Integer
|
531
|
+
# resp.expense_documents[0].summary_fields #=> Array
|
532
|
+
# resp.expense_documents[0].summary_fields[0].type.text #=> String
|
533
|
+
# resp.expense_documents[0].summary_fields[0].type.confidence #=> Float
|
534
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.text #=> String
|
535
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.bounding_box.width #=> Float
|
536
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.bounding_box.height #=> Float
|
537
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.bounding_box.left #=> Float
|
538
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.bounding_box.top #=> Float
|
539
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.polygon #=> Array
|
540
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.polygon[0].x #=> Float
|
541
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.geometry.polygon[0].y #=> Float
|
542
|
+
# resp.expense_documents[0].summary_fields[0].label_detection.confidence #=> Float
|
543
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.text #=> String
|
544
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.bounding_box.width #=> Float
|
545
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.bounding_box.height #=> Float
|
546
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.bounding_box.left #=> Float
|
547
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.bounding_box.top #=> Float
|
548
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.polygon #=> Array
|
549
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.polygon[0].x #=> Float
|
550
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.geometry.polygon[0].y #=> Float
|
551
|
+
# resp.expense_documents[0].summary_fields[0].value_detection.confidence #=> Float
|
552
|
+
# resp.expense_documents[0].summary_fields[0].page_number #=> Integer
|
553
|
+
# resp.expense_documents[0].line_item_groups #=> Array
|
554
|
+
# resp.expense_documents[0].line_item_groups[0].line_item_group_index #=> Integer
|
555
|
+
# resp.expense_documents[0].line_item_groups[0].line_items #=> Array
|
556
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields #=> Array
|
557
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].type.text #=> String
|
558
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].type.confidence #=> Float
|
559
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.text #=> String
|
560
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.width #=> Float
|
561
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.height #=> Float
|
562
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.left #=> Float
|
563
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.bounding_box.top #=> Float
|
564
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon #=> Array
|
565
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon[0].x #=> Float
|
566
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.geometry.polygon[0].y #=> Float
|
567
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].label_detection.confidence #=> Float
|
568
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.text #=> String
|
569
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.width #=> Float
|
570
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.height #=> Float
|
571
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.left #=> Float
|
572
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.bounding_box.top #=> Float
|
573
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon #=> Array
|
574
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon[0].x #=> Float
|
575
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.geometry.polygon[0].y #=> Float
|
576
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].value_detection.confidence #=> Float
|
577
|
+
# resp.expense_documents[0].line_item_groups[0].line_items[0].line_item_expense_fields[0].page_number #=> Integer
|
578
|
+
#
|
579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeExpense AWS API Documentation
|
580
|
+
#
|
581
|
+
# @overload analyze_expense(params = {})
|
582
|
+
# @param [Hash] params ({})
|
583
|
+
def analyze_expense(params = {}, options = {})
|
584
|
+
req = build_request(:analyze_expense, params)
|
585
|
+
req.send_request(options)
|
586
|
+
end
|
587
|
+
|
469
588
|
# Detects text in the input document. Amazon Textract can detect lines
|
470
589
|
# of text and the words that make up a line of text. The input document
|
471
590
|
# must be an image in JPEG or PNG format. `DetectDocumentText` returns
|
@@ -521,6 +640,7 @@ module Aws::Textract
|
|
521
640
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
522
641
|
# resp.blocks[0].confidence #=> Float
|
523
642
|
# resp.blocks[0].text #=> String
|
643
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
524
644
|
# resp.blocks[0].row_index #=> Integer
|
525
645
|
# resp.blocks[0].column_index #=> Integer
|
526
646
|
# resp.blocks[0].row_span #=> Integer
|
@@ -647,6 +767,7 @@ module Aws::Textract
|
|
647
767
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
648
768
|
# resp.blocks[0].confidence #=> Float
|
649
769
|
# resp.blocks[0].text #=> String
|
770
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
650
771
|
# resp.blocks[0].row_index #=> Integer
|
651
772
|
# resp.blocks[0].column_index #=> Integer
|
652
773
|
# resp.blocks[0].row_span #=> Integer
|
@@ -764,6 +885,7 @@ module Aws::Textract
|
|
764
885
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
765
886
|
# resp.blocks[0].confidence #=> Float
|
766
887
|
# resp.blocks[0].text #=> String
|
888
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
767
889
|
# resp.blocks[0].row_index #=> Integer
|
768
890
|
# resp.blocks[0].column_index #=> Integer
|
769
891
|
# resp.blocks[0].row_span #=> Integer
|
@@ -862,6 +984,13 @@ module Aws::Textract
|
|
862
984
|
# Amazon Textract will save the results internally to be accessed by the
|
863
985
|
# GetDocumentAnalysis operation.
|
864
986
|
#
|
987
|
+
# @option params [String] :kms_key_id
|
988
|
+
# The KMS key used to encrypt the inference results. This can be in
|
989
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the KMS
|
990
|
+
# key will be used for server-side encryption of the objects in the
|
991
|
+
# customer bucket. When this parameter is not enabled, the result will
|
992
|
+
# be encrypted server side,using SSE-S3.
|
993
|
+
#
|
865
994
|
# @return [Types::StartDocumentAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
866
995
|
#
|
867
996
|
# * {Types::StartDocumentAnalysisResponse#job_id #job_id} => String
|
@@ -887,6 +1016,7 @@ module Aws::Textract
|
|
887
1016
|
# s3_bucket: "S3Bucket", # required
|
888
1017
|
# s3_prefix: "S3ObjectName",
|
889
1018
|
# },
|
1019
|
+
# kms_key_id: "KMSKeyId",
|
890
1020
|
# })
|
891
1021
|
#
|
892
1022
|
# @example Response structure
|
@@ -957,6 +1087,13 @@ module Aws::Textract
|
|
957
1087
|
# Amazon Textract will save the results internally to be accessed with
|
958
1088
|
# the GetDocumentTextDetection operation.
|
959
1089
|
#
|
1090
|
+
# @option params [String] :kms_key_id
|
1091
|
+
# The KMS key used to encrypt the inference results. This can be in
|
1092
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the KMS
|
1093
|
+
# key will be used for server-side encryption of the objects in the
|
1094
|
+
# customer bucket. When this parameter is not enabled, the result will
|
1095
|
+
# be encrypted server side,using SSE-S3.
|
1096
|
+
#
|
960
1097
|
# @return [Types::StartDocumentTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
961
1098
|
#
|
962
1099
|
# * {Types::StartDocumentTextDetectionResponse#job_id #job_id} => String
|
@@ -981,6 +1118,7 @@ module Aws::Textract
|
|
981
1118
|
# s3_bucket: "S3Bucket", # required
|
982
1119
|
# s3_prefix: "S3ObjectName",
|
983
1120
|
# },
|
1121
|
+
# kms_key_id: "KMSKeyId",
|
984
1122
|
# })
|
985
1123
|
#
|
986
1124
|
# @example Response structure
|
@@ -1009,7 +1147,7 @@ module Aws::Textract
|
|
1009
1147
|
params: params,
|
1010
1148
|
config: config)
|
1011
1149
|
context[:gem_name] = 'aws-sdk-textract'
|
1012
|
-
context[:gem_version] = '1.
|
1150
|
+
context[:gem_version] = '1.25.0'
|
1013
1151
|
Seahorse::Client::Request.new(handlers, context)
|
1014
1152
|
end
|
1015
1153
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -16,6 +16,8 @@ module Aws::Textract
|
|
16
16
|
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
17
17
|
AnalyzeDocumentRequest = Shapes::StructureShape.new(name: 'AnalyzeDocumentRequest')
|
18
18
|
AnalyzeDocumentResponse = Shapes::StructureShape.new(name: 'AnalyzeDocumentResponse')
|
19
|
+
AnalyzeExpenseRequest = Shapes::StructureShape.new(name: 'AnalyzeExpenseRequest')
|
20
|
+
AnalyzeExpenseResponse = Shapes::StructureShape.new(name: 'AnalyzeExpenseResponse')
|
19
21
|
BadDocumentException = Shapes::StructureShape.new(name: 'BadDocumentException')
|
20
22
|
Block = Shapes::StructureShape.new(name: 'Block')
|
21
23
|
BlockList = Shapes::ListShape.new(name: 'BlockList')
|
@@ -33,6 +35,12 @@ module Aws::Textract
|
|
33
35
|
EntityType = Shapes::StringShape.new(name: 'EntityType')
|
34
36
|
EntityTypes = Shapes::ListShape.new(name: 'EntityTypes')
|
35
37
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
38
|
+
ExpenseDetection = Shapes::StructureShape.new(name: 'ExpenseDetection')
|
39
|
+
ExpenseDocument = Shapes::StructureShape.new(name: 'ExpenseDocument')
|
40
|
+
ExpenseDocumentList = Shapes::ListShape.new(name: 'ExpenseDocumentList')
|
41
|
+
ExpenseField = Shapes::StructureShape.new(name: 'ExpenseField')
|
42
|
+
ExpenseFieldList = Shapes::ListShape.new(name: 'ExpenseFieldList')
|
43
|
+
ExpenseType = Shapes::StructureShape.new(name: 'ExpenseType')
|
36
44
|
FeatureType = Shapes::StringShape.new(name: 'FeatureType')
|
37
45
|
FeatureTypes = Shapes::ListShape.new(name: 'FeatureTypes')
|
38
46
|
Float = Shapes::FloatShape.new(name: 'Float')
|
@@ -56,12 +64,18 @@ module Aws::Textract
|
|
56
64
|
ImageBlob = Shapes::BlobShape.new(name: 'ImageBlob')
|
57
65
|
InternalServerError = Shapes::StructureShape.new(name: 'InternalServerError')
|
58
66
|
InvalidJobIdException = Shapes::StructureShape.new(name: 'InvalidJobIdException')
|
67
|
+
InvalidKMSKeyException = Shapes::StructureShape.new(name: 'InvalidKMSKeyException')
|
59
68
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
60
69
|
InvalidS3ObjectException = Shapes::StructureShape.new(name: 'InvalidS3ObjectException')
|
61
70
|
JobId = Shapes::StringShape.new(name: 'JobId')
|
62
71
|
JobStatus = Shapes::StringShape.new(name: 'JobStatus')
|
63
72
|
JobTag = Shapes::StringShape.new(name: 'JobTag')
|
73
|
+
KMSKeyId = Shapes::StringShape.new(name: 'KMSKeyId')
|
64
74
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
75
|
+
LineItemFields = Shapes::StructureShape.new(name: 'LineItemFields')
|
76
|
+
LineItemGroup = Shapes::StructureShape.new(name: 'LineItemGroup')
|
77
|
+
LineItemGroupList = Shapes::ListShape.new(name: 'LineItemGroupList')
|
78
|
+
LineItemList = Shapes::ListShape.new(name: 'LineItemList')
|
65
79
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
66
80
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
67
81
|
NotificationChannel = Shapes::StructureShape.new(name: 'NotificationChannel')
|
@@ -88,6 +102,7 @@ module Aws::Textract
|
|
88
102
|
StartDocumentTextDetectionResponse = Shapes::StructureShape.new(name: 'StartDocumentTextDetectionResponse')
|
89
103
|
StatusMessage = Shapes::StringShape.new(name: 'StatusMessage')
|
90
104
|
String = Shapes::StringShape.new(name: 'String')
|
105
|
+
TextType = Shapes::StringShape.new(name: 'TextType')
|
91
106
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
92
107
|
UInteger = Shapes::IntegerShape.new(name: 'UInteger')
|
93
108
|
UnsupportedDocumentException = Shapes::StructureShape.new(name: 'UnsupportedDocumentException')
|
@@ -107,11 +122,19 @@ module Aws::Textract
|
|
107
122
|
AnalyzeDocumentResponse.add_member(:analyze_document_model_version, Shapes::ShapeRef.new(shape: String, location_name: "AnalyzeDocumentModelVersion"))
|
108
123
|
AnalyzeDocumentResponse.struct_class = Types::AnalyzeDocumentResponse
|
109
124
|
|
125
|
+
AnalyzeExpenseRequest.add_member(:document, Shapes::ShapeRef.new(shape: Document, required: true, location_name: "Document"))
|
126
|
+
AnalyzeExpenseRequest.struct_class = Types::AnalyzeExpenseRequest
|
127
|
+
|
128
|
+
AnalyzeExpenseResponse.add_member(:document_metadata, Shapes::ShapeRef.new(shape: DocumentMetadata, location_name: "DocumentMetadata"))
|
129
|
+
AnalyzeExpenseResponse.add_member(:expense_documents, Shapes::ShapeRef.new(shape: ExpenseDocumentList, location_name: "ExpenseDocuments"))
|
130
|
+
AnalyzeExpenseResponse.struct_class = Types::AnalyzeExpenseResponse
|
131
|
+
|
110
132
|
BadDocumentException.struct_class = Types::BadDocumentException
|
111
133
|
|
112
134
|
Block.add_member(:block_type, Shapes::ShapeRef.new(shape: BlockType, location_name: "BlockType"))
|
113
135
|
Block.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
|
114
136
|
Block.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
|
137
|
+
Block.add_member(:text_type, Shapes::ShapeRef.new(shape: TextType, location_name: "TextType"))
|
115
138
|
Block.add_member(:row_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "RowIndex"))
|
116
139
|
Block.add_member(:column_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "ColumnIndex"))
|
117
140
|
Block.add_member(:row_span, Shapes::ShapeRef.new(shape: UInteger, location_name: "RowSpan"))
|
@@ -156,6 +179,30 @@ module Aws::Textract
|
|
156
179
|
|
157
180
|
EntityTypes.member = Shapes::ShapeRef.new(shape: EntityType)
|
158
181
|
|
182
|
+
ExpenseDetection.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
|
183
|
+
ExpenseDetection.add_member(:geometry, Shapes::ShapeRef.new(shape: Geometry, location_name: "Geometry"))
|
184
|
+
ExpenseDetection.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
|
185
|
+
ExpenseDetection.struct_class = Types::ExpenseDetection
|
186
|
+
|
187
|
+
ExpenseDocument.add_member(:expense_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "ExpenseIndex"))
|
188
|
+
ExpenseDocument.add_member(:summary_fields, Shapes::ShapeRef.new(shape: ExpenseFieldList, location_name: "SummaryFields"))
|
189
|
+
ExpenseDocument.add_member(:line_item_groups, Shapes::ShapeRef.new(shape: LineItemGroupList, location_name: "LineItemGroups"))
|
190
|
+
ExpenseDocument.struct_class = Types::ExpenseDocument
|
191
|
+
|
192
|
+
ExpenseDocumentList.member = Shapes::ShapeRef.new(shape: ExpenseDocument)
|
193
|
+
|
194
|
+
ExpenseField.add_member(:type, Shapes::ShapeRef.new(shape: ExpenseType, location_name: "Type"))
|
195
|
+
ExpenseField.add_member(:label_detection, Shapes::ShapeRef.new(shape: ExpenseDetection, location_name: "LabelDetection"))
|
196
|
+
ExpenseField.add_member(:value_detection, Shapes::ShapeRef.new(shape: ExpenseDetection, location_name: "ValueDetection"))
|
197
|
+
ExpenseField.add_member(:page_number, Shapes::ShapeRef.new(shape: UInteger, location_name: "PageNumber"))
|
198
|
+
ExpenseField.struct_class = Types::ExpenseField
|
199
|
+
|
200
|
+
ExpenseFieldList.member = Shapes::ShapeRef.new(shape: ExpenseField)
|
201
|
+
|
202
|
+
ExpenseType.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
|
203
|
+
ExpenseType.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
|
204
|
+
ExpenseType.struct_class = Types::ExpenseType
|
205
|
+
|
159
206
|
FeatureTypes.member = Shapes::ShapeRef.new(shape: FeatureType)
|
160
207
|
|
161
208
|
Geometry.add_member(:bounding_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "BoundingBox"))
|
@@ -218,12 +265,25 @@ module Aws::Textract
|
|
218
265
|
|
219
266
|
InvalidJobIdException.struct_class = Types::InvalidJobIdException
|
220
267
|
|
268
|
+
InvalidKMSKeyException.struct_class = Types::InvalidKMSKeyException
|
269
|
+
|
221
270
|
InvalidParameterException.struct_class = Types::InvalidParameterException
|
222
271
|
|
223
272
|
InvalidS3ObjectException.struct_class = Types::InvalidS3ObjectException
|
224
273
|
|
225
274
|
LimitExceededException.struct_class = Types::LimitExceededException
|
226
275
|
|
276
|
+
LineItemFields.add_member(:line_item_expense_fields, Shapes::ShapeRef.new(shape: ExpenseFieldList, location_name: "LineItemExpenseFields"))
|
277
|
+
LineItemFields.struct_class = Types::LineItemFields
|
278
|
+
|
279
|
+
LineItemGroup.add_member(:line_item_group_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "LineItemGroupIndex"))
|
280
|
+
LineItemGroup.add_member(:line_items, Shapes::ShapeRef.new(shape: LineItemList, location_name: "LineItems"))
|
281
|
+
LineItemGroup.struct_class = Types::LineItemGroup
|
282
|
+
|
283
|
+
LineItemGroupList.member = Shapes::ShapeRef.new(shape: LineItemGroup)
|
284
|
+
|
285
|
+
LineItemList.member = Shapes::ShapeRef.new(shape: LineItemFields)
|
286
|
+
|
227
287
|
NotificationChannel.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: SNSTopicArn, required: true, location_name: "SNSTopicArn"))
|
228
288
|
NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
229
289
|
NotificationChannel.struct_class = Types::NotificationChannel
|
@@ -259,6 +319,7 @@ module Aws::Textract
|
|
259
319
|
StartDocumentAnalysisRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
260
320
|
StartDocumentAnalysisRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
261
321
|
StartDocumentAnalysisRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
322
|
+
StartDocumentAnalysisRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "KMSKeyId"))
|
262
323
|
StartDocumentAnalysisRequest.struct_class = Types::StartDocumentAnalysisRequest
|
263
324
|
|
264
325
|
StartDocumentAnalysisResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -269,6 +330,7 @@ module Aws::Textract
|
|
269
330
|
StartDocumentTextDetectionRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
270
331
|
StartDocumentTextDetectionRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
271
332
|
StartDocumentTextDetectionRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
333
|
+
StartDocumentTextDetectionRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "KMSKeyId"))
|
272
334
|
StartDocumentTextDetectionRequest.struct_class = Types::StartDocumentTextDetectionRequest
|
273
335
|
|
274
336
|
StartDocumentTextDetectionResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -320,6 +382,23 @@ module Aws::Textract
|
|
320
382
|
o.errors << Shapes::ShapeRef.new(shape: HumanLoopQuotaExceededException)
|
321
383
|
end)
|
322
384
|
|
385
|
+
api.add_operation(:analyze_expense, Seahorse::Model::Operation.new.tap do |o|
|
386
|
+
o.name = "AnalyzeExpense"
|
387
|
+
o.http_method = "POST"
|
388
|
+
o.http_request_uri = "/"
|
389
|
+
o.input = Shapes::ShapeRef.new(shape: AnalyzeExpenseRequest)
|
390
|
+
o.output = Shapes::ShapeRef.new(shape: AnalyzeExpenseResponse)
|
391
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
392
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
393
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
394
|
+
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
395
|
+
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
396
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
397
|
+
o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
|
398
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
399
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
400
|
+
end)
|
401
|
+
|
323
402
|
api.add_operation(:detect_document_text, Seahorse::Model::Operation.new.tap do |o|
|
324
403
|
o.name = "DetectDocumentText"
|
325
404
|
o.http_method = "POST"
|
@@ -350,6 +429,7 @@ module Aws::Textract
|
|
350
429
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
351
430
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
352
431
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
432
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
353
433
|
end)
|
354
434
|
|
355
435
|
api.add_operation(:get_document_text_detection, Seahorse::Model::Operation.new.tap do |o|
|
@@ -365,6 +445,7 @@ module Aws::Textract
|
|
365
445
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
366
446
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
367
447
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
448
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
368
449
|
end)
|
369
450
|
|
370
451
|
api.add_operation(:start_document_analysis, Seahorse::Model::Operation.new.tap do |o|
|
@@ -375,6 +456,7 @@ module Aws::Textract
|
|
375
456
|
o.output = Shapes::ShapeRef.new(shape: StartDocumentAnalysisResponse)
|
376
457
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
377
458
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
459
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
378
460
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
379
461
|
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
380
462
|
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
@@ -394,6 +476,7 @@ module Aws::Textract
|
|
394
476
|
o.output = Shapes::ShapeRef.new(shape: StartDocumentTextDetectionResponse)
|
395
477
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
396
478
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
479
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
397
480
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
398
481
|
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
399
482
|
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -34,6 +34,7 @@ module Aws::Textract
|
|
34
34
|
# * {IdempotentParameterMismatchException}
|
35
35
|
# * {InternalServerError}
|
36
36
|
# * {InvalidJobIdException}
|
37
|
+
# * {InvalidKMSKeyException}
|
37
38
|
# * {InvalidParameterException}
|
38
39
|
# * {InvalidS3ObjectException}
|
39
40
|
# * {LimitExceededException}
|
@@ -132,6 +133,16 @@ module Aws::Textract
|
|
132
133
|
end
|
133
134
|
end
|
134
135
|
|
136
|
+
class InvalidKMSKeyException < ServiceError
|
137
|
+
|
138
|
+
# @param [Seahorse::Client::RequestContext] context
|
139
|
+
# @param [String] message
|
140
|
+
# @param [Aws::Textract::Types::InvalidKMSKeyException] data
|
141
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
142
|
+
super(context, message, data)
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
135
146
|
class InvalidParameterException < ServiceError
|
136
147
|
|
137
148
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -103,6 +103,71 @@ module Aws::Textract
|
|
103
103
|
include Aws::Structure
|
104
104
|
end
|
105
105
|
|
106
|
+
# @note When making an API call, you may pass AnalyzeExpenseRequest
|
107
|
+
# data as a hash:
|
108
|
+
#
|
109
|
+
# {
|
110
|
+
# document: { # required
|
111
|
+
# bytes: "data",
|
112
|
+
# s3_object: {
|
113
|
+
# bucket: "S3Bucket",
|
114
|
+
# name: "S3ObjectName",
|
115
|
+
# version: "S3ObjectVersion",
|
116
|
+
# },
|
117
|
+
# },
|
118
|
+
# }
|
119
|
+
#
|
120
|
+
# @!attribute [rw] document
|
121
|
+
# The input document, either as bytes or as an S3 object.
|
122
|
+
#
|
123
|
+
# You pass image bytes to an Amazon Textract API operation by using
|
124
|
+
# the `Bytes` property. For example, you would use the `Bytes`
|
125
|
+
# property to pass a document loaded from a local file system. Image
|
126
|
+
# bytes passed by using the `Bytes` property must be base64 encoded.
|
127
|
+
# Your code might not need to encode document file bytes if you're
|
128
|
+
# using an AWS SDK to call Amazon Textract API operations.
|
129
|
+
#
|
130
|
+
# You pass images stored in an S3 bucket to an Amazon Textract API
|
131
|
+
# operation by using the `S3Object` property. Documents stored in an
|
132
|
+
# S3 bucket don't need to be base64 encoded.
|
133
|
+
#
|
134
|
+
# The AWS Region for the S3 bucket that contains the S3 object must
|
135
|
+
# match the AWS Region that you use for Amazon Textract operations.
|
136
|
+
#
|
137
|
+
# If you use the AWS CLI to call Amazon Textract operations, passing
|
138
|
+
# image bytes using the Bytes property isn't supported. You must
|
139
|
+
# first upload the document to an Amazon S3 bucket, and then call the
|
140
|
+
# operation using the S3Object property.
|
141
|
+
#
|
142
|
+
# For Amazon Textract to process an S3 object, the user must have
|
143
|
+
# permission to access the S3 object.
|
144
|
+
# @return [Types::Document]
|
145
|
+
#
|
146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeExpenseRequest AWS API Documentation
|
147
|
+
#
|
148
|
+
class AnalyzeExpenseRequest < Struct.new(
|
149
|
+
:document)
|
150
|
+
SENSITIVE = []
|
151
|
+
include Aws::Structure
|
152
|
+
end
|
153
|
+
|
154
|
+
# @!attribute [rw] document_metadata
|
155
|
+
# Information about the input document.
|
156
|
+
# @return [Types::DocumentMetadata]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] expense_documents
|
159
|
+
# The expenses detected by Amazon Textract.
|
160
|
+
# @return [Array<Types::ExpenseDocument>]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeExpenseResponse AWS API Documentation
|
163
|
+
#
|
164
|
+
class AnalyzeExpenseResponse < Struct.new(
|
165
|
+
:document_metadata,
|
166
|
+
:expense_documents)
|
167
|
+
SENSITIVE = []
|
168
|
+
include Aws::Structure
|
169
|
+
end
|
170
|
+
|
106
171
|
# Amazon Textract isn't able to read the document. For more information
|
107
172
|
# on the document limits in Amazon Textract, see limits.
|
108
173
|
#
|
@@ -184,6 +249,11 @@ module Aws::Textract
|
|
184
249
|
# The word or line of text that's recognized by Amazon Textract.
|
185
250
|
# @return [String]
|
186
251
|
#
|
252
|
+
# @!attribute [rw] text_type
|
253
|
+
# The kind of text that Amazon Textract has detected. Can check for
|
254
|
+
# handwritten text and printed text.
|
255
|
+
# @return [String]
|
256
|
+
#
|
187
257
|
# @!attribute [rw] row_index
|
188
258
|
# The row in which a table cell is located. The first row position is
|
189
259
|
# 1. `RowIndex` isn't returned by `DetectDocumentText` and
|
@@ -265,6 +335,7 @@ module Aws::Textract
|
|
265
335
|
:block_type,
|
266
336
|
:confidence,
|
267
337
|
:text,
|
338
|
+
:text_type,
|
268
339
|
:row_index,
|
269
340
|
:column_index,
|
270
341
|
:row_span,
|
@@ -486,13 +557,118 @@ module Aws::Textract
|
|
486
557
|
end
|
487
558
|
|
488
559
|
# The document can't be processed because it's too large. The maximum
|
489
|
-
# document size for synchronous operations
|
560
|
+
# document size for synchronous operations 10 MB. The maximum document
|
490
561
|
# size for asynchronous operations is 500 MB for PDF files.
|
491
562
|
#
|
492
563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DocumentTooLargeException AWS API Documentation
|
493
564
|
#
|
494
565
|
class DocumentTooLargeException < Aws::EmptyStructure; end
|
495
566
|
|
567
|
+
# An object used to store information about the Value or Label detected
|
568
|
+
# by Amazon Textract.
|
569
|
+
#
|
570
|
+
# @!attribute [rw] text
|
571
|
+
# The word or line of text recognized by Amazon Textract
|
572
|
+
# @return [String]
|
573
|
+
#
|
574
|
+
# @!attribute [rw] geometry
|
575
|
+
# Information about where the following items are located on a
|
576
|
+
# document page: detected page, text, key-value pairs, tables, table
|
577
|
+
# cells, and selection elements.
|
578
|
+
# @return [Types::Geometry]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] confidence
|
581
|
+
# The confidence in detection, as a percentage
|
582
|
+
# @return [Float]
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ExpenseDetection AWS API Documentation
|
585
|
+
#
|
586
|
+
class ExpenseDetection < Struct.new(
|
587
|
+
:text,
|
588
|
+
:geometry,
|
589
|
+
:confidence)
|
590
|
+
SENSITIVE = []
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# The structure holding all the information returned by AnalyzeExpense
|
595
|
+
#
|
596
|
+
# @!attribute [rw] expense_index
|
597
|
+
# Denotes which invoice or receipt in the document the information is
|
598
|
+
# coming from. First document will be 1, the second 2, and so on.
|
599
|
+
# @return [Integer]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] summary_fields
|
602
|
+
# Any information found outside of a table by Amazon Textract.
|
603
|
+
# @return [Array<Types::ExpenseField>]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] line_item_groups
|
606
|
+
# Information detected on each table of a document, seperated into
|
607
|
+
# `LineItems`.
|
608
|
+
# @return [Array<Types::LineItemGroup>]
|
609
|
+
#
|
610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ExpenseDocument AWS API Documentation
|
611
|
+
#
|
612
|
+
class ExpenseDocument < Struct.new(
|
613
|
+
:expense_index,
|
614
|
+
:summary_fields,
|
615
|
+
:line_item_groups)
|
616
|
+
SENSITIVE = []
|
617
|
+
include Aws::Structure
|
618
|
+
end
|
619
|
+
|
620
|
+
# Breakdown of detected information, seperated into the catagories Type,
|
621
|
+
# LableDetection, and ValueDetection
|
622
|
+
#
|
623
|
+
# @!attribute [rw] type
|
624
|
+
# The implied label of a detected element. Present alongside
|
625
|
+
# LabelDetection for explicit elements.
|
626
|
+
# @return [Types::ExpenseType]
|
627
|
+
#
|
628
|
+
# @!attribute [rw] label_detection
|
629
|
+
# The explicitly stated label of a detected element.
|
630
|
+
# @return [Types::ExpenseDetection]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] value_detection
|
633
|
+
# The value of a detected element. Present in explicit and implicit
|
634
|
+
# elements.
|
635
|
+
# @return [Types::ExpenseDetection]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] page_number
|
638
|
+
# The page number the value was detected on.
|
639
|
+
# @return [Integer]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ExpenseField AWS API Documentation
|
642
|
+
#
|
643
|
+
class ExpenseField < Struct.new(
|
644
|
+
:type,
|
645
|
+
:label_detection,
|
646
|
+
:value_detection,
|
647
|
+
:page_number)
|
648
|
+
SENSITIVE = []
|
649
|
+
include Aws::Structure
|
650
|
+
end
|
651
|
+
|
652
|
+
# An object used to store information about the Type detected by Amazon
|
653
|
+
# Textract.
|
654
|
+
#
|
655
|
+
# @!attribute [rw] text
|
656
|
+
# The word or line of text detected by Amazon Textract.
|
657
|
+
# @return [String]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] confidence
|
660
|
+
# The confidence of accuracy, as a percentage.
|
661
|
+
# @return [Float]
|
662
|
+
#
|
663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ExpenseType AWS API Documentation
|
664
|
+
#
|
665
|
+
class ExpenseType < Struct.new(
|
666
|
+
:text,
|
667
|
+
:confidence)
|
668
|
+
SENSITIVE = []
|
669
|
+
include Aws::Structure
|
670
|
+
end
|
671
|
+
|
496
672
|
# Information about where the following items are located on a document
|
497
673
|
# page: detected page, text, key-value pairs, tables, table cells, and
|
498
674
|
# selection elements.
|
@@ -822,6 +998,13 @@ module Aws::Textract
|
|
822
998
|
#
|
823
999
|
class InvalidJobIdException < Aws::EmptyStructure; end
|
824
1000
|
|
1001
|
+
# Indicates you do not have decrypt permissions with the KMS key
|
1002
|
+
# entered, or the KMS key was entered incorrectly.
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InvalidKMSKeyException AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class InvalidKMSKeyException < Aws::EmptyStructure; end
|
1007
|
+
|
825
1008
|
# An input parameter violated a constraint. For example, in synchronous
|
826
1009
|
# operations, an `InvalidParameterException` exception occurs when
|
827
1010
|
# neither of the `S3Object` or `Bytes` values are supplied in the
|
@@ -856,6 +1039,44 @@ module Aws::Textract
|
|
856
1039
|
#
|
857
1040
|
class LimitExceededException < Aws::EmptyStructure; end
|
858
1041
|
|
1042
|
+
# A structure that holds information about the different lines found in
|
1043
|
+
# a document's tables.
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] line_item_expense_fields
|
1046
|
+
# ExpenseFields used to show information from detected lines on a
|
1047
|
+
# table.
|
1048
|
+
# @return [Array<Types::ExpenseField>]
|
1049
|
+
#
|
1050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LineItemFields AWS API Documentation
|
1051
|
+
#
|
1052
|
+
class LineItemFields < Struct.new(
|
1053
|
+
:line_item_expense_fields)
|
1054
|
+
SENSITIVE = []
|
1055
|
+
include Aws::Structure
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# A grouping of tables which contain LineItems, with each table
|
1059
|
+
# identified by the table's `LineItemGroupIndex`.
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] line_item_group_index
|
1062
|
+
# The number used to identify a specific table in a document. The
|
1063
|
+
# first table encountered will have a LineItemGroupIndex of 1, the
|
1064
|
+
# second 2, etc.
|
1065
|
+
# @return [Integer]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] line_items
|
1068
|
+
# The breakdown of information on a particular line of a table.
|
1069
|
+
# @return [Array<Types::LineItemFields>]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LineItemGroup AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class LineItemGroup < Struct.new(
|
1074
|
+
:line_item_group_index,
|
1075
|
+
:line_items)
|
1076
|
+
SENSITIVE = []
|
1077
|
+
include Aws::Structure
|
1078
|
+
end
|
1079
|
+
|
859
1080
|
# The Amazon Simple Notification Service (Amazon SNS) topic to which
|
860
1081
|
# Amazon Textract publishes the completion status of an asynchronous
|
861
1082
|
# document operation, such as StartDocumentTextDetection.
|
@@ -890,6 +1111,31 @@ module Aws::Textract
|
|
890
1111
|
# Sets whether or not your output will go to a user created bucket. Used
|
891
1112
|
# to set the name of the bucket, and the prefix on the output file.
|
892
1113
|
#
|
1114
|
+
# `OutputConfig` is an optional parameter which lets you adjust where
|
1115
|
+
# your output will be placed. By default, Amazon Textract will store the
|
1116
|
+
# results internally and can only be accessed by the Get API operations.
|
1117
|
+
# With OutputConfig enabled, you can set the name of the bucket the
|
1118
|
+
# output will be sent to and the file prefix of the results where you
|
1119
|
+
# can download your results. Additionally, you can set the `KMSKeyID`
|
1120
|
+
# parameter to a customer master key (CMK) to encrypt your output.
|
1121
|
+
# Without this parameter set Amazon Textract will encrypt server-side
|
1122
|
+
# using the AWS managed CMK for Amazon S3.
|
1123
|
+
#
|
1124
|
+
# Decryption of Customer Content is necessary for processing of the
|
1125
|
+
# documents by Amazon Textract. If your account is opted out under an AI
|
1126
|
+
# services opt out policy then all unencrypted Customer Content is
|
1127
|
+
# immediately and permanently deleted after the Customer Content has
|
1128
|
+
# been processed by the service. No copy of of the output is retained by
|
1129
|
+
# Amazon Textract. For information about how to opt out, see [ Managing
|
1130
|
+
# AI services opt-out policy. ][1]
|
1131
|
+
#
|
1132
|
+
# For more information on data privacy, see the [Data Privacy FAQ][2].
|
1133
|
+
#
|
1134
|
+
#
|
1135
|
+
#
|
1136
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
1137
|
+
# [2]: https://aws.amazon.com/compliance/data-privacy-faq/
|
1138
|
+
#
|
893
1139
|
# @note When making an API call, you may pass OutputConfig
|
894
1140
|
# data as a hash:
|
895
1141
|
#
|
@@ -1000,7 +1246,8 @@ module Aws::Textract
|
|
1000
1246
|
# }
|
1001
1247
|
#
|
1002
1248
|
# @!attribute [rw] bucket
|
1003
|
-
# The name of the S3 bucket.
|
1249
|
+
# The name of the S3 bucket. Note that the # character is not valid in
|
1250
|
+
# the file name.
|
1004
1251
|
# @return [String]
|
1005
1252
|
#
|
1006
1253
|
# @!attribute [rw] name
|
@@ -1046,6 +1293,7 @@ module Aws::Textract
|
|
1046
1293
|
# s3_bucket: "S3Bucket", # required
|
1047
1294
|
# s3_prefix: "S3ObjectName",
|
1048
1295
|
# },
|
1296
|
+
# kms_key_id: "KMSKeyId",
|
1049
1297
|
# }
|
1050
1298
|
#
|
1051
1299
|
# @!attribute [rw] document_location
|
@@ -1093,6 +1341,14 @@ module Aws::Textract
|
|
1093
1341
|
# the GetDocumentAnalysis operation.
|
1094
1342
|
# @return [Types::OutputConfig]
|
1095
1343
|
#
|
1344
|
+
# @!attribute [rw] kms_key_id
|
1345
|
+
# The KMS key used to encrypt the inference results. This can be in
|
1346
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the
|
1347
|
+
# KMS key will be used for server-side encryption of the objects in
|
1348
|
+
# the customer bucket. When this parameter is not enabled, the result
|
1349
|
+
# will be encrypted server side,using SSE-S3.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1096
1352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysisRequest AWS API Documentation
|
1097
1353
|
#
|
1098
1354
|
class StartDocumentAnalysisRequest < Struct.new(
|
@@ -1101,7 +1357,8 @@ module Aws::Textract
|
|
1101
1357
|
:client_request_token,
|
1102
1358
|
:job_tag,
|
1103
1359
|
:notification_channel,
|
1104
|
-
:output_config
|
1360
|
+
:output_config,
|
1361
|
+
:kms_key_id)
|
1105
1362
|
SENSITIVE = []
|
1106
1363
|
include Aws::Structure
|
1107
1364
|
end
|
@@ -1141,6 +1398,7 @@ module Aws::Textract
|
|
1141
1398
|
# s3_bucket: "S3Bucket", # required
|
1142
1399
|
# s3_prefix: "S3ObjectName",
|
1143
1400
|
# },
|
1401
|
+
# kms_key_id: "KMSKeyId",
|
1144
1402
|
# }
|
1145
1403
|
#
|
1146
1404
|
# @!attribute [rw] document_location
|
@@ -1178,6 +1436,14 @@ module Aws::Textract
|
|
1178
1436
|
# the GetDocumentTextDetection operation.
|
1179
1437
|
# @return [Types::OutputConfig]
|
1180
1438
|
#
|
1439
|
+
# @!attribute [rw] kms_key_id
|
1440
|
+
# The KMS key used to encrypt the inference results. This can be in
|
1441
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the
|
1442
|
+
# KMS key will be used for server-side encryption of the objects in
|
1443
|
+
# the customer bucket. When this parameter is not enabled, the result
|
1444
|
+
# will be encrypted server side,using SSE-S3.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1181
1447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetectionRequest AWS API Documentation
|
1182
1448
|
#
|
1183
1449
|
class StartDocumentTextDetectionRequest < Struct.new(
|
@@ -1185,7 +1451,8 @@ module Aws::Textract
|
|
1185
1451
|
:client_request_token,
|
1186
1452
|
:job_tag,
|
1187
1453
|
:notification_channel,
|
1188
|
-
:output_config
|
1454
|
+
:output_config,
|
1455
|
+
:kms_key_id)
|
1189
1456
|
SENSITIVE = []
|
1190
1457
|
include Aws::Structure
|
1191
1458
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-textract
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.25.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-07-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -47,11 +47,14 @@ dependencies:
|
|
47
47
|
description: Official AWS Ruby gem for Amazon Textract. This gem is part of the AWS
|
48
48
|
SDK for Ruby.
|
49
49
|
email:
|
50
|
-
-
|
50
|
+
- aws-dr-rubygems@amazon.com
|
51
51
|
executables: []
|
52
52
|
extensions: []
|
53
53
|
extra_rdoc_files: []
|
54
54
|
files:
|
55
|
+
- CHANGELOG.md
|
56
|
+
- LICENSE.txt
|
57
|
+
- VERSION
|
55
58
|
- lib/aws-sdk-textract.rb
|
56
59
|
- lib/aws-sdk-textract/client.rb
|
57
60
|
- lib/aws-sdk-textract/client_api.rb
|
@@ -63,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
|
|
63
66
|
licenses:
|
64
67
|
- Apache-2.0
|
65
68
|
metadata:
|
66
|
-
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
67
|
-
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
69
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-textract
|
70
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-textract/CHANGELOG.md
|
68
71
|
post_install_message:
|
69
72
|
rdoc_options: []
|
70
73
|
require_paths:
|
@@ -80,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
80
83
|
- !ruby/object:Gem::Version
|
81
84
|
version: '0'
|
82
85
|
requirements: []
|
83
|
-
|
84
|
-
rubygems_version: 2.7.6.2
|
86
|
+
rubygems_version: 3.1.6
|
85
87
|
signing_key:
|
86
88
|
specification_version: 4
|
87
89
|
summary: AWS SDK for Ruby - Amazon Textract
|