aws-sdk-textract 1.52.0 → 1.53.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-textract/client.rb +612 -7
- data/lib/aws-sdk-textract/client_api.rb +434 -0
- data/lib/aws-sdk-textract/endpoints.rb +168 -0
- data/lib/aws-sdk-textract/errors.rb +44 -0
- data/lib/aws-sdk-textract/plugins/endpoints.rb +24 -0
- data/lib/aws-sdk-textract/types.rb +875 -6
- data/lib/aws-sdk-textract.rb +1 -1
- metadata +2 -2
@@ -463,12 +463,9 @@ module Aws::Textract
|
|
463
463
|
# return information about the tables that are detected in the input
|
464
464
|
# document. Add FORMS to return detected form data. Add SIGNATURES to
|
465
465
|
# return the locations of detected signatures. Add LAYOUT to the list to
|
466
|
-
# return information about the layout of the document.
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# data, add SIGNATURES to either TABLES or FORMS. All lines and words
|
470
|
-
# detected in the document are included in the response (including text
|
471
|
-
# that isn't related to the value of `FeatureTypes`).
|
466
|
+
# return information about the layout of the document. All lines and
|
467
|
+
# words detected in the document are included in the response (including
|
468
|
+
# text that isn't related to the value of `FeatureTypes`).
|
472
469
|
#
|
473
470
|
# @option params [Types::HumanLoopConfig] :human_loop_config
|
474
471
|
# Sets the configuration for the human in the loop workflow for
|
@@ -478,6 +475,9 @@ module Aws::Textract
|
|
478
475
|
# Contains Queries and the alias for those Queries, as determined by the
|
479
476
|
# input.
|
480
477
|
#
|
478
|
+
# @option params [Types::AdaptersConfig] :adapters_config
|
479
|
+
# Specifies the adapter to be used when analyzing a document.
|
480
|
+
#
|
481
481
|
# @return [Types::AnalyzeDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
482
482
|
#
|
483
483
|
# * {Types::AnalyzeDocumentResponse#document_metadata #document_metadata} => Types::DocumentMetadata
|
@@ -513,6 +513,15 @@ module Aws::Textract
|
|
513
513
|
# },
|
514
514
|
# ],
|
515
515
|
# },
|
516
|
+
# adapters_config: {
|
517
|
+
# adapters: [ # required
|
518
|
+
# {
|
519
|
+
# adapter_id: "AdapterId", # required
|
520
|
+
# pages: ["AdapterPage"],
|
521
|
+
# version: "AdapterVersion", # required
|
522
|
+
# },
|
523
|
+
# ],
|
524
|
+
# },
|
516
525
|
# })
|
517
526
|
#
|
518
527
|
# @example Response structure
|
@@ -805,6 +814,221 @@ module Aws::Textract
|
|
805
814
|
req.send_request(options)
|
806
815
|
end
|
807
816
|
|
817
|
+
# Creates an adapter, which can be fine-tuned for enhanced performance
|
818
|
+
# on user provided documents. Takes an AdapterName and FeatureType.
|
819
|
+
# Currently the only supported feature type is `QUERIES`. You can also
|
820
|
+
# provide a Description, Tags, and a ClientRequestToken. You can choose
|
821
|
+
# whether or not the adapter should be AutoUpdated with the AutoUpdate
|
822
|
+
# argument. By default, AutoUpdate is set to DISABLED.
|
823
|
+
#
|
824
|
+
# @option params [required, String] :adapter_name
|
825
|
+
# The name to be assigned to the adapter being created.
|
826
|
+
#
|
827
|
+
# @option params [String] :client_request_token
|
828
|
+
# Idempotent token is used to recognize the request. If the same token
|
829
|
+
# is used with multiple CreateAdapter requests, the same session is
|
830
|
+
# returned. This token is employed to avoid unintentionally creating the
|
831
|
+
# same session multiple times.
|
832
|
+
#
|
833
|
+
# **A suitable default value is auto-generated.** You should normally
|
834
|
+
# not need to pass this option.**
|
835
|
+
#
|
836
|
+
# @option params [String] :description
|
837
|
+
# The description to be assigned to the adapter being created.
|
838
|
+
#
|
839
|
+
# @option params [required, Array<String>] :feature_types
|
840
|
+
# The type of feature that the adapter is being trained on. Currrenly,
|
841
|
+
# supported feature types are: `QUERIES`
|
842
|
+
#
|
843
|
+
# @option params [String] :auto_update
|
844
|
+
# Controls whether or not the adapter should automatically update.
|
845
|
+
#
|
846
|
+
# @option params [Hash<String,String>] :tags
|
847
|
+
# A list of tags to be added to the adapter.
|
848
|
+
#
|
849
|
+
# @return [Types::CreateAdapterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
850
|
+
#
|
851
|
+
# * {Types::CreateAdapterResponse#adapter_id #adapter_id} => String
|
852
|
+
#
|
853
|
+
# @example Request syntax with placeholder values
|
854
|
+
#
|
855
|
+
# resp = client.create_adapter({
|
856
|
+
# adapter_name: "AdapterName", # required
|
857
|
+
# client_request_token: "ClientRequestToken",
|
858
|
+
# description: "AdapterDescription",
|
859
|
+
# feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES, SIGNATURES, LAYOUT
|
860
|
+
# auto_update: "ENABLED", # accepts ENABLED, DISABLED
|
861
|
+
# tags: {
|
862
|
+
# "TagKey" => "TagValue",
|
863
|
+
# },
|
864
|
+
# })
|
865
|
+
#
|
866
|
+
# @example Response structure
|
867
|
+
#
|
868
|
+
# resp.adapter_id #=> String
|
869
|
+
#
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapter AWS API Documentation
|
871
|
+
#
|
872
|
+
# @overload create_adapter(params = {})
|
873
|
+
# @param [Hash] params ({})
|
874
|
+
def create_adapter(params = {}, options = {})
|
875
|
+
req = build_request(:create_adapter, params)
|
876
|
+
req.send_request(options)
|
877
|
+
end
|
878
|
+
|
879
|
+
# Creates a new version of an adapter. Operates on a provided AdapterId
|
880
|
+
# and a specified dataset provided via the DatasetConfig argument.
|
881
|
+
# Requires that you specify an Amazon S3 bucket with the OutputConfig
|
882
|
+
# argument. You can provide an optional KMSKeyId, an optional
|
883
|
+
# ClientRequestToken, and optional tags.
|
884
|
+
#
|
885
|
+
# @option params [required, String] :adapter_id
|
886
|
+
# A string containing a unique ID for the adapter that will receive a
|
887
|
+
# new version.
|
888
|
+
#
|
889
|
+
# @option params [String] :client_request_token
|
890
|
+
# Idempotent token is used to recognize the request. If the same token
|
891
|
+
# is used with multiple CreateAdapterVersion requests, the same session
|
892
|
+
# is returned. This token is employed to avoid unintentionally creating
|
893
|
+
# the same session multiple times.
|
894
|
+
#
|
895
|
+
# **A suitable default value is auto-generated.** You should normally
|
896
|
+
# not need to pass this option.**
|
897
|
+
#
|
898
|
+
# @option params [required, Types::AdapterVersionDatasetConfig] :dataset_config
|
899
|
+
# Specifies a dataset used to train a new adapter version. Takes a
|
900
|
+
# ManifestS3Object as the value.
|
901
|
+
#
|
902
|
+
# @option params [String] :kms_key_id
|
903
|
+
# The identifier for your AWS Key Management Service key (AWS KMS key).
|
904
|
+
# Used to encrypt your documents.
|
905
|
+
#
|
906
|
+
# @option params [required, Types::OutputConfig] :output_config
|
907
|
+
# Sets whether or not your output will go to a user created bucket. Used
|
908
|
+
# to set the name of the bucket, and the prefix on the output file.
|
909
|
+
#
|
910
|
+
# `OutputConfig` is an optional parameter which lets you adjust where
|
911
|
+
# your output will be placed. By default, Amazon Textract will store the
|
912
|
+
# results internally and can only be accessed by the Get API operations.
|
913
|
+
# With `OutputConfig` enabled, you can set the name of the bucket the
|
914
|
+
# output will be sent to the file prefix of the results where you can
|
915
|
+
# download your results. Additionally, you can set the `KMSKeyID`
|
916
|
+
# parameter to a customer master key (CMK) to encrypt your output.
|
917
|
+
# Without this parameter set Amazon Textract will encrypt server-side
|
918
|
+
# using the AWS managed CMK for Amazon S3.
|
919
|
+
#
|
920
|
+
# Decryption of Customer Content is necessary for processing of the
|
921
|
+
# documents by Amazon Textract. If your account is opted out under an AI
|
922
|
+
# services opt out policy then all unencrypted Customer Content is
|
923
|
+
# immediately and permanently deleted after the Customer Content has
|
924
|
+
# been processed by the service. No copy of of the output is retained by
|
925
|
+
# Amazon Textract. For information about how to opt out, see [ Managing
|
926
|
+
# AI services opt-out policy. ][1]
|
927
|
+
#
|
928
|
+
# For more information on data privacy, see the [Data Privacy FAQ][2].
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
|
933
|
+
# [2]: https://aws.amazon.com/compliance/data-privacy-faq/
|
934
|
+
#
|
935
|
+
# @option params [Hash<String,String>] :tags
|
936
|
+
# A set of tags (key-value pairs) that you want to attach to the adapter
|
937
|
+
# version.
|
938
|
+
#
|
939
|
+
# @return [Types::CreateAdapterVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
940
|
+
#
|
941
|
+
# * {Types::CreateAdapterVersionResponse#adapter_id #adapter_id} => String
|
942
|
+
# * {Types::CreateAdapterVersionResponse#adapter_version #adapter_version} => String
|
943
|
+
#
|
944
|
+
# @example Request syntax with placeholder values
|
945
|
+
#
|
946
|
+
# resp = client.create_adapter_version({
|
947
|
+
# adapter_id: "AdapterId", # required
|
948
|
+
# client_request_token: "ClientRequestToken",
|
949
|
+
# dataset_config: { # required
|
950
|
+
# manifest_s3_object: {
|
951
|
+
# bucket: "S3Bucket",
|
952
|
+
# name: "S3ObjectName",
|
953
|
+
# version: "S3ObjectVersion",
|
954
|
+
# },
|
955
|
+
# },
|
956
|
+
# kms_key_id: "KMSKeyId",
|
957
|
+
# output_config: { # required
|
958
|
+
# s3_bucket: "S3Bucket", # required
|
959
|
+
# s3_prefix: "S3ObjectName",
|
960
|
+
# },
|
961
|
+
# tags: {
|
962
|
+
# "TagKey" => "TagValue",
|
963
|
+
# },
|
964
|
+
# })
|
965
|
+
#
|
966
|
+
# @example Response structure
|
967
|
+
#
|
968
|
+
# resp.adapter_id #=> String
|
969
|
+
# resp.adapter_version #=> String
|
970
|
+
#
|
971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterVersion AWS API Documentation
|
972
|
+
#
|
973
|
+
# @overload create_adapter_version(params = {})
|
974
|
+
# @param [Hash] params ({})
|
975
|
+
def create_adapter_version(params = {}, options = {})
|
976
|
+
req = build_request(:create_adapter_version, params)
|
977
|
+
req.send_request(options)
|
978
|
+
end
|
979
|
+
|
980
|
+
# Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the
|
981
|
+
# adapter specified by the ID.
|
982
|
+
#
|
983
|
+
# @option params [required, String] :adapter_id
|
984
|
+
# A string containing a unique ID for the adapter to be deleted.
|
985
|
+
#
|
986
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
987
|
+
#
|
988
|
+
# @example Request syntax with placeholder values
|
989
|
+
#
|
990
|
+
# resp = client.delete_adapter({
|
991
|
+
# adapter_id: "AdapterId", # required
|
992
|
+
# })
|
993
|
+
#
|
994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapter AWS API Documentation
|
995
|
+
#
|
996
|
+
# @overload delete_adapter(params = {})
|
997
|
+
# @param [Hash] params ({})
|
998
|
+
def delete_adapter(params = {}, options = {})
|
999
|
+
req = build_request(:delete_adapter, params)
|
1000
|
+
req.send_request(options)
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# Deletes an Amazon Textract adapter version. Requires that you specify
|
1004
|
+
# both an AdapterId and a AdapterVersion. Deletes the adapter version
|
1005
|
+
# specified by the AdapterId and the AdapterVersion.
|
1006
|
+
#
|
1007
|
+
# @option params [required, String] :adapter_id
|
1008
|
+
# A string containing a unique ID for the adapter version that will be
|
1009
|
+
# deleted.
|
1010
|
+
#
|
1011
|
+
# @option params [required, String] :adapter_version
|
1012
|
+
# Specifies the adapter version to be deleted.
|
1013
|
+
#
|
1014
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1015
|
+
#
|
1016
|
+
# @example Request syntax with placeholder values
|
1017
|
+
#
|
1018
|
+
# resp = client.delete_adapter_version({
|
1019
|
+
# adapter_id: "AdapterId", # required
|
1020
|
+
# adapter_version: "AdapterVersion", # required
|
1021
|
+
# })
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterVersion AWS API Documentation
|
1024
|
+
#
|
1025
|
+
# @overload delete_adapter_version(params = {})
|
1026
|
+
# @param [Hash] params ({})
|
1027
|
+
def delete_adapter_version(params = {}, options = {})
|
1028
|
+
req = build_request(:delete_adapter_version, params)
|
1029
|
+
req.send_request(options)
|
1030
|
+
end
|
1031
|
+
|
808
1032
|
# Detects text in the input document. Amazon Textract can detect lines
|
809
1033
|
# of text and the words that make up a line of text. The input document
|
810
1034
|
# must be in one of the following image formats: JPEG, PNG, PDF, or
|
@@ -897,6 +1121,119 @@ module Aws::Textract
|
|
897
1121
|
req.send_request(options)
|
898
1122
|
end
|
899
1123
|
|
1124
|
+
# Gets configuration information for an adapter specified by an
|
1125
|
+
# AdapterId, returning information on AdapterName, Description,
|
1126
|
+
# CreationTime, AutoUpdate status, and FeatureTypes.
|
1127
|
+
#
|
1128
|
+
# @option params [required, String] :adapter_id
|
1129
|
+
# A string containing a unique ID for the adapter.
|
1130
|
+
#
|
1131
|
+
# @return [Types::GetAdapterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1132
|
+
#
|
1133
|
+
# * {Types::GetAdapterResponse#adapter_id #adapter_id} => String
|
1134
|
+
# * {Types::GetAdapterResponse#adapter_name #adapter_name} => String
|
1135
|
+
# * {Types::GetAdapterResponse#creation_time #creation_time} => Time
|
1136
|
+
# * {Types::GetAdapterResponse#description #description} => String
|
1137
|
+
# * {Types::GetAdapterResponse#feature_types #feature_types} => Array<String>
|
1138
|
+
# * {Types::GetAdapterResponse#auto_update #auto_update} => String
|
1139
|
+
# * {Types::GetAdapterResponse#tags #tags} => Hash<String,String>
|
1140
|
+
#
|
1141
|
+
# @example Request syntax with placeholder values
|
1142
|
+
#
|
1143
|
+
# resp = client.get_adapter({
|
1144
|
+
# adapter_id: "AdapterId", # required
|
1145
|
+
# })
|
1146
|
+
#
|
1147
|
+
# @example Response structure
|
1148
|
+
#
|
1149
|
+
# resp.adapter_id #=> String
|
1150
|
+
# resp.adapter_name #=> String
|
1151
|
+
# resp.creation_time #=> Time
|
1152
|
+
# resp.description #=> String
|
1153
|
+
# resp.feature_types #=> Array
|
1154
|
+
# resp.feature_types[0] #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
1155
|
+
# resp.auto_update #=> String, one of "ENABLED", "DISABLED"
|
1156
|
+
# resp.tags #=> Hash
|
1157
|
+
# resp.tags["TagKey"] #=> String
|
1158
|
+
#
|
1159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapter AWS API Documentation
|
1160
|
+
#
|
1161
|
+
# @overload get_adapter(params = {})
|
1162
|
+
# @param [Hash] params ({})
|
1163
|
+
def get_adapter(params = {}, options = {})
|
1164
|
+
req = build_request(:get_adapter, params)
|
1165
|
+
req.send_request(options)
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
# Gets configuration information for the specified adapter version,
|
1169
|
+
# including: AdapterId, AdapterVersion, FeatureTypes, Status,
|
1170
|
+
# StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and
|
1171
|
+
# EvaluationMetrics.
|
1172
|
+
#
|
1173
|
+
# @option params [required, String] :adapter_id
|
1174
|
+
# A string specifying a unique ID for the adapter version you want to
|
1175
|
+
# retrieve information for.
|
1176
|
+
#
|
1177
|
+
# @option params [required, String] :adapter_version
|
1178
|
+
# A string specifying the adapter version you want to retrieve
|
1179
|
+
# information for.
|
1180
|
+
#
|
1181
|
+
# @return [Types::GetAdapterVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1182
|
+
#
|
1183
|
+
# * {Types::GetAdapterVersionResponse#adapter_id #adapter_id} => String
|
1184
|
+
# * {Types::GetAdapterVersionResponse#adapter_version #adapter_version} => String
|
1185
|
+
# * {Types::GetAdapterVersionResponse#creation_time #creation_time} => Time
|
1186
|
+
# * {Types::GetAdapterVersionResponse#feature_types #feature_types} => Array<String>
|
1187
|
+
# * {Types::GetAdapterVersionResponse#status #status} => String
|
1188
|
+
# * {Types::GetAdapterVersionResponse#status_message #status_message} => String
|
1189
|
+
# * {Types::GetAdapterVersionResponse#dataset_config #dataset_config} => Types::AdapterVersionDatasetConfig
|
1190
|
+
# * {Types::GetAdapterVersionResponse#kms_key_id #kms_key_id} => String
|
1191
|
+
# * {Types::GetAdapterVersionResponse#output_config #output_config} => Types::OutputConfig
|
1192
|
+
# * {Types::GetAdapterVersionResponse#evaluation_metrics #evaluation_metrics} => Array<Types::AdapterVersionEvaluationMetric>
|
1193
|
+
# * {Types::GetAdapterVersionResponse#tags #tags} => Hash<String,String>
|
1194
|
+
#
|
1195
|
+
# @example Request syntax with placeholder values
|
1196
|
+
#
|
1197
|
+
# resp = client.get_adapter_version({
|
1198
|
+
# adapter_id: "AdapterId", # required
|
1199
|
+
# adapter_version: "AdapterVersion", # required
|
1200
|
+
# })
|
1201
|
+
#
|
1202
|
+
# @example Response structure
|
1203
|
+
#
|
1204
|
+
# resp.adapter_id #=> String
|
1205
|
+
# resp.adapter_version #=> String
|
1206
|
+
# resp.creation_time #=> Time
|
1207
|
+
# resp.feature_types #=> Array
|
1208
|
+
# resp.feature_types[0] #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
1209
|
+
# resp.status #=> String, one of "ACTIVE", "AT_RISK", "DEPRECATED", "CREATION_ERROR", "CREATION_IN_PROGRESS"
|
1210
|
+
# resp.status_message #=> String
|
1211
|
+
# resp.dataset_config.manifest_s3_object.bucket #=> String
|
1212
|
+
# resp.dataset_config.manifest_s3_object.name #=> String
|
1213
|
+
# resp.dataset_config.manifest_s3_object.version #=> String
|
1214
|
+
# resp.kms_key_id #=> String
|
1215
|
+
# resp.output_config.s3_bucket #=> String
|
1216
|
+
# resp.output_config.s3_prefix #=> String
|
1217
|
+
# resp.evaluation_metrics #=> Array
|
1218
|
+
# resp.evaluation_metrics[0].baseline.f1_score #=> Float
|
1219
|
+
# resp.evaluation_metrics[0].baseline.precision #=> Float
|
1220
|
+
# resp.evaluation_metrics[0].baseline.recall #=> Float
|
1221
|
+
# resp.evaluation_metrics[0].adapter_version.f1_score #=> Float
|
1222
|
+
# resp.evaluation_metrics[0].adapter_version.precision #=> Float
|
1223
|
+
# resp.evaluation_metrics[0].adapter_version.recall #=> Float
|
1224
|
+
# resp.evaluation_metrics[0].feature_type #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
1225
|
+
# resp.tags #=> Hash
|
1226
|
+
# resp.tags["TagKey"] #=> String
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapterVersion AWS API Documentation
|
1229
|
+
#
|
1230
|
+
# @overload get_adapter_version(params = {})
|
1231
|
+
# @param [Hash] params ({})
|
1232
|
+
def get_adapter_version(params = {}, options = {})
|
1233
|
+
req = build_request(:get_adapter_version, params)
|
1234
|
+
req.send_request(options)
|
1235
|
+
end
|
1236
|
+
|
900
1237
|
# Gets the results for an Amazon Textract asynchronous operation that
|
901
1238
|
# analyzes text in a document.
|
902
1239
|
#
|
@@ -1654,6 +1991,151 @@ module Aws::Textract
|
|
1654
1991
|
req.send_request(options)
|
1655
1992
|
end
|
1656
1993
|
|
1994
|
+
# List all version of an adapter that meet the specified filtration
|
1995
|
+
# criteria.
|
1996
|
+
#
|
1997
|
+
# @option params [String] :adapter_id
|
1998
|
+
# A string containing a unique ID for the adapter to match for when
|
1999
|
+
# listing adapter versions.
|
2000
|
+
#
|
2001
|
+
# @option params [Time,DateTime,Date,Integer,String] :after_creation_time
|
2002
|
+
# Specifies the lower bound for the ListAdapterVersions operation.
|
2003
|
+
# Ensures ListAdapterVersions returns only adapter versions created
|
2004
|
+
# after the specified creation time.
|
2005
|
+
#
|
2006
|
+
# @option params [Time,DateTime,Date,Integer,String] :before_creation_time
|
2007
|
+
# Specifies the upper bound for the ListAdapterVersions operation.
|
2008
|
+
# Ensures ListAdapterVersions returns only adapter versions created
|
2009
|
+
# after the specified creation time.
|
2010
|
+
#
|
2011
|
+
# @option params [Integer] :max_results
|
2012
|
+
# The maximum number of results to return when listing adapter versions.
|
2013
|
+
#
|
2014
|
+
# @option params [String] :next_token
|
2015
|
+
# Identifies the next page of results to return when listing adapter
|
2016
|
+
# versions.
|
2017
|
+
#
|
2018
|
+
# @return [Types::ListAdapterVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2019
|
+
#
|
2020
|
+
# * {Types::ListAdapterVersionsResponse#adapter_versions #adapter_versions} => Array<Types::AdapterVersionOverview>
|
2021
|
+
# * {Types::ListAdapterVersionsResponse#next_token #next_token} => String
|
2022
|
+
#
|
2023
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2024
|
+
#
|
2025
|
+
# @example Request syntax with placeholder values
|
2026
|
+
#
|
2027
|
+
# resp = client.list_adapter_versions({
|
2028
|
+
# adapter_id: "AdapterId",
|
2029
|
+
# after_creation_time: Time.now,
|
2030
|
+
# before_creation_time: Time.now,
|
2031
|
+
# max_results: 1,
|
2032
|
+
# next_token: "PaginationToken",
|
2033
|
+
# })
|
2034
|
+
#
|
2035
|
+
# @example Response structure
|
2036
|
+
#
|
2037
|
+
# resp.adapter_versions #=> Array
|
2038
|
+
# resp.adapter_versions[0].adapter_id #=> String
|
2039
|
+
# resp.adapter_versions[0].adapter_version #=> String
|
2040
|
+
# resp.adapter_versions[0].creation_time #=> Time
|
2041
|
+
# resp.adapter_versions[0].feature_types #=> Array
|
2042
|
+
# resp.adapter_versions[0].feature_types[0] #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
2043
|
+
# resp.adapter_versions[0].status #=> String, one of "ACTIVE", "AT_RISK", "DEPRECATED", "CREATION_ERROR", "CREATION_IN_PROGRESS"
|
2044
|
+
# resp.adapter_versions[0].status_message #=> String
|
2045
|
+
# resp.next_token #=> String
|
2046
|
+
#
|
2047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdapterVersions AWS API Documentation
|
2048
|
+
#
|
2049
|
+
# @overload list_adapter_versions(params = {})
|
2050
|
+
# @param [Hash] params ({})
|
2051
|
+
def list_adapter_versions(params = {}, options = {})
|
2052
|
+
req = build_request(:list_adapter_versions, params)
|
2053
|
+
req.send_request(options)
|
2054
|
+
end
|
2055
|
+
|
2056
|
+
# Lists all adapters that match the specified filtration criteria.
|
2057
|
+
#
|
2058
|
+
# @option params [Time,DateTime,Date,Integer,String] :after_creation_time
|
2059
|
+
# Specifies the lower bound for the ListAdapters operation. Ensures
|
2060
|
+
# ListAdapters returns only adapters created after the specified
|
2061
|
+
# creation time.
|
2062
|
+
#
|
2063
|
+
# @option params [Time,DateTime,Date,Integer,String] :before_creation_time
|
2064
|
+
# Specifies the upper bound for the ListAdapters operation. Ensures
|
2065
|
+
# ListAdapters returns only adapters created before the specified
|
2066
|
+
# creation time.
|
2067
|
+
#
|
2068
|
+
# @option params [Integer] :max_results
|
2069
|
+
# The maximum number of results to return when listing adapters.
|
2070
|
+
#
|
2071
|
+
# @option params [String] :next_token
|
2072
|
+
# Identifies the next page of results to return when listing adapters.
|
2073
|
+
#
|
2074
|
+
# @return [Types::ListAdaptersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2075
|
+
#
|
2076
|
+
# * {Types::ListAdaptersResponse#adapters #adapters} => Array<Types::AdapterOverview>
|
2077
|
+
# * {Types::ListAdaptersResponse#next_token #next_token} => String
|
2078
|
+
#
|
2079
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2080
|
+
#
|
2081
|
+
# @example Request syntax with placeholder values
|
2082
|
+
#
|
2083
|
+
# resp = client.list_adapters({
|
2084
|
+
# after_creation_time: Time.now,
|
2085
|
+
# before_creation_time: Time.now,
|
2086
|
+
# max_results: 1,
|
2087
|
+
# next_token: "PaginationToken",
|
2088
|
+
# })
|
2089
|
+
#
|
2090
|
+
# @example Response structure
|
2091
|
+
#
|
2092
|
+
# resp.adapters #=> Array
|
2093
|
+
# resp.adapters[0].adapter_id #=> String
|
2094
|
+
# resp.adapters[0].adapter_name #=> String
|
2095
|
+
# resp.adapters[0].creation_time #=> Time
|
2096
|
+
# resp.adapters[0].feature_types #=> Array
|
2097
|
+
# resp.adapters[0].feature_types[0] #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
2098
|
+
# resp.next_token #=> String
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdapters AWS API Documentation
|
2101
|
+
#
|
2102
|
+
# @overload list_adapters(params = {})
|
2103
|
+
# @param [Hash] params ({})
|
2104
|
+
def list_adapters(params = {}, options = {})
|
2105
|
+
req = build_request(:list_adapters, params)
|
2106
|
+
req.send_request(options)
|
2107
|
+
end
|
2108
|
+
|
2109
|
+
# Lists all tags for an Amazon Textract resource.
|
2110
|
+
#
|
2111
|
+
# @option params [required, String] :resource_arn
|
2112
|
+
# The Amazon Resource Name (ARN) that specifies the resource to list
|
2113
|
+
# tags for.
|
2114
|
+
#
|
2115
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2116
|
+
#
|
2117
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2118
|
+
#
|
2119
|
+
# @example Request syntax with placeholder values
|
2120
|
+
#
|
2121
|
+
# resp = client.list_tags_for_resource({
|
2122
|
+
# resource_arn: "AmazonResourceName", # required
|
2123
|
+
# })
|
2124
|
+
#
|
2125
|
+
# @example Response structure
|
2126
|
+
#
|
2127
|
+
# resp.tags #=> Hash
|
2128
|
+
# resp.tags["TagKey"] #=> String
|
2129
|
+
#
|
2130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListTagsForResource AWS API Documentation
|
2131
|
+
#
|
2132
|
+
# @overload list_tags_for_resource(params = {})
|
2133
|
+
# @param [Hash] params ({})
|
2134
|
+
def list_tags_for_resource(params = {}, options = {})
|
2135
|
+
req = build_request(:list_tags_for_resource, params)
|
2136
|
+
req.send_request(options)
|
2137
|
+
end
|
2138
|
+
|
1657
2139
|
# Starts the asynchronous analysis of an input document for
|
1658
2140
|
# relationships between detected items such as key-value pairs, tables,
|
1659
2141
|
# and selection elements.
|
@@ -1725,6 +2207,9 @@ module Aws::Textract
|
|
1725
2207
|
#
|
1726
2208
|
# @option params [Types::QueriesConfig] :queries_config
|
1727
2209
|
#
|
2210
|
+
# @option params [Types::AdaptersConfig] :adapters_config
|
2211
|
+
# Specifies the adapter to be used when analyzing a document.
|
2212
|
+
#
|
1728
2213
|
# @return [Types::StartDocumentAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1729
2214
|
#
|
1730
2215
|
# * {Types::StartDocumentAnalysisResponse#job_id #job_id} => String
|
@@ -1760,6 +2245,15 @@ module Aws::Textract
|
|
1760
2245
|
# },
|
1761
2246
|
# ],
|
1762
2247
|
# },
|
2248
|
+
# adapters_config: {
|
2249
|
+
# adapters: [ # required
|
2250
|
+
# {
|
2251
|
+
# adapter_id: "AdapterId", # required
|
2252
|
+
# pages: ["AdapterPage"],
|
2253
|
+
# version: "AdapterVersion", # required
|
2254
|
+
# },
|
2255
|
+
# ],
|
2256
|
+
# },
|
1763
2257
|
# })
|
1764
2258
|
#
|
1765
2259
|
# @example Response structure
|
@@ -2113,6 +2607,117 @@ module Aws::Textract
|
|
2113
2607
|
req.send_request(options)
|
2114
2608
|
end
|
2115
2609
|
|
2610
|
+
# Adds one or more tags to the specified resource.
|
2611
|
+
#
|
2612
|
+
# @option params [required, String] :resource_arn
|
2613
|
+
# The Amazon Resource Name (ARN) that specifies the resource to be
|
2614
|
+
# tagged.
|
2615
|
+
#
|
2616
|
+
# @option params [required, Hash<String,String>] :tags
|
2617
|
+
# A set of tags (key-value pairs) that you want to assign to the
|
2618
|
+
# resource.
|
2619
|
+
#
|
2620
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2621
|
+
#
|
2622
|
+
# @example Request syntax with placeholder values
|
2623
|
+
#
|
2624
|
+
# resp = client.tag_resource({
|
2625
|
+
# resource_arn: "AmazonResourceName", # required
|
2626
|
+
# tags: { # required
|
2627
|
+
# "TagKey" => "TagValue",
|
2628
|
+
# },
|
2629
|
+
# })
|
2630
|
+
#
|
2631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/TagResource AWS API Documentation
|
2632
|
+
#
|
2633
|
+
# @overload tag_resource(params = {})
|
2634
|
+
# @param [Hash] params ({})
|
2635
|
+
def tag_resource(params = {}, options = {})
|
2636
|
+
req = build_request(:tag_resource, params)
|
2637
|
+
req.send_request(options)
|
2638
|
+
end
|
2639
|
+
|
2640
|
+
# Removes any tags with the specified keys from the specified resource.
|
2641
|
+
#
|
2642
|
+
# @option params [required, String] :resource_arn
|
2643
|
+
# The Amazon Resource Name (ARN) that specifies the resource to be
|
2644
|
+
# untagged.
|
2645
|
+
#
|
2646
|
+
# @option params [required, Array<String>] :tag_keys
|
2647
|
+
# Specifies the tags to be removed from the resource specified by the
|
2648
|
+
# ResourceARN.
|
2649
|
+
#
|
2650
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2651
|
+
#
|
2652
|
+
# @example Request syntax with placeholder values
|
2653
|
+
#
|
2654
|
+
# resp = client.untag_resource({
|
2655
|
+
# resource_arn: "AmazonResourceName", # required
|
2656
|
+
# tag_keys: ["TagKey"], # required
|
2657
|
+
# })
|
2658
|
+
#
|
2659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UntagResource AWS API Documentation
|
2660
|
+
#
|
2661
|
+
# @overload untag_resource(params = {})
|
2662
|
+
# @param [Hash] params ({})
|
2663
|
+
def untag_resource(params = {}, options = {})
|
2664
|
+
req = build_request(:untag_resource, params)
|
2665
|
+
req.send_request(options)
|
2666
|
+
end
|
2667
|
+
|
2668
|
+
# Update the configuration for an adapter. FeatureTypes configurations
|
2669
|
+
# cannot be updated. At least one new parameter must be specified as an
|
2670
|
+
# argument.
|
2671
|
+
#
|
2672
|
+
# @option params [required, String] :adapter_id
|
2673
|
+
# A string containing a unique ID for the adapter that will be updated.
|
2674
|
+
#
|
2675
|
+
# @option params [String] :description
|
2676
|
+
# The new description to be applied to the adapter.
|
2677
|
+
#
|
2678
|
+
# @option params [String] :adapter_name
|
2679
|
+
# The new name to be applied to the adapter.
|
2680
|
+
#
|
2681
|
+
# @option params [String] :auto_update
|
2682
|
+
# The new auto-update status to be applied to the adapter.
|
2683
|
+
#
|
2684
|
+
# @return [Types::UpdateAdapterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2685
|
+
#
|
2686
|
+
# * {Types::UpdateAdapterResponse#adapter_id #adapter_id} => String
|
2687
|
+
# * {Types::UpdateAdapterResponse#adapter_name #adapter_name} => String
|
2688
|
+
# * {Types::UpdateAdapterResponse#creation_time #creation_time} => Time
|
2689
|
+
# * {Types::UpdateAdapterResponse#description #description} => String
|
2690
|
+
# * {Types::UpdateAdapterResponse#feature_types #feature_types} => Array<String>
|
2691
|
+
# * {Types::UpdateAdapterResponse#auto_update #auto_update} => String
|
2692
|
+
#
|
2693
|
+
# @example Request syntax with placeholder values
|
2694
|
+
#
|
2695
|
+
# resp = client.update_adapter({
|
2696
|
+
# adapter_id: "AdapterId", # required
|
2697
|
+
# description: "AdapterDescription",
|
2698
|
+
# adapter_name: "AdapterName",
|
2699
|
+
# auto_update: "ENABLED", # accepts ENABLED, DISABLED
|
2700
|
+
# })
|
2701
|
+
#
|
2702
|
+
# @example Response structure
|
2703
|
+
#
|
2704
|
+
# resp.adapter_id #=> String
|
2705
|
+
# resp.adapter_name #=> String
|
2706
|
+
# resp.creation_time #=> Time
|
2707
|
+
# resp.description #=> String
|
2708
|
+
# resp.feature_types #=> Array
|
2709
|
+
# resp.feature_types[0] #=> String, one of "TABLES", "FORMS", "QUERIES", "SIGNATURES", "LAYOUT"
|
2710
|
+
# resp.auto_update #=> String, one of "ENABLED", "DISABLED"
|
2711
|
+
#
|
2712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UpdateAdapter AWS API Documentation
|
2713
|
+
#
|
2714
|
+
# @overload update_adapter(params = {})
|
2715
|
+
# @param [Hash] params ({})
|
2716
|
+
def update_adapter(params = {}, options = {})
|
2717
|
+
req = build_request(:update_adapter, params)
|
2718
|
+
req.send_request(options)
|
2719
|
+
end
|
2720
|
+
|
2116
2721
|
# @!endgroup
|
2117
2722
|
|
2118
2723
|
# @param params ({})
|
@@ -2126,7 +2731,7 @@ module Aws::Textract
|
|
2126
2731
|
params: params,
|
2127
2732
|
config: config)
|
2128
2733
|
context[:gem_name] = 'aws-sdk-textract'
|
2129
|
-
context[:gem_version] = '1.
|
2734
|
+
context[:gem_version] = '1.53.0'
|
2130
2735
|
Seahorse::Client::Request.new(handlers, context)
|
2131
2736
|
end
|
2132
2737
|
|