aws-sdk-textract 1.19.0 → 1.20.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 +1 -1
- data/lib/aws-sdk-textract/client.rb +23 -5
- data/lib/aws-sdk-textract/client_api.rb +9 -0
- data/lib/aws-sdk-textract/types.rb +73 -9
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4289bd12d1f34c6d4f650ef58e399a212c79e5c8d17c0fa1abe3af34cb89de0d
|
4
|
+
data.tar.gz: cec3926f93dc07aa2695437c7a4b4dc1d1286aa29913b3026e9398c94b5a2e2e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8eb9caa12f5fc731cb54a83ac2a4479ad58d912fc2f0058bc10b901a6469770f4584f1d525b4c95b82b4a2892292a7b93385a5fe683bf56bab20d0f35b6789f9
|
7
|
+
data.tar.gz: 00e51b875b400172b383b35a4cc7e442e5c4bc522203b5310692eaffe01b9165cac74531f09483019cf7a01864381e3c5118ce7d3d9cb2f2ec5f160fe32008c8
|
data/lib/aws-sdk-textract.rb
CHANGED
@@ -444,7 +444,7 @@ module Aws::Textract
|
|
444
444
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
445
445
|
# resp.blocks[0].id #=> String
|
446
446
|
# resp.blocks[0].relationships #=> Array
|
447
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
447
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
448
448
|
# resp.blocks[0].relationships[0].ids #=> Array
|
449
449
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
450
450
|
# resp.blocks[0].entity_types #=> Array
|
@@ -534,7 +534,7 @@ module Aws::Textract
|
|
534
534
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
535
535
|
# resp.blocks[0].id #=> String
|
536
536
|
# resp.blocks[0].relationships #=> Array
|
537
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
537
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
538
538
|
# resp.blocks[0].relationships[0].ids #=> Array
|
539
539
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
540
540
|
# resp.blocks[0].entity_types #=> Array
|
@@ -660,7 +660,7 @@ module Aws::Textract
|
|
660
660
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
661
661
|
# resp.blocks[0].id #=> String
|
662
662
|
# resp.blocks[0].relationships #=> Array
|
663
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
663
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
664
664
|
# resp.blocks[0].relationships[0].ids #=> Array
|
665
665
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
666
666
|
# resp.blocks[0].entity_types #=> Array
|
@@ -777,7 +777,7 @@ module Aws::Textract
|
|
777
777
|
# resp.blocks[0].geometry.polygon[0].y #=> Float
|
778
778
|
# resp.blocks[0].id #=> String
|
779
779
|
# resp.blocks[0].relationships #=> Array
|
780
|
-
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD"
|
780
|
+
# resp.blocks[0].relationships[0].type #=> String, one of "VALUE", "CHILD", "COMPLEX_FEATURES"
|
781
781
|
# resp.blocks[0].relationships[0].ids #=> Array
|
782
782
|
# resp.blocks[0].relationships[0].ids[0] #=> String
|
783
783
|
# resp.blocks[0].entity_types #=> Array
|
@@ -857,6 +857,11 @@ module Aws::Textract
|
|
857
857
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
858
858
|
# completion status of the operation to.
|
859
859
|
#
|
860
|
+
# @option params [Types::OutputConfig] :output_config
|
861
|
+
# Sets if the output will go to a customer defined bucket. By default,
|
862
|
+
# Amazon Textract will save the results internally to be accessed by the
|
863
|
+
# GetDocumentAnalysis operation.
|
864
|
+
#
|
860
865
|
# @return [Types::StartDocumentAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
861
866
|
#
|
862
867
|
# * {Types::StartDocumentAnalysisResponse#job_id #job_id} => String
|
@@ -878,6 +883,10 @@ module Aws::Textract
|
|
878
883
|
# sns_topic_arn: "SNSTopicArn", # required
|
879
884
|
# role_arn: "RoleArn", # required
|
880
885
|
# },
|
886
|
+
# output_config: {
|
887
|
+
# s3_bucket: "S3Bucket", # required
|
888
|
+
# s3_prefix: "S3ObjectName",
|
889
|
+
# },
|
881
890
|
# })
|
882
891
|
#
|
883
892
|
# @example Response structure
|
@@ -943,6 +952,11 @@ module Aws::Textract
|
|
943
952
|
# The Amazon SNS topic ARN that you want Amazon Textract to publish the
|
944
953
|
# completion status of the operation to.
|
945
954
|
#
|
955
|
+
# @option params [Types::OutputConfig] :output_config
|
956
|
+
# Sets if the output will go to a customer defined bucket. By default
|
957
|
+
# Amazon Textract will save the results internally to be accessed with
|
958
|
+
# the GetDocumentTextDetection operation.
|
959
|
+
#
|
946
960
|
# @return [Types::StartDocumentTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
947
961
|
#
|
948
962
|
# * {Types::StartDocumentTextDetectionResponse#job_id #job_id} => String
|
@@ -963,6 +977,10 @@ module Aws::Textract
|
|
963
977
|
# sns_topic_arn: "SNSTopicArn", # required
|
964
978
|
# role_arn: "RoleArn", # required
|
965
979
|
# },
|
980
|
+
# output_config: {
|
981
|
+
# s3_bucket: "S3Bucket", # required
|
982
|
+
# s3_prefix: "S3ObjectName",
|
983
|
+
# },
|
966
984
|
# })
|
967
985
|
#
|
968
986
|
# @example Response structure
|
@@ -991,7 +1009,7 @@ module Aws::Textract
|
|
991
1009
|
params: params,
|
992
1010
|
config: config)
|
993
1011
|
context[:gem_name] = 'aws-sdk-textract'
|
994
|
-
context[:gem_version] = '1.
|
1012
|
+
context[:gem_version] = '1.20.0'
|
995
1013
|
Seahorse::Client::Request.new(handlers, context)
|
996
1014
|
end
|
997
1015
|
|
@@ -65,6 +65,7 @@ module Aws::Textract
|
|
65
65
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
66
66
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
67
67
|
NotificationChannel = Shapes::StructureShape.new(name: 'NotificationChannel')
|
68
|
+
OutputConfig = Shapes::StructureShape.new(name: 'OutputConfig')
|
68
69
|
Pages = Shapes::ListShape.new(name: 'Pages')
|
69
70
|
PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
|
70
71
|
Percent = Shapes::FloatShape.new(name: 'Percent')
|
@@ -227,6 +228,10 @@ module Aws::Textract
|
|
227
228
|
NotificationChannel.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
228
229
|
NotificationChannel.struct_class = Types::NotificationChannel
|
229
230
|
|
231
|
+
OutputConfig.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3Bucket, required: true, location_name: "S3Bucket"))
|
232
|
+
OutputConfig.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectName, location_name: "S3Prefix"))
|
233
|
+
OutputConfig.struct_class = Types::OutputConfig
|
234
|
+
|
230
235
|
Pages.member = Shapes::ShapeRef.new(shape: UInteger)
|
231
236
|
|
232
237
|
Point.add_member(:x, Shapes::ShapeRef.new(shape: Float, location_name: "X"))
|
@@ -253,6 +258,7 @@ module Aws::Textract
|
|
253
258
|
StartDocumentAnalysisRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
254
259
|
StartDocumentAnalysisRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
255
260
|
StartDocumentAnalysisRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
261
|
+
StartDocumentAnalysisRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
256
262
|
StartDocumentAnalysisRequest.struct_class = Types::StartDocumentAnalysisRequest
|
257
263
|
|
258
264
|
StartDocumentAnalysisResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -262,6 +268,7 @@ module Aws::Textract
|
|
262
268
|
StartDocumentTextDetectionRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
|
263
269
|
StartDocumentTextDetectionRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
|
264
270
|
StartDocumentTextDetectionRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
|
271
|
+
StartDocumentTextDetectionRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "OutputConfig"))
|
265
272
|
StartDocumentTextDetectionRequest.struct_class = Types::StartDocumentTextDetectionRequest
|
266
273
|
|
267
274
|
StartDocumentTextDetectionResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
@@ -342,6 +349,7 @@ module Aws::Textract
|
|
342
349
|
o.errors << Shapes::ShapeRef.new(shape: InvalidJobIdException)
|
343
350
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
344
351
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
352
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
345
353
|
end)
|
346
354
|
|
347
355
|
api.add_operation(:get_document_text_detection, Seahorse::Model::Operation.new.tap do |o|
|
@@ -356,6 +364,7 @@ module Aws::Textract
|
|
356
364
|
o.errors << Shapes::ShapeRef.new(shape: InvalidJobIdException)
|
357
365
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
358
366
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
367
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
|
359
368
|
end)
|
360
369
|
|
361
370
|
api.add_operation(:start_document_analysis, Seahorse::Model::Operation.new.tap do |o|
|
@@ -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
|
#
|
@@ -579,7 +581,8 @@ module Aws::Textract
|
|
579
581
|
# @return [Array<Types::Warning>]
|
580
582
|
#
|
581
583
|
# @!attribute [rw] status_message
|
582
|
-
#
|
584
|
+
# Returns if the detection job could not be completed. Contains
|
585
|
+
# explanation for what error occured.
|
583
586
|
# @return [String]
|
584
587
|
#
|
585
588
|
# @!attribute [rw] analyze_document_model_version
|
@@ -664,8 +667,8 @@ module Aws::Textract
|
|
664
667
|
# @return [Array<Types::Warning>]
|
665
668
|
#
|
666
669
|
# @!attribute [rw] status_message
|
667
|
-
#
|
668
|
-
#
|
670
|
+
# Returns if the detection job could not be completed. Contains
|
671
|
+
# explanation for what error occured.
|
669
672
|
# @return [String]
|
670
673
|
#
|
671
674
|
# @!attribute [rw] detect_document_text_model_version
|
@@ -777,12 +780,15 @@ module Aws::Textract
|
|
777
780
|
# loop workflows available
|
778
781
|
#
|
779
782
|
# @!attribute [rw] resource_type
|
783
|
+
# The resource type.
|
780
784
|
# @return [String]
|
781
785
|
#
|
782
786
|
# @!attribute [rw] quota_code
|
787
|
+
# The quota code.
|
783
788
|
# @return [String]
|
784
789
|
#
|
785
790
|
# @!attribute [rw] service_code
|
791
|
+
# The service code.
|
786
792
|
# @return [String]
|
787
793
|
#
|
788
794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/HumanLoopQuotaExceededException AWS API Documentation
|
@@ -827,7 +833,13 @@ module Aws::Textract
|
|
827
833
|
class InvalidParameterException < Aws::EmptyStructure; end
|
828
834
|
|
829
835
|
# Amazon Textract is unable to access the S3 object that's specified in
|
830
|
-
# the request.
|
836
|
+
# the request. for more information, [Configure Access to Amazon S3][1]
|
837
|
+
# For troubleshooting information, see [Troubleshooting Amazon S3][2]
|
838
|
+
#
|
839
|
+
#
|
840
|
+
#
|
841
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
842
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html
|
831
843
|
#
|
832
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InvalidS3ObjectException AWS API Documentation
|
833
845
|
#
|
@@ -875,6 +887,35 @@ module Aws::Textract
|
|
875
887
|
include Aws::Structure
|
876
888
|
end
|
877
889
|
|
890
|
+
# Sets whether or not your output will go to a user created bucket. Used
|
891
|
+
# to set the name of the bucket, and the prefix on the output file.
|
892
|
+
#
|
893
|
+
# @note When making an API call, you may pass OutputConfig
|
894
|
+
# data as a hash:
|
895
|
+
#
|
896
|
+
# {
|
897
|
+
# s3_bucket: "S3Bucket", # required
|
898
|
+
# s3_prefix: "S3ObjectName",
|
899
|
+
# }
|
900
|
+
#
|
901
|
+
# @!attribute [rw] s3_bucket
|
902
|
+
# The name of the bucket your output will go to.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] s3_prefix
|
906
|
+
# The prefix of the object key that the output will be saved to. When
|
907
|
+
# not enabled, the prefix will be “textract\_output".
|
908
|
+
# @return [String]
|
909
|
+
#
|
910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/OutputConfig AWS API Documentation
|
911
|
+
#
|
912
|
+
class OutputConfig < Struct.new(
|
913
|
+
:s3_bucket,
|
914
|
+
:s3_prefix)
|
915
|
+
SENSITIVE = []
|
916
|
+
include Aws::Structure
|
917
|
+
end
|
918
|
+
|
878
919
|
# The X and Y coordinates of a point on a document page. The X and Y
|
879
920
|
# values that are returned are ratios of the overall document page size.
|
880
921
|
# For example, if the input document is 700 x 200 and the operation
|
@@ -923,7 +964,8 @@ module Aws::Textract
|
|
923
964
|
# relationship of type VALUE is a list that contains the ID of the
|
924
965
|
# VALUE block that's associated with the KEY of a key-value pair. A
|
925
966
|
# relationship of type CHILD is a list of IDs that identify WORD
|
926
|
-
# blocks
|
967
|
+
# blocks in the case of lines Cell blocks in the case of Tables, and
|
968
|
+
# WORD blocks in the case of Selection Elements.
|
927
969
|
# @return [String]
|
928
970
|
#
|
929
971
|
# @!attribute [rw] ids
|
@@ -1000,6 +1042,10 @@ module Aws::Textract
|
|
1000
1042
|
# sns_topic_arn: "SNSTopicArn", # required
|
1001
1043
|
# role_arn: "RoleArn", # required
|
1002
1044
|
# },
|
1045
|
+
# output_config: {
|
1046
|
+
# s3_bucket: "S3Bucket", # required
|
1047
|
+
# s3_prefix: "S3ObjectName",
|
1048
|
+
# },
|
1003
1049
|
# }
|
1004
1050
|
#
|
1005
1051
|
# @!attribute [rw] document_location
|
@@ -1041,6 +1087,12 @@ module Aws::Textract
|
|
1041
1087
|
# the completion status of the operation to.
|
1042
1088
|
# @return [Types::NotificationChannel]
|
1043
1089
|
#
|
1090
|
+
# @!attribute [rw] output_config
|
1091
|
+
# Sets if the output will go to a customer defined bucket. By default,
|
1092
|
+
# Amazon Textract will save the results internally to be accessed by
|
1093
|
+
# the GetDocumentAnalysis operation.
|
1094
|
+
# @return [Types::OutputConfig]
|
1095
|
+
#
|
1044
1096
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysisRequest AWS API Documentation
|
1045
1097
|
#
|
1046
1098
|
class StartDocumentAnalysisRequest < Struct.new(
|
@@ -1048,7 +1100,8 @@ module Aws::Textract
|
|
1048
1100
|
:feature_types,
|
1049
1101
|
:client_request_token,
|
1050
1102
|
:job_tag,
|
1051
|
-
:notification_channel
|
1103
|
+
:notification_channel,
|
1104
|
+
:output_config)
|
1052
1105
|
SENSITIVE = []
|
1053
1106
|
include Aws::Structure
|
1054
1107
|
end
|
@@ -1084,6 +1137,10 @@ module Aws::Textract
|
|
1084
1137
|
# sns_topic_arn: "SNSTopicArn", # required
|
1085
1138
|
# role_arn: "RoleArn", # required
|
1086
1139
|
# },
|
1140
|
+
# output_config: {
|
1141
|
+
# s3_bucket: "S3Bucket", # required
|
1142
|
+
# s3_prefix: "S3ObjectName",
|
1143
|
+
# },
|
1087
1144
|
# }
|
1088
1145
|
#
|
1089
1146
|
# @!attribute [rw] document_location
|
@@ -1115,13 +1172,20 @@ module Aws::Textract
|
|
1115
1172
|
# the completion status of the operation to.
|
1116
1173
|
# @return [Types::NotificationChannel]
|
1117
1174
|
#
|
1175
|
+
# @!attribute [rw] output_config
|
1176
|
+
# Sets if the output will go to a customer defined bucket. By default
|
1177
|
+
# Amazon Textract will save the results internally to be accessed with
|
1178
|
+
# the GetDocumentTextDetection operation.
|
1179
|
+
# @return [Types::OutputConfig]
|
1180
|
+
#
|
1118
1181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentTextDetectionRequest AWS API Documentation
|
1119
1182
|
#
|
1120
1183
|
class StartDocumentTextDetectionRequest < Struct.new(
|
1121
1184
|
:document_location,
|
1122
1185
|
:client_request_token,
|
1123
1186
|
:job_tag,
|
1124
|
-
:notification_channel
|
1187
|
+
:notification_channel,
|
1188
|
+
:output_config)
|
1125
1189
|
SENSITIVE = []
|
1126
1190
|
include Aws::Structure
|
1127
1191
|
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.20.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: 2020-09-
|
11
|
+
date: 2020-09-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|