aws-sdk-textract 1.52.0 → 1.53.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -17,6 +17,182 @@ module Aws::Textract
17
17
  #
18
18
  class AccessDeniedException < Aws::EmptyStructure; end
19
19
 
20
+ # An adapter selected for use when analyzing documents. Contains an
21
+ # adapter ID and a version number. Contains information on pages
22
+ # selected for analysis when analyzing documents asychronously.
23
+ #
24
+ # @!attribute [rw] adapter_id
25
+ # A unique identifier for the adapter resource.
26
+ # @return [String]
27
+ #
28
+ # @!attribute [rw] pages
29
+ # Pages is a parameter that the user inputs to specify which pages to
30
+ # apply an adapter to. The following is a list of rules for using this
31
+ # parameter.
32
+ #
33
+ # * If a page is not specified, it is set to `["1"]` by default.
34
+ #
35
+ # * The following characters are allowed in the parameter's string:
36
+ # `0 1 2 3 4 5 6 7 8 9 - *`. No whitespace is allowed.
37
+ #
38
+ # * When using * to indicate all pages, it must be the only element
39
+ # in the list.
40
+ #
41
+ # * You can use page intervals, such as `["1-3", "1-1", "4-*"]`. Where
42
+ # `*` indicates last page of document.
43
+ #
44
+ # * Specified pages must be greater than 0 and less than or equal to
45
+ # the number of pages in the document.
46
+ # @return [Array<String>]
47
+ #
48
+ # @!attribute [rw] version
49
+ # A string that identifies the version of the adapter.
50
+ # @return [String]
51
+ #
52
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/Adapter AWS API Documentation
53
+ #
54
+ class Adapter < Struct.new(
55
+ :adapter_id,
56
+ :pages,
57
+ :version)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # Contains information on the adapter, including the adapter ID, Name,
63
+ # Creation time, and feature types.
64
+ #
65
+ # @!attribute [rw] adapter_id
66
+ # A unique identifier for the adapter resource.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] adapter_name
70
+ # A string naming the adapter resource.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] creation_time
74
+ # The date and time that the adapter was created.
75
+ # @return [Time]
76
+ #
77
+ # @!attribute [rw] feature_types
78
+ # The feature types that the adapter is operating on.
79
+ # @return [Array<String>]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AdapterOverview AWS API Documentation
82
+ #
83
+ class AdapterOverview < Struct.new(
84
+ :adapter_id,
85
+ :adapter_name,
86
+ :creation_time,
87
+ :feature_types)
88
+ SENSITIVE = []
89
+ include Aws::Structure
90
+ end
91
+
92
+ # The dataset configuration options for a given version of an adapter.
93
+ # Can include an Amazon S3 bucket if specified.
94
+ #
95
+ # @!attribute [rw] manifest_s3_object
96
+ # The S3 bucket name and file name that identifies the document.
97
+ #
98
+ # The AWS Region for the S3 bucket that contains the document must
99
+ # match the Region that you use for Amazon Textract operations.
100
+ #
101
+ # For Amazon Textract to process a file in an S3 bucket, the user must
102
+ # have permission to access the S3 bucket and file.
103
+ # @return [Types::S3Object]
104
+ #
105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AdapterVersionDatasetConfig AWS API Documentation
106
+ #
107
+ class AdapterVersionDatasetConfig < Struct.new(
108
+ :manifest_s3_object)
109
+ SENSITIVE = []
110
+ include Aws::Structure
111
+ end
112
+
113
+ # Contains information on the metrics used to evalute the peformance of
114
+ # a given adapter version. Includes data for baseline model performance
115
+ # and individual adapter version perfromance.
116
+ #
117
+ # @!attribute [rw] baseline
118
+ # The F1 score, precision, and recall metrics for the baseline model.
119
+ # @return [Types::EvaluationMetric]
120
+ #
121
+ # @!attribute [rw] adapter_version
122
+ # The F1 score, precision, and recall metrics for the baseline model.
123
+ # @return [Types::EvaluationMetric]
124
+ #
125
+ # @!attribute [rw] feature_type
126
+ # Indicates the feature type being analyzed by a given adapter
127
+ # version.
128
+ # @return [String]
129
+ #
130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AdapterVersionEvaluationMetric AWS API Documentation
131
+ #
132
+ class AdapterVersionEvaluationMetric < Struct.new(
133
+ :baseline,
134
+ :adapter_version,
135
+ :feature_type)
136
+ SENSITIVE = []
137
+ include Aws::Structure
138
+ end
139
+
140
+ # Summary info for an adapter version. Contains information on the
141
+ # AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.
142
+ #
143
+ # @!attribute [rw] adapter_id
144
+ # A unique identifier for the adapter associated with a given adapter
145
+ # version.
146
+ # @return [String]
147
+ #
148
+ # @!attribute [rw] adapter_version
149
+ # An identified for a given adapter version.
150
+ # @return [String]
151
+ #
152
+ # @!attribute [rw] creation_time
153
+ # The date and time that a given adapter version was created.
154
+ # @return [Time]
155
+ #
156
+ # @!attribute [rw] feature_types
157
+ # The feature types that the adapter version is operating on.
158
+ # @return [Array<String>]
159
+ #
160
+ # @!attribute [rw] status
161
+ # Contains information on the status of a given adapter version.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] status_message
165
+ # A message explaining the status of a given adapter vesion.
166
+ # @return [String]
167
+ #
168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AdapterVersionOverview AWS API Documentation
169
+ #
170
+ class AdapterVersionOverview < Struct.new(
171
+ :adapter_id,
172
+ :adapter_version,
173
+ :creation_time,
174
+ :feature_types,
175
+ :status,
176
+ :status_message)
177
+ SENSITIVE = []
178
+ include Aws::Structure
179
+ end
180
+
181
+ # Contains information about adapters used when analyzing a document,
182
+ # with each adapter specified using an AdapterId and version
183
+ #
184
+ # @!attribute [rw] adapters
185
+ # A list of adapters to be used when analyzing the specified document.
186
+ # @return [Array<Types::Adapter>]
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AdaptersConfig AWS API Documentation
189
+ #
190
+ class AdaptersConfig < Struct.new(
191
+ :adapters)
192
+ SENSITIVE = []
193
+ include Aws::Structure
194
+ end
195
+
20
196
  # @!attribute [rw] document
21
197
  # The input document as base64-encoded bytes or an Amazon S3 object.
22
198
  # If you use the AWS CLI to call Amazon Textract operations, you
@@ -34,10 +210,7 @@ module Aws::Textract
34
210
  # input document. Add FORMS to return detected form data. Add
35
211
  # SIGNATURES to return the locations of detected signatures. Add
36
212
  # LAYOUT to the list to return information about the layout of the
37
- # document. To perform both forms and table analysis, add TABLES and
38
- # FORMS to `FeatureTypes`. To detect signatures within the document
39
- # and within form data and table data, add SIGNATURES to either TABLES
40
- # or FORMS. All lines and words detected in the document are included
213
+ # document. All lines and words detected in the document are included
41
214
  # in the response (including text that isn't related to the value of
42
215
  # `FeatureTypes`).
43
216
  # @return [Array<String>]
@@ -52,13 +225,18 @@ module Aws::Textract
52
225
  # the input.
53
226
  # @return [Types::QueriesConfig]
54
227
  #
228
+ # @!attribute [rw] adapters_config
229
+ # Specifies the adapter to be used when analyzing a document.
230
+ # @return [Types::AdaptersConfig]
231
+ #
55
232
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocumentRequest AWS API Documentation
56
233
  #
57
234
  class AnalyzeDocumentRequest < Struct.new(
58
235
  :document,
59
236
  :feature_types,
60
237
  :human_loop_config,
61
- :queries_config)
238
+ :queries_config,
239
+ :adapters_config)
62
240
  SENSITIVE = []
63
241
  include Aws::Structure
64
242
  end
@@ -297,6 +475,35 @@ module Aws::Textract
297
475
  # of analyze document. Comes with an alias and ID for ease of
298
476
  # locating in a response. Also contains location and confidence
299
477
  # score.
478
+ #
479
+ # The following BlockTypes are only returned for Amazon Textract
480
+ # Layout.
481
+ #
482
+ # * `LAYOUT_TITLE` - The main title of the document.
483
+ #
484
+ # * `LAYOUT_HEADER` - Text located in the top margin of the document.
485
+ #
486
+ # * `LAYOUT_FOOTER` - Text located in the bottom margin of the
487
+ # document.
488
+ #
489
+ # * `LAYOUT_SECTION_HEADER` - The titles of sections within a
490
+ # document.
491
+ #
492
+ # * `LAYOUT_PAGE_NUMBER` - The page number of the documents.
493
+ #
494
+ # * `LAYOUT_LIST` - Any information grouped together in list form.
495
+ #
496
+ # * `LAYOUT_FIGURE` - Indicates the location of an image in a
497
+ # document.
498
+ #
499
+ # * `LAYOUT_TABLE` - Indicates the location of a table in the
500
+ # document.
501
+ #
502
+ # * `LAYOUT_KEY_VALUE` - Indicates the location of form key-values in
503
+ # a document.
504
+ #
505
+ # * `LAYOUT_TEXT` - Text that is present typically as a part of
506
+ # paragraphs in documents.
300
507
  # @return [String]
301
508
  #
302
509
  # @!attribute [rw] confidence
@@ -479,6 +686,199 @@ module Aws::Textract
479
686
  include Aws::Structure
480
687
  end
481
688
 
689
+ # Updating or deleting a resource can cause an inconsistent state.
690
+ #
691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ConflictException AWS API Documentation
692
+ #
693
+ class ConflictException < Aws::EmptyStructure; end
694
+
695
+ # @!attribute [rw] adapter_name
696
+ # The name to be assigned to the adapter being created.
697
+ # @return [String]
698
+ #
699
+ # @!attribute [rw] client_request_token
700
+ # Idempotent token is used to recognize the request. If the same token
701
+ # is used with multiple CreateAdapter requests, the same session is
702
+ # returned. This token is employed to avoid unintentionally creating
703
+ # the same session multiple times.
704
+ #
705
+ # **A suitable default value is auto-generated.** You should normally
706
+ # not need to pass this option.
707
+ # @return [String]
708
+ #
709
+ # @!attribute [rw] description
710
+ # The description to be assigned to the adapter being created.
711
+ # @return [String]
712
+ #
713
+ # @!attribute [rw] feature_types
714
+ # The type of feature that the adapter is being trained on. Currrenly,
715
+ # supported feature types are: `QUERIES`
716
+ # @return [Array<String>]
717
+ #
718
+ # @!attribute [rw] auto_update
719
+ # Controls whether or not the adapter should automatically update.
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] tags
723
+ # A list of tags to be added to the adapter.
724
+ # @return [Hash<String,String>]
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterRequest AWS API Documentation
727
+ #
728
+ class CreateAdapterRequest < Struct.new(
729
+ :adapter_name,
730
+ :client_request_token,
731
+ :description,
732
+ :feature_types,
733
+ :auto_update,
734
+ :tags)
735
+ SENSITIVE = []
736
+ include Aws::Structure
737
+ end
738
+
739
+ # @!attribute [rw] adapter_id
740
+ # A string containing the unique ID for the adapter that has been
741
+ # created.
742
+ # @return [String]
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterResponse AWS API Documentation
745
+ #
746
+ class CreateAdapterResponse < Struct.new(
747
+ :adapter_id)
748
+ SENSITIVE = []
749
+ include Aws::Structure
750
+ end
751
+
752
+ # @!attribute [rw] adapter_id
753
+ # A string containing a unique ID for the adapter that will receive a
754
+ # new version.
755
+ # @return [String]
756
+ #
757
+ # @!attribute [rw] client_request_token
758
+ # Idempotent token is used to recognize the request. If the same token
759
+ # is used with multiple CreateAdapterVersion requests, the same
760
+ # session is returned. This token is employed to avoid unintentionally
761
+ # creating the same session multiple times.
762
+ #
763
+ # **A suitable default value is auto-generated.** You should normally
764
+ # not need to pass this option.
765
+ # @return [String]
766
+ #
767
+ # @!attribute [rw] dataset_config
768
+ # Specifies a dataset used to train a new adapter version. Takes a
769
+ # ManifestS3Object as the value.
770
+ # @return [Types::AdapterVersionDatasetConfig]
771
+ #
772
+ # @!attribute [rw] kms_key_id
773
+ # The identifier for your AWS Key Management Service key (AWS KMS
774
+ # key). Used to encrypt your documents.
775
+ # @return [String]
776
+ #
777
+ # @!attribute [rw] output_config
778
+ # Sets whether or not your output will go to a user created bucket.
779
+ # Used to set the name of the bucket, and the prefix on the output
780
+ # file.
781
+ #
782
+ # `OutputConfig` is an optional parameter which lets you adjust where
783
+ # your output will be placed. By default, Amazon Textract will store
784
+ # the results internally and can only be accessed by the Get API
785
+ # operations. With `OutputConfig` enabled, you can set the name of the
786
+ # bucket the output will be sent to the file prefix of the results
787
+ # where you can download your results. Additionally, you can set the
788
+ # `KMSKeyID` parameter to a customer master key (CMK) to encrypt your
789
+ # output. Without this parameter set Amazon Textract will encrypt
790
+ # server-side using the AWS managed CMK for Amazon S3.
791
+ #
792
+ # Decryption of Customer Content is necessary for processing of the
793
+ # documents by Amazon Textract. If your account is opted out under an
794
+ # AI services opt out policy then all unencrypted Customer Content is
795
+ # immediately and permanently deleted after the Customer Content has
796
+ # been processed by the service. No copy of of the output is retained
797
+ # by Amazon Textract. For information about how to opt out, see [
798
+ # Managing AI services opt-out policy. ][1]
799
+ #
800
+ # For more information on data privacy, see the [Data Privacy FAQ][2].
801
+ #
802
+ #
803
+ #
804
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
805
+ # [2]: https://aws.amazon.com/compliance/data-privacy-faq/
806
+ # @return [Types::OutputConfig]
807
+ #
808
+ # @!attribute [rw] tags
809
+ # A set of tags (key-value pairs) that you want to attach to the
810
+ # adapter version.
811
+ # @return [Hash<String,String>]
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterVersionRequest AWS API Documentation
814
+ #
815
+ class CreateAdapterVersionRequest < Struct.new(
816
+ :adapter_id,
817
+ :client_request_token,
818
+ :dataset_config,
819
+ :kms_key_id,
820
+ :output_config,
821
+ :tags)
822
+ SENSITIVE = []
823
+ include Aws::Structure
824
+ end
825
+
826
+ # @!attribute [rw] adapter_id
827
+ # A string containing the unique ID for the adapter that has received
828
+ # a new version.
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] adapter_version
832
+ # A string describing the new version of the adapter.
833
+ # @return [String]
834
+ #
835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapterVersionResponse AWS API Documentation
836
+ #
837
+ class CreateAdapterVersionResponse < Struct.new(
838
+ :adapter_id,
839
+ :adapter_version)
840
+ SENSITIVE = []
841
+ include Aws::Structure
842
+ end
843
+
844
+ # @!attribute [rw] adapter_id
845
+ # A string containing a unique ID for the adapter to be deleted.
846
+ # @return [String]
847
+ #
848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterRequest AWS API Documentation
849
+ #
850
+ class DeleteAdapterRequest < Struct.new(
851
+ :adapter_id)
852
+ SENSITIVE = []
853
+ include Aws::Structure
854
+ end
855
+
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterResponse AWS API Documentation
857
+ #
858
+ class DeleteAdapterResponse < Aws::EmptyStructure; end
859
+
860
+ # @!attribute [rw] adapter_id
861
+ # A string containing a unique ID for the adapter version that will be
862
+ # deleted.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] adapter_version
866
+ # Specifies the adapter version to be deleted.
867
+ # @return [String]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterVersionRequest AWS API Documentation
870
+ #
871
+ class DeleteAdapterVersionRequest < Struct.new(
872
+ :adapter_id,
873
+ :adapter_version)
874
+ SENSITIVE = []
875
+ include Aws::Structure
876
+ end
877
+
878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DeleteAdapterVersionResponse AWS API Documentation
879
+ #
880
+ class DeleteAdapterVersionResponse < Aws::EmptyStructure; end
881
+
482
882
  # @!attribute [rw] document
483
883
  # The input document as base64-encoded bytes or an Amazon S3 object.
484
884
  # If you use the AWS CLI to call Amazon Textract operations, you
@@ -659,6 +1059,31 @@ module Aws::Textract
659
1059
  #
660
1060
  class DocumentTooLargeException < Aws::EmptyStructure; end
661
1061
 
1062
+ # The evaluation metrics (F1 score, Precision, and Recall) for an
1063
+ # adapter version.
1064
+ #
1065
+ # @!attribute [rw] f1_score
1066
+ # The F1 score for an adapter version.
1067
+ # @return [Float]
1068
+ #
1069
+ # @!attribute [rw] precision
1070
+ # The Precision score for an adapter version.
1071
+ # @return [Float]
1072
+ #
1073
+ # @!attribute [rw] recall
1074
+ # The Recall score for an adapter version.
1075
+ # @return [Float]
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/EvaluationMetric AWS API Documentation
1078
+ #
1079
+ class EvaluationMetric < Struct.new(
1080
+ :f1_score,
1081
+ :precision,
1082
+ :recall)
1083
+ SENSITIVE = []
1084
+ include Aws::Structure
1085
+ end
1086
+
662
1087
  # Returns the kind of currency detected.
663
1088
  #
664
1089
  # @!attribute [rw] code
@@ -899,6 +1324,178 @@ module Aws::Textract
899
1324
  include Aws::Structure
900
1325
  end
901
1326
 
1327
+ # @!attribute [rw] adapter_id
1328
+ # A string containing a unique ID for the adapter.
1329
+ # @return [String]
1330
+ #
1331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapterRequest AWS API Documentation
1332
+ #
1333
+ class GetAdapterRequest < Struct.new(
1334
+ :adapter_id)
1335
+ SENSITIVE = []
1336
+ include Aws::Structure
1337
+ end
1338
+
1339
+ # @!attribute [rw] adapter_id
1340
+ # A string identifying the adapter that information has been retrieved
1341
+ # for.
1342
+ # @return [String]
1343
+ #
1344
+ # @!attribute [rw] adapter_name
1345
+ # The name of the requested adapter.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] creation_time
1349
+ # The date and time the requested adapter was created at.
1350
+ # @return [Time]
1351
+ #
1352
+ # @!attribute [rw] description
1353
+ # The description for the requested adapter.
1354
+ # @return [String]
1355
+ #
1356
+ # @!attribute [rw] feature_types
1357
+ # List of the targeted feature types for the requested adapter.
1358
+ # @return [Array<String>]
1359
+ #
1360
+ # @!attribute [rw] auto_update
1361
+ # Binary value indicating if the adapter is being automatically
1362
+ # updated or not.
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] tags
1366
+ # A set of tags (key-value pairs) associated with the adapter that has
1367
+ # been retrieved.
1368
+ # @return [Hash<String,String>]
1369
+ #
1370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapterResponse AWS API Documentation
1371
+ #
1372
+ class GetAdapterResponse < Struct.new(
1373
+ :adapter_id,
1374
+ :adapter_name,
1375
+ :creation_time,
1376
+ :description,
1377
+ :feature_types,
1378
+ :auto_update,
1379
+ :tags)
1380
+ SENSITIVE = []
1381
+ include Aws::Structure
1382
+ end
1383
+
1384
+ # @!attribute [rw] adapter_id
1385
+ # A string specifying a unique ID for the adapter version you want to
1386
+ # retrieve information for.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] adapter_version
1390
+ # A string specifying the adapter version you want to retrieve
1391
+ # information for.
1392
+ # @return [String]
1393
+ #
1394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapterVersionRequest AWS API Documentation
1395
+ #
1396
+ class GetAdapterVersionRequest < Struct.new(
1397
+ :adapter_id,
1398
+ :adapter_version)
1399
+ SENSITIVE = []
1400
+ include Aws::Structure
1401
+ end
1402
+
1403
+ # @!attribute [rw] adapter_id
1404
+ # A string containing a unique ID for the adapter version being
1405
+ # retrieved.
1406
+ # @return [String]
1407
+ #
1408
+ # @!attribute [rw] adapter_version
1409
+ # A string containing the adapter version that has been retrieved.
1410
+ # @return [String]
1411
+ #
1412
+ # @!attribute [rw] creation_time
1413
+ # The time that the adapter version was created.
1414
+ # @return [Time]
1415
+ #
1416
+ # @!attribute [rw] feature_types
1417
+ # List of the targeted feature types for the requested adapter
1418
+ # version.
1419
+ # @return [Array<String>]
1420
+ #
1421
+ # @!attribute [rw] status
1422
+ # The status of the adapter version that has been requested.
1423
+ # @return [String]
1424
+ #
1425
+ # @!attribute [rw] status_message
1426
+ # A message that describes the status of the requested adapter
1427
+ # version.
1428
+ # @return [String]
1429
+ #
1430
+ # @!attribute [rw] dataset_config
1431
+ # Specifies a dataset used to train a new adapter version. Takes a
1432
+ # ManifestS3Objec as the value.
1433
+ # @return [Types::AdapterVersionDatasetConfig]
1434
+ #
1435
+ # @!attribute [rw] kms_key_id
1436
+ # The identifier for your AWS Key Management Service key (AWS KMS
1437
+ # key). Used to encrypt your documents.
1438
+ # @return [String]
1439
+ #
1440
+ # @!attribute [rw] output_config
1441
+ # Sets whether or not your output will go to a user created bucket.
1442
+ # Used to set the name of the bucket, and the prefix on the output
1443
+ # file.
1444
+ #
1445
+ # `OutputConfig` is an optional parameter which lets you adjust where
1446
+ # your output will be placed. By default, Amazon Textract will store
1447
+ # the results internally and can only be accessed by the Get API
1448
+ # operations. With `OutputConfig` enabled, you can set the name of the
1449
+ # bucket the output will be sent to the file prefix of the results
1450
+ # where you can download your results. Additionally, you can set the
1451
+ # `KMSKeyID` parameter to a customer master key (CMK) to encrypt your
1452
+ # output. Without this parameter set Amazon Textract will encrypt
1453
+ # server-side using the AWS managed CMK for Amazon S3.
1454
+ #
1455
+ # Decryption of Customer Content is necessary for processing of the
1456
+ # documents by Amazon Textract. If your account is opted out under an
1457
+ # AI services opt out policy then all unencrypted Customer Content is
1458
+ # immediately and permanently deleted after the Customer Content has
1459
+ # been processed by the service. No copy of of the output is retained
1460
+ # by Amazon Textract. For information about how to opt out, see [
1461
+ # Managing AI services opt-out policy. ][1]
1462
+ #
1463
+ # For more information on data privacy, see the [Data Privacy FAQ][2].
1464
+ #
1465
+ #
1466
+ #
1467
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
1468
+ # [2]: https://aws.amazon.com/compliance/data-privacy-faq/
1469
+ # @return [Types::OutputConfig]
1470
+ #
1471
+ # @!attribute [rw] evaluation_metrics
1472
+ # The evaluation metrics (F1 score, Precision, and Recall) for the
1473
+ # requested version, grouped by baseline metrics and adapter version.
1474
+ # @return [Array<Types::AdapterVersionEvaluationMetric>]
1475
+ #
1476
+ # @!attribute [rw] tags
1477
+ # A set of tags (key-value pairs) that are associated with the adapter
1478
+ # version.
1479
+ # @return [Hash<String,String>]
1480
+ #
1481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetAdapterVersionResponse AWS API Documentation
1482
+ #
1483
+ class GetAdapterVersionResponse < Struct.new(
1484
+ :adapter_id,
1485
+ :adapter_version,
1486
+ :creation_time,
1487
+ :feature_types,
1488
+ :status,
1489
+ :status_message,
1490
+ :dataset_config,
1491
+ :kms_key_id,
1492
+ :output_config,
1493
+ :evaluation_metrics,
1494
+ :tags)
1495
+ SENSITIVE = []
1496
+ include Aws::Structure
1497
+ end
1498
+
902
1499
  # @!attribute [rw] job_id
903
1500
  # A unique identifier for the text-detection job. The `JobId` is
904
1501
  # returned from `StartDocumentAnalysis`. A `JobId` value is only valid
@@ -1628,6 +2225,139 @@ module Aws::Textract
1628
2225
  include Aws::Structure
1629
2226
  end
1630
2227
 
2228
+ # @!attribute [rw] adapter_id
2229
+ # A string containing a unique ID for the adapter to match for when
2230
+ # listing adapter versions.
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] after_creation_time
2234
+ # Specifies the lower bound for the ListAdapterVersions operation.
2235
+ # Ensures ListAdapterVersions returns only adapter versions created
2236
+ # after the specified creation time.
2237
+ # @return [Time]
2238
+ #
2239
+ # @!attribute [rw] before_creation_time
2240
+ # Specifies the upper bound for the ListAdapterVersions operation.
2241
+ # Ensures ListAdapterVersions returns only adapter versions created
2242
+ # after the specified creation time.
2243
+ # @return [Time]
2244
+ #
2245
+ # @!attribute [rw] max_results
2246
+ # The maximum number of results to return when listing adapter
2247
+ # versions.
2248
+ # @return [Integer]
2249
+ #
2250
+ # @!attribute [rw] next_token
2251
+ # Identifies the next page of results to return when listing adapter
2252
+ # versions.
2253
+ # @return [String]
2254
+ #
2255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdapterVersionsRequest AWS API Documentation
2256
+ #
2257
+ class ListAdapterVersionsRequest < Struct.new(
2258
+ :adapter_id,
2259
+ :after_creation_time,
2260
+ :before_creation_time,
2261
+ :max_results,
2262
+ :next_token)
2263
+ SENSITIVE = []
2264
+ include Aws::Structure
2265
+ end
2266
+
2267
+ # @!attribute [rw] adapter_versions
2268
+ # Adapter versions that match the filtering criteria specified when
2269
+ # calling ListAdapters.
2270
+ # @return [Array<Types::AdapterVersionOverview>]
2271
+ #
2272
+ # @!attribute [rw] next_token
2273
+ # Identifies the next page of results to return when listing adapter
2274
+ # versions.
2275
+ # @return [String]
2276
+ #
2277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdapterVersionsResponse AWS API Documentation
2278
+ #
2279
+ class ListAdapterVersionsResponse < Struct.new(
2280
+ :adapter_versions,
2281
+ :next_token)
2282
+ SENSITIVE = []
2283
+ include Aws::Structure
2284
+ end
2285
+
2286
+ # @!attribute [rw] after_creation_time
2287
+ # Specifies the lower bound for the ListAdapters operation. Ensures
2288
+ # ListAdapters returns only adapters created after the specified
2289
+ # creation time.
2290
+ # @return [Time]
2291
+ #
2292
+ # @!attribute [rw] before_creation_time
2293
+ # Specifies the upper bound for the ListAdapters operation. Ensures
2294
+ # ListAdapters returns only adapters created before the specified
2295
+ # creation time.
2296
+ # @return [Time]
2297
+ #
2298
+ # @!attribute [rw] max_results
2299
+ # The maximum number of results to return when listing adapters.
2300
+ # @return [Integer]
2301
+ #
2302
+ # @!attribute [rw] next_token
2303
+ # Identifies the next page of results to return when listing adapters.
2304
+ # @return [String]
2305
+ #
2306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdaptersRequest AWS API Documentation
2307
+ #
2308
+ class ListAdaptersRequest < Struct.new(
2309
+ :after_creation_time,
2310
+ :before_creation_time,
2311
+ :max_results,
2312
+ :next_token)
2313
+ SENSITIVE = []
2314
+ include Aws::Structure
2315
+ end
2316
+
2317
+ # @!attribute [rw] adapters
2318
+ # A list of adapters that matches the filtering criteria specified
2319
+ # when calling ListAdapters.
2320
+ # @return [Array<Types::AdapterOverview>]
2321
+ #
2322
+ # @!attribute [rw] next_token
2323
+ # Identifies the next page of results to return when listing adapters.
2324
+ # @return [String]
2325
+ #
2326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListAdaptersResponse AWS API Documentation
2327
+ #
2328
+ class ListAdaptersResponse < Struct.new(
2329
+ :adapters,
2330
+ :next_token)
2331
+ SENSITIVE = []
2332
+ include Aws::Structure
2333
+ end
2334
+
2335
+ # @!attribute [rw] resource_arn
2336
+ # The Amazon Resource Name (ARN) that specifies the resource to list
2337
+ # tags for.
2338
+ # @return [String]
2339
+ #
2340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListTagsForResourceRequest AWS API Documentation
2341
+ #
2342
+ class ListTagsForResourceRequest < Struct.new(
2343
+ :resource_arn)
2344
+ SENSITIVE = []
2345
+ include Aws::Structure
2346
+ end
2347
+
2348
+ # @!attribute [rw] tags
2349
+ # A set of tags (key-value pairs) that are part of the requested
2350
+ # resource.
2351
+ # @return [Hash<String,String>]
2352
+ #
2353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ListTagsForResourceResponse AWS API Documentation
2354
+ #
2355
+ class ListTagsForResourceResponse < Struct.new(
2356
+ :tags)
2357
+ SENSITIVE = []
2358
+ include Aws::Structure
2359
+ end
2360
+
1631
2361
  # Contains information relating to dates in a document, including the
1632
2362
  # type of value, and the value.
1633
2363
  #
@@ -1899,6 +2629,12 @@ module Aws::Textract
1899
2629
  include Aws::Structure
1900
2630
  end
1901
2631
 
2632
+ # Returned when an operation tried to access a nonexistent resource.
2633
+ #
2634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ResourceNotFoundException AWS API Documentation
2635
+ #
2636
+ class ResourceNotFoundException < Aws::EmptyStructure; end
2637
+
1902
2638
  # The S3 bucket name and file name that identifies the document.
1903
2639
  #
1904
2640
  # The AWS Region for the S3 bucket that contains the document must match
@@ -1933,6 +2669,13 @@ module Aws::Textract
1933
2669
  include Aws::Structure
1934
2670
  end
1935
2671
 
2672
+ # Returned when a request cannot be completed as it would exceed a
2673
+ # maximum service quota.
2674
+ #
2675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ServiceQuotaExceededException AWS API Documentation
2676
+ #
2677
+ class ServiceQuotaExceededException < Aws::EmptyStructure; end
2678
+
1936
2679
  # Information regarding a detected signature on a page.
1937
2680
  #
1938
2681
  # @!attribute [rw] confidence
@@ -2033,6 +2776,10 @@ module Aws::Textract
2033
2776
  # @!attribute [rw] queries_config
2034
2777
  # @return [Types::QueriesConfig]
2035
2778
  #
2779
+ # @!attribute [rw] adapters_config
2780
+ # Specifies the adapter to be used when analyzing a document.
2781
+ # @return [Types::AdaptersConfig]
2782
+ #
2036
2783
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartDocumentAnalysisRequest AWS API Documentation
2037
2784
  #
2038
2785
  class StartDocumentAnalysisRequest < Struct.new(
@@ -2043,7 +2790,8 @@ module Aws::Textract
2043
2790
  :notification_channel,
2044
2791
  :output_config,
2045
2792
  :kms_key_id,
2046
- :queries_config)
2793
+ :queries_config,
2794
+ :adapters_config)
2047
2795
  SENSITIVE = []
2048
2796
  include Aws::Structure
2049
2797
  end
@@ -2303,6 +3051,29 @@ module Aws::Textract
2303
3051
  include Aws::Structure
2304
3052
  end
2305
3053
 
3054
+ # @!attribute [rw] resource_arn
3055
+ # The Amazon Resource Name (ARN) that specifies the resource to be
3056
+ # tagged.
3057
+ # @return [String]
3058
+ #
3059
+ # @!attribute [rw] tags
3060
+ # A set of tags (key-value pairs) that you want to assign to the
3061
+ # resource.
3062
+ # @return [Hash<String,String>]
3063
+ #
3064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/TagResourceRequest AWS API Documentation
3065
+ #
3066
+ class TagResourceRequest < Struct.new(
3067
+ :resource_arn,
3068
+ :tags)
3069
+ SENSITIVE = []
3070
+ include Aws::Structure
3071
+ end
3072
+
3073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/TagResourceResponse AWS API Documentation
3074
+ #
3075
+ class TagResourceResponse < Aws::EmptyStructure; end
3076
+
2306
3077
  # Amazon Textract is temporarily unable to process the request. Try your
2307
3078
  # call again.
2308
3079
  #
@@ -2332,6 +3103,104 @@ module Aws::Textract
2332
3103
  #
2333
3104
  class UnsupportedDocumentException < Aws::EmptyStructure; end
2334
3105
 
3106
+ # @!attribute [rw] resource_arn
3107
+ # The Amazon Resource Name (ARN) that specifies the resource to be
3108
+ # untagged.
3109
+ # @return [String]
3110
+ #
3111
+ # @!attribute [rw] tag_keys
3112
+ # Specifies the tags to be removed from the resource specified by the
3113
+ # ResourceARN.
3114
+ # @return [Array<String>]
3115
+ #
3116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UntagResourceRequest AWS API Documentation
3117
+ #
3118
+ class UntagResourceRequest < Struct.new(
3119
+ :resource_arn,
3120
+ :tag_keys)
3121
+ SENSITIVE = []
3122
+ include Aws::Structure
3123
+ end
3124
+
3125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UntagResourceResponse AWS API Documentation
3126
+ #
3127
+ class UntagResourceResponse < Aws::EmptyStructure; end
3128
+
3129
+ # @!attribute [rw] adapter_id
3130
+ # A string containing a unique ID for the adapter that will be
3131
+ # updated.
3132
+ # @return [String]
3133
+ #
3134
+ # @!attribute [rw] description
3135
+ # The new description to be applied to the adapter.
3136
+ # @return [String]
3137
+ #
3138
+ # @!attribute [rw] adapter_name
3139
+ # The new name to be applied to the adapter.
3140
+ # @return [String]
3141
+ #
3142
+ # @!attribute [rw] auto_update
3143
+ # The new auto-update status to be applied to the adapter.
3144
+ # @return [String]
3145
+ #
3146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UpdateAdapterRequest AWS API Documentation
3147
+ #
3148
+ class UpdateAdapterRequest < Struct.new(
3149
+ :adapter_id,
3150
+ :description,
3151
+ :adapter_name,
3152
+ :auto_update)
3153
+ SENSITIVE = []
3154
+ include Aws::Structure
3155
+ end
3156
+
3157
+ # @!attribute [rw] adapter_id
3158
+ # A string containing a unique ID for the adapter that has been
3159
+ # updated.
3160
+ # @return [String]
3161
+ #
3162
+ # @!attribute [rw] adapter_name
3163
+ # A string containing the name of the adapter that has been updated.
3164
+ # @return [String]
3165
+ #
3166
+ # @!attribute [rw] creation_time
3167
+ # An object specifying the creation time of the the adapter that has
3168
+ # been updated.
3169
+ # @return [Time]
3170
+ #
3171
+ # @!attribute [rw] description
3172
+ # A string containing the description of the adapter that has been
3173
+ # updated.
3174
+ # @return [String]
3175
+ #
3176
+ # @!attribute [rw] feature_types
3177
+ # List of the targeted feature types for the updated adapter.
3178
+ # @return [Array<String>]
3179
+ #
3180
+ # @!attribute [rw] auto_update
3181
+ # The auto-update status of the adapter that has been updated.
3182
+ # @return [String]
3183
+ #
3184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UpdateAdapterResponse AWS API Documentation
3185
+ #
3186
+ class UpdateAdapterResponse < Struct.new(
3187
+ :adapter_id,
3188
+ :adapter_name,
3189
+ :creation_time,
3190
+ :description,
3191
+ :feature_types,
3192
+ :auto_update)
3193
+ SENSITIVE = []
3194
+ include Aws::Structure
3195
+ end
3196
+
3197
+ # Indicates that a request was not valid. Check request for proper
3198
+ # formatting.
3199
+ #
3200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/ValidationException AWS API Documentation
3201
+ #
3202
+ class ValidationException < Aws::EmptyStructure; end
3203
+
2335
3204
  # A warning about an issue that occurred during asynchronous text
2336
3205
  # analysis (StartDocumentAnalysis) or asynchronous document text
2337
3206
  # detection (StartDocumentTextDetection).