aws-sdk-textract 1.18.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-textract.rb +2 -1
- data/lib/aws-sdk-textract/client.rb +43 -5
- data/lib/aws-sdk-textract/client_api.rb +19 -0
- data/lib/aws-sdk-textract/errors.rb +11 -0
- data/lib/aws-sdk-textract/types.rb +107 -10
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7e662c6f04451a6fa70214594ca5e29d2fd9ef24a4df9e7dce2c76f3832356c8
|
4
|
+
data.tar.gz: c08b164aaa150008834a7ab417b6c9849971c5ca29a4fa1549ab7e13a71ee5a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c8937ad6e5e38286831e61a6543ffec0e5e0ac07e6bff72383876a32771d25136d3a7d3a9739129f8b8b0fa0faa152c538d29d71ca0029f8aeafa54534fd7a38
|
7
|
+
data.tar.gz: b2f53f2a4bf518122cafba259806d11311117320219400a4ca2df7b06c713228a8ae1fac4272e728f489545787bd2deb87f14eb8d41254591ce3d5518d077ebb
|
data/lib/aws-sdk-textract.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-textract/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::Textract
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.23.0'
|
51
52
|
|
52
53
|
end
|
@@ -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
|
@@ -444,7 +445,7 @@ module Aws::Textract
|
|
444
445
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
445
446
|
# resp.blocks[0].id #=> String
|
446
447
|
# resp.blocks[0].relationships #=> Array
|
447
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
448
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
448
449
|
# resp.blocks[0].relationships[0].ids #=> Array
|
449
450
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
450
451
|
# resp.blocks[0].entity_types #=> Array
|
@@ -521,6 +522,7 @@ module Aws::Textract
|
|
521
522
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
522
523
|
# resp.blocks[0].confidence #=> Float
|
523
524
|
# resp.blocks[0].text #=> String
|
525
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
524
526
|
# resp.blocks[0].row_index #=> Integer
|
525
527
|
# resp.blocks[0].column_index #=> Integer
|
526
528
|
# resp.blocks[0].row_span #=> Integer
|
@@ -534,7 +536,7 @@ module Aws::Textract
|
|
534
536
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
535
537
|
# resp.blocks[0].id #=> String
|
536
538
|
# resp.blocks[0].relationships #=> Array
|
537
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
539
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
538
540
|
# resp.blocks[0].relationships[0].ids #=> Array
|
539
541
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
540
542
|
# resp.blocks[0].entity_types #=> Array
|
@@ -647,6 +649,7 @@ module Aws::Textract
|
|
647
649
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
648
650
|
# resp.blocks[0].confidence #=> Float
|
649
651
|
# resp.blocks[0].text #=> String
|
652
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
650
653
|
# resp.blocks[0].row_index #=> Integer
|
651
654
|
# resp.blocks[0].column_index #=> Integer
|
652
655
|
# resp.blocks[0].row_span #=> Integer
|
@@ -660,7 +663,7 @@ module Aws::Textract
|
|
660
663
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
661
664
|
# resp.blocks[0].id #=> String
|
662
665
|
# resp.blocks[0].relationships #=> Array
|
663
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
666
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
664
667
|
# resp.blocks[0].relationships[0].ids #=> Array
|
665
668
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
666
669
|
# resp.blocks[0].entity_types #=> Array
|
@@ -764,6 +767,7 @@ module Aws::Textract
|
|
764
767
|
# resp.blocks[0].block_type #=> String, one of "KEY_VALUE_SET", "PAGE", "LINE", "WORD", "TABLE", "CELL", "SELECTION_ELEMENT"
|
765
768
|
# resp.blocks[0].confidence #=> Float
|
766
769
|
# resp.blocks[0].text #=> String
|
770
|
+
# resp.blocks[0].text_type #=> String, one of "HANDWRITING", "PRINTED"
|
767
771
|
# resp.blocks[0].row_index #=> Integer
|
768
772
|
# resp.blocks[0].column_index #=> Integer
|
769
773
|
# resp.blocks[0].row_span #=> Integer
|
@@ -777,7 +781,7 @@ module Aws::Textract
|
|
777
781
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
778
782
|
# resp.blocks[0].id #=> String
|
779
783
|
# resp.blocks[0].relationships #=> Array
|
780
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
784
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
781
785
|
# resp.blocks[0].relationships[0].ids #=> Array
|
782
786
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
783
787
|
# resp.blocks[0].entity_types #=> Array
|
@@ -857,6 +861,18 @@ module Aws::Textract
|
|
857
861
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
858
862
|
# completion status of the operation to.
|
859
863
|
#
|
864
|
+
# @option params [Types::OutputConfig] :output_config
|
865
|
+
# Sets if the output will go to a customer defined bucket. By default,
|
866
|
+
# Amazon Textract will save the results internally to be accessed by the
|
867
|
+
# GetDocumentAnalysis operation.
|
868
|
+
#
|
869
|
+
# @option params [String] :kms_key_id
|
870
|
+
# The KMS key used to encrypt the inference results. This can be in
|
871
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the KMS
|
872
|
+
# key will be used for server-side encryption of the objects in the
|
873
|
+
# customer bucket. When this parameter is not enabled, the result will
|
874
|
+
# be encrypted server side,using SSE-S3.
|
875
|
+
#
|
860
876
|
# @return [Types::StartDocumentAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
861
877
|
#
|
862
878
|
# * {Types::StartDocumentAnalysisResponse#job_id #job_id} => String
|
@@ -878,6 +894,11 @@ module Aws::Textract
|
|
878
894
|
# sns_topic_arn: "SNSTopicArn", # required
|
879
895
|
# role_arn: "RoleArn", # required
|
880
896
|
# },
|
897
|
+
# output_config: {
|
898
|
+
# s3_bucket: "S3Bucket", # required
|
899
|
+
# s3_prefix: "S3ObjectName",
|
900
|
+
# },
|
901
|
+
# kms_key_id: "KMSKeyId",
|
881
902
|
# })
|
882
903
|
#
|
883
904
|
# @example Response structure
|
@@ -943,6 +964,18 @@ module Aws::Textract
|
|
943
964
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
944
965
|
# completion status of the operation to.
|
945
966
|
#
|
967
|
+
# @option params [Types::OutputConfig] :output_config
|
968
|
+
# Sets if the output will go to a customer defined bucket. By default
|
969
|
+
# Amazon Textract will save the results internally to be accessed with
|
970
|
+
# the GetDocumentTextDetection operation.
|
971
|
+
#
|
972
|
+
# @option params [String] :kms_key_id
|
973
|
+
# The KMS key used to encrypt the inference results. This can be in
|
974
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the KMS
|
975
|
+
# key will be used for server-side encryption of the objects in the
|
976
|
+
# customer bucket. When this parameter is not enabled, the result will
|
977
|
+
# be encrypted server side,using SSE-S3.
|
978
|
+
#
|
946
979
|
# @return [Types::StartDocumentTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
947
980
|
#
|
948
981
|
# * {Types::StartDocumentTextDetectionResponse#job_id #job_id} => String
|
@@ -963,6 +996,11 @@ module Aws::Textract
|
|
963
996
|
# sns_topic_arn: "SNSTopicArn", # required
|
964
997
|
# role_arn: "RoleArn", # required
|
965
998
|
# },
|
999
|
+
# output_config: {
|
1000
|
+
# s3_bucket: "S3Bucket", # required
|
1001
|
+
# s3_prefix: "S3ObjectName",
|
1002
|
+
# },
|
1003
|
+
# kms_key_id: "KMSKeyId",
|
966
1004
|
# })
|
967
1005
|
#
|
968
1006
|
# @example Response structure
|
@@ -991,7 +1029,7 @@ module Aws::Textract
|
|
991
1029
|
params: params,
|
992
1030
|
config: config)
|
993
1031
|
context[:gem_name] = 'aws-sdk-textract'
|
994
|
-
context[:gem_version] = '1.
|
1032
|
+
context[:gem_version] = '1.23.0'
|
995
1033
|
Seahorse::Client::Request.new(handlers, context)
|
996
1034
|
end
|
997
1035
|
|
@@ -56,15 +56,18 @@ module Aws::Textract
|
|
56
56
|
ImageBlob = Shapes::BlobShape.new(name: 'ImageBlob')
|
57
57
|
InternalServerError = Shapes::StructureShape.new(name: 'InternalServerError')
|
58
58
|
InvalidJobIdException = Shapes::StructureShape.new(name: 'InvalidJobIdException')
|
59
|
+
InvalidKMSKeyException = Shapes::StructureShape.new(name: 'InvalidKMSKeyException')
|
59
60
|
InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
|
60
61
|
InvalidS3ObjectException = Shapes::StructureShape.new(name: 'InvalidS3ObjectException')
|
61
62
|
JobId = Shapes::StringShape.new(name: 'JobId')
|
62
63
|
JobStatus = Shapes::StringShape.new(name: 'JobStatus')
|
63
64
|
JobTag = Shapes::StringShape.new(name: 'JobTag')
|
65
|
+
KMSKeyId = Shapes::StringShape.new(name: 'KMSKeyId')
|
64
66
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
65
67
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
66
68
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
67
69
|
NotificationChannel = Shapes::StructureShape.new(name: 'NotificationChannel')
|
70
|
+
OutputConfig = Shapes::StructureShape.new(name: 'OutputConfig')
|
68
71
|
Pages = Shapes::ListShape.new(name: 'Pages')
|
69
72
|
PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
|
70
73
|
Percent = Shapes::FloatShape.new(name: 'Percent')
|
@@ -87,6 +90,7 @@ module Aws::Textract
|
|
87
90
|
StartDocumentTextDetectionResponse = Shapes::StructureShape.new(name: 'StartDocumentTextDetectionResponse')
|
88
91
|
StatusMessage = Shapes::StringShape.new(name: 'StatusMessage')
|
89
92
|
String = Shapes::StringShape.new(name: 'String')
|
93
|
+
TextType = Shapes::StringShape.new(name: 'TextType')
|
90
94
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
91
95
|
UInteger = Shapes::IntegerShape.new(name: 'UInteger')
|
92
96
|
UnsupportedDocumentException = Shapes::StructureShape.new(name: 'UnsupportedDocumentException')
|
@@ -111,6 +115,7 @@ module Aws::Textract
|
|
111
115
|
Block.add_member(:block_type, Shapes::ShapeRef.new(shape: BlockType, location_name: "BlockType"))
|
112
116
|
Block.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
|
113
117
|
Block.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
|
118
|
+
Block.add_member(:text_type, Shapes::ShapeRef.new(shape: TextType, location_name: "TextType"))
|
114
119
|
Block.add_member(:row_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "RowIndex"))
|
115
120
|
Block.add_member(:column_index, Shapes::ShapeRef.new(shape: UInteger, location_name: "ColumnIndex"))
|
116
121
|
Block.add_member(:row_span, Shapes::ShapeRef.new(shape: UInteger, location_name: "RowSpan"))
|
@@ -217,6 +222,8 @@ module Aws::Textract
|
|
217
222
|
|
218
223
|
InvalidJobIdException.struct_class = Types::InvalidJobIdException
|
219
224
|
|
225
|
+
InvalidKMSKeyException.struct_class = Types::InvalidKMSKeyException
|
226
|
+
|
220
227
|
InvalidParameterException.struct_class = Types::InvalidParameterException
|
221
228
|
|
222
229
|
InvalidS3ObjectException.struct_class = Types::InvalidS3ObjectException
|
@@ -227,6 +234,10 @@ module Aws::Textract
|
|
227
234
|
NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
228
235
|
NotificationChannel.struct_class = Types::NotificationChannel
|
229
236
|
|
237
|
+
OutputConfig.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3Bucket, required: true, location_name: "S3Bucket"))
|
238
|
+
OutputConfig.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectName, location_name: "S3Prefix"))
|
239
|
+
OutputConfig.struct_class = Types::OutputConfig
|
240
|
+
|
230
241
|
Pages.member = Shapes::ShapeRef.new(shape: UInteger)
|
231
242
|
|
232
243
|
Point.add_member(:x, Shapes::ShapeRef.new(shape: Float, location_name: "X"))
|
@@ -253,6 +264,8 @@ module Aws::Textract
|
|
253
264
|
StartDocumentAnalysisRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
254
265
|
StartDocumentAnalysisRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
255
266
|
StartDocumentAnalysisRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
267
|
+
StartDocumentAnalysisRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
268
|
+
StartDocumentAnalysisRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "KMSKeyId"))
|
256
269
|
StartDocumentAnalysisRequest.struct_class = Types::StartDocumentAnalysisRequest
|
257
270
|
|
258
271
|
StartDocumentAnalysisResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -262,6 +275,8 @@ module Aws::Textract
|
|
262
275
|
StartDocumentTextDetectionRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
263
276
|
StartDocumentTextDetectionRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
264
277
|
StartDocumentTextDetectionRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
278
|
+
StartDocumentTextDetectionRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
279
|
+
StartDocumentTextDetectionRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "KMSKeyId"))
|
265
280
|
StartDocumentTextDetectionRequest.struct_class = Types::StartDocumentTextDetectionRequest
|
266
281
|
|
267
282
|
StartDocumentTextDetectionResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -342,6 +357,7 @@ module Aws::Textract
|
|
342
357
|
o.errors << Shapes::ShapeRef.new(shape: InvalidJobIdException)
|
343
358
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
344
359
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
360
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
345
361
|
end)
|
346
362
|
|
347
363
|
api.add_operation(:get_document_text_detection, Seahorse::Model::Operation.new.tap do |o|
|
@@ -356,6 +372,7 @@ module Aws::Textract
|
|
356
372
|
o.errors << Shapes::ShapeRef.new(shape: InvalidJobIdException)
|
357
373
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
358
374
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
375
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
359
376
|
end)
|
360
377
|
|
361
378
|
api.add_operation(:start_document_analysis, Seahorse::Model::Operation.new.tap do |o|
|
@@ -366,6 +383,7 @@ module Aws::Textract
|
|
366
383
|
o.output = Shapes::ShapeRef.new(shape: StartDocumentAnalysisResponse)
|
367
384
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
368
385
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
386
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
369
387
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
370
388
|
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
371
389
|
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
@@ -385,6 +403,7 @@ module Aws::Textract
|
|
385
403
|
o.output = Shapes::ShapeRef.new(shape: StartDocumentTextDetectionResponse)
|
386
404
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
387
405
|
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
406
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidKMSKeyException)
|
388
407
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentException)
|
389
408
|
o.errors << Shapes::ShapeRef.new(shape: DocumentTooLargeException)
|
390
409
|
o.errors << Shapes::ShapeRef.new(shape: BadDocumentException)
|
@@ -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
|
@@ -10,7 +10,8 @@
|
|
10
10
|
module Aws::Textract
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# You aren't authorized to perform the action.
|
13
|
+
# You aren't authorized to perform the action. Use the Amazon Resource
|
14
|
+
# Name (ARN) of an authorized user or IAM role to perform the operation.
|
14
15
|
#
|
15
16
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AccessDeniedException AWS API Documentation
|
16
17
|
#
|
@@ -102,7 +103,8 @@ module Aws::Textract
|
|
102
103
|
include Aws::Structure
|
103
104
|
end
|
104
105
|
|
105
|
-
# Amazon Textract isn't able to read the document.
|
106
|
+
# Amazon Textract isn't able to read the document. For more information
|
107
|
+
# on the document limits in Amazon Textract, see limits.
|
106
108
|
#
|
107
109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/BadDocumentException AWS API Documentation
|
108
110
|
#
|
@@ -182,6 +184,11 @@ module Aws::Textract
|
|
182
184
|
# The word or line of text that's recognized by Amazon Textract.
|
183
185
|
# @return [String]
|
184
186
|
#
|
187
|
+
# @!attribute [rw] text_type
|
188
|
+
# The kind of text that Amazon Textract has detected. Can check for
|
189
|
+
# handwritten text and printed text.
|
190
|
+
# @return [String]
|
191
|
+
#
|
185
192
|
# @!attribute [rw] row_index
|
186
193
|
# The row in which a table cell is located. The first row position is
|
187
194
|
# 1. `RowIndex` isn't returned by `DetectDocumentText` and
|
@@ -263,6 +270,7 @@ module Aws::Textract
|
|
263
270
|
:block_type,
|
264
271
|
:confidence,
|
265
272
|
:text,
|
273
|
+
:text_type,
|
266
274
|
:row_index,
|
267
275
|
:column_index,
|
268
276
|
:row_span,
|
@@ -484,7 +492,7 @@ module Aws::Textract
|
|
484
492
|
end
|
485
493
|
|
486
494
|
# The document can't be processed because it's too large. The maximum
|
487
|
-
# document size for synchronous operations
|
495
|
+
# document size for synchronous operations 10 MB. The maximum document
|
488
496
|
# size for asynchronous operations is 500 MB for PDF files.
|
489
497
|
#
|
490
498
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DocumentTooLargeException AWS API Documentation
|
@@ -579,7 +587,8 @@ module Aws::Textract
|
|
579
587
|
# @return [Array<Types::Warning>]
|
580
588
|
#
|
581
589
|
# @!attribute [rw] status_message
|
582
|
-
#
|
590
|
+
# Returns if the detection job could not be completed. Contains
|
591
|
+
# explanation for what error occured.
|
583
592
|
# @return [String]
|
584
593
|
#
|
585
594
|
# @!attribute [rw] analyze_document_model_version
|
@@ -664,8 +673,8 @@ module Aws::Textract
|
|
664
673
|
# @return [Array<Types::Warning>]
|
665
674
|
#
|
666
675
|
# @!attribute [rw] status_message
|
667
|
-
#
|
668
|
-
#
|
676
|
+
# Returns if the detection job could not be completed. Contains
|
677
|
+
# explanation for what error occured.
|
669
678
|
# @return [String]
|
670
679
|
#
|
671
680
|
# @!attribute [rw] detect_document_text_model_version
|
@@ -777,12 +786,15 @@ module Aws::Textract
|
|
777
786
|
# loop workflows available
|
778
787
|
#
|
779
788
|
# @!attribute [rw] resource_type
|
789
|
+
# The resource type.
|
780
790
|
# @return [String]
|
781
791
|
#
|
782
792
|
# @!attribute [rw] quota_code
|
793
|
+
# The quota code.
|
783
794
|
# @return [String]
|
784
795
|
#
|
785
796
|
# @!attribute [rw] service_code
|
797
|
+
# The service code.
|
786
798
|
# @return [String]
|
787
799
|
#
|
788
800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/HumanLoopQuotaExceededException AWS API Documentation
|
@@ -816,6 +828,13 @@ module Aws::Textract
|
|
816
828
|
#
|
817
829
|
class InvalidJobIdException < Aws::EmptyStructure; end
|
818
830
|
|
831
|
+
# Indicates you do not have decrypt permissions with the KMS key
|
832
|
+
# entered, or the KMS key was entered incorrectly.
|
833
|
+
#
|
834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InvalidKMSKeyException AWS API Documentation
|
835
|
+
#
|
836
|
+
class InvalidKMSKeyException < Aws::EmptyStructure; end
|
837
|
+
|
819
838
|
# An input parameter violated a constraint. For example, in synchronous
|
820
839
|
# operations, an `InvalidParameterException` exception occurs when
|
821
840
|
# neither of the `S3Object` or `Bytes` values are supplied in the
|
@@ -827,7 +846,13 @@ module Aws::Textract
|
|
827
846
|
class InvalidParameterException < Aws::EmptyStructure; end
|
828
847
|
|
829
848
|
# Amazon Textract is unable to access the S3 object that's specified in
|
830
|
-
# the request.
|
849
|
+
# the request. for more information, [Configure Access to Amazon S3][1]
|
850
|
+
# For troubleshooting information, see [Troubleshooting Amazon S3][2]
|
851
|
+
#
|
852
|
+
#
|
853
|
+
#
|
854
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
855
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html
|
831
856
|
#
|
832
857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InvalidS3ObjectException AWS API Documentation
|
833
858
|
#
|
@@ -875,6 +900,35 @@ module Aws::Textract
|
|
875
900
|
include Aws::Structure
|
876
901
|
end
|
877
902
|
|
903
|
+
# Sets whether or not your output will go to a user created bucket. Used
|
904
|
+
# to set the name of the bucket, and the prefix on the output file.
|
905
|
+
#
|
906
|
+
# @note When making an API call, you may pass OutputConfig
|
907
|
+
# data as a hash:
|
908
|
+
#
|
909
|
+
# {
|
910
|
+
# s3_bucket: "S3Bucket", # required
|
911
|
+
# s3_prefix: "S3ObjectName",
|
912
|
+
# }
|
913
|
+
#
|
914
|
+
# @!attribute [rw] s3_bucket
|
915
|
+
# The name of the bucket your output will go to.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] s3_prefix
|
919
|
+
# The prefix of the object key that the output will be saved to. When
|
920
|
+
# not enabled, the prefix will be “textract\_output".
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/OutputConfig AWS API Documentation
|
924
|
+
#
|
925
|
+
class OutputConfig < Struct.new(
|
926
|
+
:s3_bucket,
|
927
|
+
:s3_prefix)
|
928
|
+
SENSITIVE = []
|
929
|
+
include Aws::Structure
|
930
|
+
end
|
931
|
+
|
878
932
|
# The X and Y coordinates of a point on a document page. The X and Y
|
879
933
|
# values that are returned are ratios of the overall document page size.
|
880
934
|
# For example, if the input document is 700 x 200 and the operation
|
@@ -923,7 +977,8 @@ module Aws::Textract
|
|
923
977
|
# relationship of type VALUE is a list that contains the ID of the
|
924
978
|
# VALUE block that's associated with the KEY of a key-value pair. A
|
925
979
|
# relationship of type CHILD is a list of IDs that identify WORD
|
926
|
-
# blocks
|
980
|
+
# blocks in the case of lines Cell blocks in the case of Tables, and
|
981
|
+
# WORD blocks in the case of Selection Elements.
|
927
982
|
# @return [String]
|
928
983
|
#
|
929
984
|
# @!attribute [rw] ids
|
@@ -1000,6 +1055,11 @@ module Aws::Textract
|
|
1000
1055
|
# sns_topic_arn: "SNSTopicArn", # required
|
1001
1056
|
# role_arn: "RoleArn", # required
|
1002
1057
|
# },
|
1058
|
+
# output_config: {
|
1059
|
+
# s3_bucket: "S3Bucket", # required
|
1060
|
+
# s3_prefix: "S3ObjectName",
|
1061
|
+
# },
|
1062
|
+
# kms_key_id: "KMSKeyId",
|
1003
1063
|
# }
|
1004
1064
|
#
|
1005
1065
|
# @!attribute [rw] document_location
|
@@ -1041,6 +1101,20 @@ module Aws::Textract
|
|
1041
1101
|
# the completion status of the operation to.
|
1042
1102
|
# @return [Types::NotificationChannel]
|
1043
1103
|
#
|
1104
|
+
# @!attribute [rw] output_config
|
1105
|
+
# Sets if the output will go to a customer defined bucket. By default,
|
1106
|
+
# Amazon Textract will save the results internally to be accessed by
|
1107
|
+
# the GetDocumentAnalysis operation.
|
1108
|
+
# @return [Types::OutputConfig]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] kms_key_id
|
1111
|
+
# The KMS key used to encrypt the inference results. This can be in
|
1112
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the
|
1113
|
+
# KMS key will be used for server-side encryption of the objects in
|
1114
|
+
# the customer bucket. When this parameter is not enabled, the result
|
1115
|
+
# will be encrypted server side,using SSE-S3.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1044
1118
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysisRequest AWS API Documentation
|
1045
1119
|
#
|
1046
1120
|
class StartDocumentAnalysisRequest < Struct.new(
|
@@ -1048,7 +1122,9 @@ module Aws::Textract
|
|
1048
1122
|
:feature_types,
|
1049
1123
|
:client_request_token,
|
1050
1124
|
:job_tag,
|
1051
|
-
:notification_channel
|
1125
|
+
:notification_channel,
|
1126
|
+
:output_config,
|
1127
|
+
:kms_key_id)
|
1052
1128
|
SENSITIVE = []
|
1053
1129
|
include Aws::Structure
|
1054
1130
|
end
|
@@ -1084,6 +1160,11 @@ module Aws::Textract
|
|
1084
1160
|
# sns_topic_arn: "SNSTopicArn", # required
|
1085
1161
|
# role_arn: "RoleArn", # required
|
1086
1162
|
# },
|
1163
|
+
# output_config: {
|
1164
|
+
# s3_bucket: "S3Bucket", # required
|
1165
|
+
# s3_prefix: "S3ObjectName",
|
1166
|
+
# },
|
1167
|
+
# kms_key_id: "KMSKeyId",
|
1087
1168
|
# }
|
1088
1169
|
#
|
1089
1170
|
# @!attribute [rw] document_location
|
@@ -1115,13 +1196,29 @@ module Aws::Textract
|
|
1115
1196
|
# the completion status of the operation to.
|
1116
1197
|
# @return [Types::NotificationChannel]
|
1117
1198
|
#
|
1199
|
+
# @!attribute [rw] output_config
|
1200
|
+
# Sets if the output will go to a customer defined bucket. By default
|
1201
|
+
# Amazon Textract will save the results internally to be accessed with
|
1202
|
+
# the GetDocumentTextDetection operation.
|
1203
|
+
# @return [Types::OutputConfig]
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] kms_key_id
|
1206
|
+
# The KMS key used to encrypt the inference results. This can be in
|
1207
|
+
# either Key ID or Key Alias format. When a KMS key is provided, the
|
1208
|
+
# KMS key will be used for server-side encryption of the objects in
|
1209
|
+
# the customer bucket. When this parameter is not enabled, the result
|
1210
|
+
# will be encrypted server side,using SSE-S3.
|
1211
|
+
# @return [String]
|
1212
|
+
#
|
1118
1213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetectionRequest AWS API Documentation
|
1119
1214
|
#
|
1120
1215
|
class StartDocumentTextDetectionRequest < Struct.new(
|
1121
1216
|
:document_location,
|
1122
1217
|
:client_request_token,
|
1123
1218
|
:job_tag,
|
1124
|
-
:notification_channel
|
1219
|
+
:notification_channel,
|
1220
|
+
:output_config,
|
1221
|
+
:kms_key_id)
|
1125
1222
|
SENSITIVE = []
|
1126
1223
|
include Aws::Structure
|
1127
1224
|
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.23.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-02-02 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
|