aws-sdk-comprehend 1.63.0 → 1.64.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -14,18 +14,6 @@ module Aws::Comprehend
14
14
  # model. An augmented manifest file is a labeled dataset that is
15
15
  # produced by Amazon SageMaker Ground Truth.
16
16
  #
17
- # @note When making an API call, you may pass AugmentedManifestsListItem
18
- # data as a hash:
19
- #
20
- # {
21
- # s3_uri: "S3Uri", # required
22
- # split: "TRAIN", # accepts TRAIN, TEST
23
- # attribute_names: ["AttributeNamesListItem"], # required
24
- # annotation_data_s3_uri: "S3Uri",
25
- # source_documents_s3_uri: "S3Uri",
26
- # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
27
- # }
28
- #
29
17
  # @!attribute [rw] s3_uri
30
18
  # The Amazon S3 location of the augmented manifest file.
31
19
  # @return [String]
@@ -118,13 +106,6 @@ module Aws::Comprehend
118
106
  include Aws::Structure
119
107
  end
120
108
 
121
- # @note When making an API call, you may pass BatchDetectDominantLanguageRequest
122
- # data as a hash:
123
- #
124
- # {
125
- # text_list: ["CustomerInputString"], # required
126
- # }
127
- #
128
109
  # @!attribute [rw] text_list
129
110
  # A list containing the UTF-8 encoded text of the input documents. The
130
111
  # list can contain a maximum of 25 documents. Each document should
@@ -184,14 +165,6 @@ module Aws::Comprehend
184
165
  include Aws::Structure
185
166
  end
186
167
 
187
- # @note When making an API call, you may pass BatchDetectEntitiesRequest
188
- # data as a hash:
189
- #
190
- # {
191
- # text_list: ["CustomerInputString"], # required
192
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
193
- # }
194
- #
195
168
  # @!attribute [rw] text_list
196
169
  # A list containing the UTF-8 encoded text of the input documents. The
197
170
  # list can contain a maximum of 25 documents. The maximum size of each
@@ -257,14 +230,6 @@ module Aws::Comprehend
257
230
  include Aws::Structure
258
231
  end
259
232
 
260
- # @note When making an API call, you may pass BatchDetectKeyPhrasesRequest
261
- # data as a hash:
262
- #
263
- # {
264
- # text_list: ["CustomerInputString"], # required
265
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
266
- # }
267
- #
268
233
  # @!attribute [rw] text_list
269
234
  # A list containing the UTF-8 encoded text of the input documents. The
270
235
  # list can contain a maximum of 25 documents. The maximum size of each
@@ -335,14 +300,6 @@ module Aws::Comprehend
335
300
  include Aws::Structure
336
301
  end
337
302
 
338
- # @note When making an API call, you may pass BatchDetectSentimentRequest
339
- # data as a hash:
340
- #
341
- # {
342
- # text_list: ["CustomerInputString"], # required
343
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
344
- # }
345
- #
346
303
  # @!attribute [rw] text_list
347
304
  # A list containing the UTF-8 encoded text of the input documents. The
348
305
  # list can contain a maximum of 25 documents. The maximum size of each
@@ -414,14 +371,6 @@ module Aws::Comprehend
414
371
  include Aws::Structure
415
372
  end
416
373
 
417
- # @note When making an API call, you may pass BatchDetectSyntaxRequest
418
- # data as a hash:
419
- #
420
- # {
421
- # text_list: ["CustomerInputString"], # required
422
- # language_code: "en", # required, accepts en, es, fr, de, it, pt
423
- # }
424
- #
425
374
  # @!attribute [rw] text_list
426
375
  # A list containing the UTF-8 encoded text of the input documents. The
427
376
  # list can contain a maximum of 25 documents. The maximum size for
@@ -487,14 +436,6 @@ module Aws::Comprehend
487
436
  include Aws::Structure
488
437
  end
489
438
 
490
- # @note When making an API call, you may pass BatchDetectTargetedSentimentRequest
491
- # data as a hash:
492
- #
493
- # {
494
- # text_list: ["CustomerInputString"], # required
495
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
496
- # }
497
- #
498
439
  # @!attribute [rw] text_list
499
440
  # A list containing the UTF-8 encoded text of the input documents. The
500
441
  # list can contain a maximum of 25 documents. The maximum size of each
@@ -575,6 +516,157 @@ module Aws::Comprehend
575
516
  include Aws::Structure
576
517
  end
577
518
 
519
+ # Information about each word or line of text in the input document.
520
+ #
521
+ # For additional information, see [Block][1] in the Amazon Textract API
522
+ # reference.
523
+ #
524
+ #
525
+ #
526
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/API_Block.html
527
+ #
528
+ # @!attribute [rw] id
529
+ # Unique identifier for the block.
530
+ # @return [String]
531
+ #
532
+ # @!attribute [rw] block_type
533
+ # The block represents a line of text or one word of text.
534
+ #
535
+ # * WORD - A word that's detected on a document page. A word is one
536
+ # or more ISO basic Latin script characters that aren't separated
537
+ # by spaces.
538
+ #
539
+ # * LINE - A string of tab-delimited, contiguous words that are
540
+ # detected on a document page
541
+ # @return [String]
542
+ #
543
+ # @!attribute [rw] text
544
+ # The word or line of text extracted from the block.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] page
548
+ # Page number where the block appears.
549
+ # @return [Integer]
550
+ #
551
+ # @!attribute [rw] geometry
552
+ # Co-ordinates of the rectangle or polygon that contains the text.
553
+ # @return [Types::Geometry]
554
+ #
555
+ # @!attribute [rw] relationships
556
+ # A list of child blocks of the current block. For example, a LINE
557
+ # object has child blocks for each WORD block that's part of the line
558
+ # of text.
559
+ # @return [Array<Types::RelationshipsListItem>]
560
+ #
561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Block AWS API Documentation
562
+ #
563
+ class Block < Struct.new(
564
+ :id,
565
+ :block_type,
566
+ :text,
567
+ :page,
568
+ :geometry,
569
+ :relationships)
570
+ SENSITIVE = []
571
+ include Aws::Structure
572
+ end
573
+
574
+ # A reference to a block.
575
+ #
576
+ # @!attribute [rw] block_id
577
+ # Unique identifier for the block.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] begin_offset
581
+ # Offset of the start of the block within its parent block.
582
+ # @return [Integer]
583
+ #
584
+ # @!attribute [rw] end_offset
585
+ # Offset of the end of the block within its parent block.
586
+ # @return [Integer]
587
+ #
588
+ # @!attribute [rw] child_blocks
589
+ # List of child blocks within this block.
590
+ # @return [Array<Types::ChildBlock>]
591
+ #
592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BlockReference AWS API Documentation
593
+ #
594
+ class BlockReference < Struct.new(
595
+ :block_id,
596
+ :begin_offset,
597
+ :end_offset,
598
+ :child_blocks)
599
+ SENSITIVE = []
600
+ include Aws::Structure
601
+ end
602
+
603
+ # The bounding box around the detected page or around an element on a
604
+ # document page. The left (x-coordinate) and top (y-coordinate) are
605
+ # coordinates that represent the top and left sides of the bounding box.
606
+ # Note that the upper-left corner of the image is the origin (0,0).
607
+ #
608
+ # For additional information, see [BoundingBox][1] in the Amazon
609
+ # Textract API reference.
610
+ #
611
+ #
612
+ #
613
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html
614
+ #
615
+ # @!attribute [rw] height
616
+ # The height of the bounding box as a ratio of the overall document
617
+ # page height.
618
+ # @return [Float]
619
+ #
620
+ # @!attribute [rw] left
621
+ # The left coordinate of the bounding box as a ratio of overall
622
+ # document page width.
623
+ # @return [Float]
624
+ #
625
+ # @!attribute [rw] top
626
+ # The top coordinate of the bounding box as a ratio of overall
627
+ # document page height.
628
+ # @return [Float]
629
+ #
630
+ # @!attribute [rw] width
631
+ # The width of the bounding box as a ratio of the overall document
632
+ # page width.
633
+ # @return [Float]
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BoundingBox AWS API Documentation
636
+ #
637
+ class BoundingBox < Struct.new(
638
+ :height,
639
+ :left,
640
+ :top,
641
+ :width)
642
+ SENSITIVE = []
643
+ include Aws::Structure
644
+ end
645
+
646
+ # Nested block contained within a block.
647
+ #
648
+ # @!attribute [rw] child_block_id
649
+ # Unique identifier for the child block.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] begin_offset
653
+ # Offset of the start of the child block within its parent block.
654
+ # @return [Integer]
655
+ #
656
+ # @!attribute [rw] end_offset
657
+ # Offset of the end of the child block within its parent block.
658
+ # @return [Integer]
659
+ #
660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ChildBlock AWS API Documentation
661
+ #
662
+ class ChildBlock < Struct.new(
663
+ :child_block_id,
664
+ :begin_offset,
665
+ :end_offset)
666
+ SENSITIVE = []
667
+ include Aws::Structure
668
+ end
669
+
578
670
  # Describes the result metrics for the test data associated with an
579
671
  # documentation classifier.
580
672
  #
@@ -686,16 +778,9 @@ module Aws::Comprehend
686
778
  include Aws::Structure
687
779
  end
688
780
 
689
- # @note When making an API call, you may pass ClassifyDocumentRequest
690
- # data as a hash:
691
- #
692
- # {
693
- # text: "CustomerInputString", # required
694
- # endpoint_arn: "DocumentClassifierEndpointArn", # required
695
- # }
696
- #
697
781
  # @!attribute [rw] text
698
- # The document text to be analyzed.
782
+ # The document text to be analyzed. If you enter text using this
783
+ # parameter, do not use the `Bytes` parameter.
699
784
  # @return [String]
700
785
  #
701
786
  # @!attribute [rw] endpoint_arn
@@ -707,11 +792,38 @@ module Aws::Comprehend
707
792
  # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
708
793
  # @return [String]
709
794
  #
795
+ # @!attribute [rw] bytes
796
+ # Use the `Bytes` parameter to input a text, PDF, Word or image file.
797
+ # You can also use the `Bytes` parameter to input an Amazon Textract
798
+ # `DetectDocumentText` or `AnalyzeDocument` output file.
799
+ #
800
+ # Provide the input document as a sequence of base64-encoded bytes. If
801
+ # your code uses an Amazon Web Services SDK to classify documents, the
802
+ # SDK may encode the document file bytes for you.
803
+ #
804
+ # The maximum length of this field depends on the input document type.
805
+ # For details, see [ Inputs for real-time custom analysis][1] in the
806
+ # Comprehend Developer Guide.
807
+ #
808
+ # If you use the `Bytes` parameter, do not use the `Text` parameter.
809
+ #
810
+ #
811
+ #
812
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] document_reader_config
816
+ # Provides configuration parameters to override the default actions
817
+ # for extracting text from PDF documents and image files.
818
+ # @return [Types::DocumentReaderConfig]
819
+ #
710
820
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentRequest AWS API Documentation
711
821
  #
712
822
  class ClassifyDocumentRequest < Struct.new(
713
823
  :text,
714
- :endpoint_arn)
824
+ :endpoint_arn,
825
+ :bytes,
826
+ :document_reader_config)
715
827
  SENSITIVE = [:text]
716
828
  include Aws::Structure
717
829
  end
@@ -733,11 +845,31 @@ module Aws::Comprehend
733
845
  # at the same time.
734
846
  # @return [Array<Types::DocumentLabel>]
735
847
  #
848
+ # @!attribute [rw] document_metadata
849
+ # Extraction information about the document. This field is present in
850
+ # the response only if your request includes the `Byte` parameter.
851
+ # @return [Types::DocumentMetadata]
852
+ #
853
+ # @!attribute [rw] document_type
854
+ # The document type for each page in the input document. This field is
855
+ # present in the response only if your request includes the `Byte`
856
+ # parameter.
857
+ # @return [Array<Types::DocumentTypeListItem>]
858
+ #
859
+ # @!attribute [rw] errors
860
+ # Page-level errors that the system detected while processing the
861
+ # input document. The field is empty if the system encountered no
862
+ # errors.
863
+ # @return [Array<Types::ErrorsListItem>]
864
+ #
736
865
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentResponse AWS API Documentation
737
866
  #
738
867
  class ClassifyDocumentResponse < Struct.new(
739
868
  :classes,
740
- :labels)
869
+ :labels,
870
+ :document_metadata,
871
+ :document_type,
872
+ :errors)
741
873
  SENSITIVE = []
742
874
  include Aws::Structure
743
875
  end
@@ -756,14 +888,6 @@ module Aws::Comprehend
756
888
  include Aws::Structure
757
889
  end
758
890
 
759
- # @note When making an API call, you may pass ContainsPiiEntitiesRequest
760
- # data as a hash:
761
- #
762
- # {
763
- # text: "String", # required
764
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
765
- # }
766
- #
767
891
  # @!attribute [rw] text
768
892
  # A UTF-8 text string. The maximum string size is 100 KB.
769
893
  # @return [String]
@@ -795,51 +919,6 @@ module Aws::Comprehend
795
919
  include Aws::Structure
796
920
  end
797
921
 
798
- # @note When making an API call, you may pass CreateDocumentClassifierRequest
799
- # data as a hash:
800
- #
801
- # {
802
- # document_classifier_name: "ComprehendArnName", # required
803
- # version_name: "VersionName",
804
- # data_access_role_arn: "IamRoleArn", # required
805
- # tags: [
806
- # {
807
- # key: "TagKey", # required
808
- # value: "TagValue",
809
- # },
810
- # ],
811
- # input_data_config: { # required
812
- # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
813
- # s3_uri: "S3Uri",
814
- # test_s3_uri: "S3Uri",
815
- # label_delimiter: "LabelDelimiter",
816
- # augmented_manifests: [
817
- # {
818
- # s3_uri: "S3Uri", # required
819
- # split: "TRAIN", # accepts TRAIN, TEST
820
- # attribute_names: ["AttributeNamesListItem"], # required
821
- # annotation_data_s3_uri: "S3Uri",
822
- # source_documents_s3_uri: "S3Uri",
823
- # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
824
- # },
825
- # ],
826
- # },
827
- # output_data_config: {
828
- # s3_uri: "S3Uri",
829
- # kms_key_id: "KmsKeyId",
830
- # },
831
- # client_request_token: "ClientRequestTokenString",
832
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
833
- # volume_kms_key_id: "KmsKeyId",
834
- # vpc_config: {
835
- # security_group_ids: ["SecurityGroupId"], # required
836
- # subnets: ["SubnetId"], # required
837
- # },
838
- # mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
839
- # model_kms_key_id: "KmsKeyId",
840
- # model_policy: "Policy",
841
- # }
842
- #
843
922
  # @!attribute [rw] document_classifier_name
844
923
  # The name of the document classifier.
845
924
  # @return [String]
@@ -985,23 +1064,6 @@ module Aws::Comprehend
985
1064
  include Aws::Structure
986
1065
  end
987
1066
 
988
- # @note When making an API call, you may pass CreateEndpointRequest
989
- # data as a hash:
990
- #
991
- # {
992
- # endpoint_name: "ComprehendEndpointName", # required
993
- # model_arn: "ComprehendModelArn", # required
994
- # desired_inference_units: 1, # required
995
- # client_request_token: "ClientRequestTokenString",
996
- # tags: [
997
- # {
998
- # key: "TagKey", # required
999
- # value: "TagValue",
1000
- # },
1001
- # ],
1002
- # data_access_role_arn: "IamRoleArn",
1003
- # }
1004
- #
1005
1067
  # @!attribute [rw] endpoint_name
1006
1068
  # This is the descriptive suffix that becomes part of the
1007
1069
  # `EndpointArn` used for all subsequent requests to this resource.
@@ -1066,60 +1128,6 @@ module Aws::Comprehend
1066
1128
  include Aws::Structure
1067
1129
  end
1068
1130
 
1069
- # @note When making an API call, you may pass CreateEntityRecognizerRequest
1070
- # data as a hash:
1071
- #
1072
- # {
1073
- # recognizer_name: "ComprehendArnName", # required
1074
- # version_name: "VersionName",
1075
- # data_access_role_arn: "IamRoleArn", # required
1076
- # tags: [
1077
- # {
1078
- # key: "TagKey", # required
1079
- # value: "TagValue",
1080
- # },
1081
- # ],
1082
- # input_data_config: { # required
1083
- # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
1084
- # entity_types: [ # required
1085
- # {
1086
- # type: "EntityTypeName", # required
1087
- # },
1088
- # ],
1089
- # documents: {
1090
- # s3_uri: "S3Uri", # required
1091
- # test_s3_uri: "S3Uri",
1092
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1093
- # },
1094
- # annotations: {
1095
- # s3_uri: "S3Uri", # required
1096
- # test_s3_uri: "S3Uri",
1097
- # },
1098
- # entity_list: {
1099
- # s3_uri: "S3Uri", # required
1100
- # },
1101
- # augmented_manifests: [
1102
- # {
1103
- # s3_uri: "S3Uri", # required
1104
- # split: "TRAIN", # accepts TRAIN, TEST
1105
- # attribute_names: ["AttributeNamesListItem"], # required
1106
- # annotation_data_s3_uri: "S3Uri",
1107
- # source_documents_s3_uri: "S3Uri",
1108
- # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
1109
- # },
1110
- # ],
1111
- # },
1112
- # client_request_token: "ClientRequestTokenString",
1113
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1114
- # volume_kms_key_id: "KmsKeyId",
1115
- # vpc_config: {
1116
- # security_group_ids: ["SecurityGroupId"], # required
1117
- # subnets: ["SubnetId"], # required
1118
- # },
1119
- # model_kms_key_id: "KmsKeyId",
1120
- # model_policy: "Policy",
1121
- # }
1122
- #
1123
1131
  # @!attribute [rw] recognizer_name
1124
1132
  # The name given to the newly created recognizer. Recognizer names can
1125
1133
  # be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
@@ -1164,10 +1172,12 @@ module Aws::Comprehend
1164
1172
  # @return [String]
1165
1173
  #
1166
1174
  # @!attribute [rw] language_code
1167
- # You can specify any of the following languages supported by Amazon
1168
- # Comprehend: English ("en"), Spanish ("es"), French ("fr"),
1169
- # Italian ("it"), German ("de"), or Portuguese ("pt"). All
1170
- # documents must be in the same language.
1175
+ # You can specify any of the following languages: English ("en"),
1176
+ # Spanish ("es"), French ("fr"), Italian ("it"), German
1177
+ # ("de"), or Portuguese ("pt"). If you plan to use this entity
1178
+ # recognizer with PDF, Word, or image input files, you must specify
1179
+ # English as the language. All training documents must be in the same
1180
+ # language.
1171
1181
  # @return [String]
1172
1182
  #
1173
1183
  # @!attribute [rw] volume_kms_key_id
@@ -1253,13 +1263,6 @@ module Aws::Comprehend
1253
1263
  include Aws::Structure
1254
1264
  end
1255
1265
 
1256
- # @note When making an API call, you may pass DeleteDocumentClassifierRequest
1257
- # data as a hash:
1258
- #
1259
- # {
1260
- # document_classifier_arn: "DocumentClassifierArn", # required
1261
- # }
1262
- #
1263
1266
  # @!attribute [rw] document_classifier_arn
1264
1267
  # The Amazon Resource Name (ARN) that identifies the document
1265
1268
  # classifier.
@@ -1277,13 +1280,6 @@ module Aws::Comprehend
1277
1280
  #
1278
1281
  class DeleteDocumentClassifierResponse < Aws::EmptyStructure; end
1279
1282
 
1280
- # @note When making an API call, you may pass DeleteEndpointRequest
1281
- # data as a hash:
1282
- #
1283
- # {
1284
- # endpoint_arn: "ComprehendEndpointArn", # required
1285
- # }
1286
- #
1287
1283
  # @!attribute [rw] endpoint_arn
1288
1284
  # The Amazon Resource Number (ARN) of the endpoint being deleted.
1289
1285
  # @return [String]
@@ -1300,13 +1296,6 @@ module Aws::Comprehend
1300
1296
  #
1301
1297
  class DeleteEndpointResponse < Aws::EmptyStructure; end
1302
1298
 
1303
- # @note When making an API call, you may pass DeleteEntityRecognizerRequest
1304
- # data as a hash:
1305
- #
1306
- # {
1307
- # entity_recognizer_arn: "EntityRecognizerArn", # required
1308
- # }
1309
- #
1310
1299
  # @!attribute [rw] entity_recognizer_arn
1311
1300
  # The Amazon Resource Name (ARN) that identifies the entity
1312
1301
  # recognizer.
@@ -1324,14 +1313,6 @@ module Aws::Comprehend
1324
1313
  #
1325
1314
  class DeleteEntityRecognizerResponse < Aws::EmptyStructure; end
1326
1315
 
1327
- # @note When making an API call, you may pass DeleteResourcePolicyRequest
1328
- # data as a hash:
1329
- #
1330
- # {
1331
- # resource_arn: "ComprehendModelArn", # required
1332
- # policy_revision_id: "PolicyRevisionId",
1333
- # }
1334
- #
1335
1316
  # @!attribute [rw] resource_arn
1336
1317
  # The Amazon Resource Name (ARN) of the custom model version that has
1337
1318
  # the policy to delete.
@@ -1354,13 +1335,6 @@ module Aws::Comprehend
1354
1335
  #
1355
1336
  class DeleteResourcePolicyResponse < Aws::EmptyStructure; end
1356
1337
 
1357
- # @note When making an API call, you may pass DescribeDocumentClassificationJobRequest
1358
- # data as a hash:
1359
- #
1360
- # {
1361
- # job_id: "JobId", # required
1362
- # }
1363
- #
1364
1338
  # @!attribute [rw] job_id
1365
1339
  # The identifier that Amazon Comprehend generated for the job. The
1366
1340
  # operation returns this identifier in its response.
@@ -1387,13 +1361,6 @@ module Aws::Comprehend
1387
1361
  include Aws::Structure
1388
1362
  end
1389
1363
 
1390
- # @note When making an API call, you may pass DescribeDocumentClassifierRequest
1391
- # data as a hash:
1392
- #
1393
- # {
1394
- # document_classifier_arn: "DocumentClassifierArn", # required
1395
- # }
1396
- #
1397
1364
  # @!attribute [rw] document_classifier_arn
1398
1365
  # The Amazon Resource Name (ARN) that identifies the document
1399
1366
  # classifier. The operation returns this identifier in its response.
@@ -1420,13 +1387,6 @@ module Aws::Comprehend
1420
1387
  include Aws::Structure
1421
1388
  end
1422
1389
 
1423
- # @note When making an API call, you may pass DescribeDominantLanguageDetectionJobRequest
1424
- # data as a hash:
1425
- #
1426
- # {
1427
- # job_id: "JobId", # required
1428
- # }
1429
- #
1430
1390
  # @!attribute [rw] job_id
1431
1391
  # The identifier that Amazon Comprehend generated for the job. The
1432
1392
  # operation returns this identifier in its response.
@@ -1453,13 +1413,6 @@ module Aws::Comprehend
1453
1413
  include Aws::Structure
1454
1414
  end
1455
1415
 
1456
- # @note When making an API call, you may pass DescribeEndpointRequest
1457
- # data as a hash:
1458
- #
1459
- # {
1460
- # endpoint_arn: "ComprehendEndpointArn", # required
1461
- # }
1462
- #
1463
1416
  # @!attribute [rw] endpoint_arn
1464
1417
  # The Amazon Resource Number (ARN) of the endpoint being described.
1465
1418
  # @return [String]
@@ -1484,13 +1437,6 @@ module Aws::Comprehend
1484
1437
  include Aws::Structure
1485
1438
  end
1486
1439
 
1487
- # @note When making an API call, you may pass DescribeEntitiesDetectionJobRequest
1488
- # data as a hash:
1489
- #
1490
- # {
1491
- # job_id: "JobId", # required
1492
- # }
1493
- #
1494
1440
  # @!attribute [rw] job_id
1495
1441
  # The identifier that Amazon Comprehend generated for the job. The
1496
1442
  # operation returns this identifier in its response.
@@ -1517,13 +1463,6 @@ module Aws::Comprehend
1517
1463
  include Aws::Structure
1518
1464
  end
1519
1465
 
1520
- # @note When making an API call, you may pass DescribeEntityRecognizerRequest
1521
- # data as a hash:
1522
- #
1523
- # {
1524
- # entity_recognizer_arn: "EntityRecognizerArn", # required
1525
- # }
1526
- #
1527
1466
  # @!attribute [rw] entity_recognizer_arn
1528
1467
  # The Amazon Resource Name (ARN) that identifies the entity
1529
1468
  # recognizer.
@@ -1549,13 +1488,6 @@ module Aws::Comprehend
1549
1488
  include Aws::Structure
1550
1489
  end
1551
1490
 
1552
- # @note When making an API call, you may pass DescribeEventsDetectionJobRequest
1553
- # data as a hash:
1554
- #
1555
- # {
1556
- # job_id: "JobId", # required
1557
- # }
1558
- #
1559
1491
  # @!attribute [rw] job_id
1560
1492
  # The identifier of the events detection job.
1561
1493
  # @return [String]
@@ -1581,13 +1513,6 @@ module Aws::Comprehend
1581
1513
  include Aws::Structure
1582
1514
  end
1583
1515
 
1584
- # @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
1585
- # data as a hash:
1586
- #
1587
- # {
1588
- # job_id: "JobId", # required
1589
- # }
1590
- #
1591
1516
  # @!attribute [rw] job_id
1592
1517
  # The identifier that Amazon Comprehend generated for the job. The
1593
1518
  # operation returns this identifier in its response.
@@ -1614,13 +1539,6 @@ module Aws::Comprehend
1614
1539
  include Aws::Structure
1615
1540
  end
1616
1541
 
1617
- # @note When making an API call, you may pass DescribePiiEntitiesDetectionJobRequest
1618
- # data as a hash:
1619
- #
1620
- # {
1621
- # job_id: "JobId", # required
1622
- # }
1623
- #
1624
1542
  # @!attribute [rw] job_id
1625
1543
  # The identifier that Amazon Comprehend generated for the job. The
1626
1544
  # operation returns this identifier in its response.
@@ -1646,15 +1564,9 @@ module Aws::Comprehend
1646
1564
  include Aws::Structure
1647
1565
  end
1648
1566
 
1649
- # @note When making an API call, you may pass DescribeResourcePolicyRequest
1650
- # data as a hash:
1651
- #
1652
- # {
1653
- # resource_arn: "ComprehendModelArn", # required
1654
- # }
1655
- #
1656
1567
  # @!attribute [rw] resource_arn
1657
- # The Amazon Resource Name (ARN) of the policy to describe.
1568
+ # The Amazon Resource Name (ARN) of the custom model version that has
1569
+ # the resource policy.
1658
1570
  # @return [String]
1659
1571
  #
1660
1572
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicyRequest AWS API Documentation
@@ -1694,13 +1606,6 @@ module Aws::Comprehend
1694
1606
  include Aws::Structure
1695
1607
  end
1696
1608
 
1697
- # @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
1698
- # data as a hash:
1699
- #
1700
- # {
1701
- # job_id: "JobId", # required
1702
- # }
1703
- #
1704
1609
  # @!attribute [rw] job_id
1705
1610
  # The identifier that Amazon Comprehend generated for the job. The
1706
1611
  # operation returns this identifier in its response.
@@ -1727,13 +1632,6 @@ module Aws::Comprehend
1727
1632
  include Aws::Structure
1728
1633
  end
1729
1634
 
1730
- # @note When making an API call, you may pass DescribeTargetedSentimentDetectionJobRequest
1731
- # data as a hash:
1732
- #
1733
- # {
1734
- # job_id: "JobId", # required
1735
- # }
1736
- #
1737
1635
  # @!attribute [rw] job_id
1738
1636
  # The identifier that Amazon Comprehend generated for the job. The
1739
1637
  # operation returns this identifier in its response.
@@ -1760,13 +1658,6 @@ module Aws::Comprehend
1760
1658
  include Aws::Structure
1761
1659
  end
1762
1660
 
1763
- # @note When making an API call, you may pass DescribeTopicsDetectionJobRequest
1764
- # data as a hash:
1765
- #
1766
- # {
1767
- # job_id: "JobId", # required
1768
- # }
1769
- #
1770
1661
  # @!attribute [rw] job_id
1771
1662
  # The identifier assigned by the user to the detection job.
1772
1663
  # @return [String]
@@ -1791,13 +1682,6 @@ module Aws::Comprehend
1791
1682
  include Aws::Structure
1792
1683
  end
1793
1684
 
1794
- # @note When making an API call, you may pass DetectDominantLanguageRequest
1795
- # data as a hash:
1796
- #
1797
- # {
1798
- # text: "CustomerInputString", # required
1799
- # }
1800
- #
1801
1685
  # @!attribute [rw] text
1802
1686
  # A UTF-8 text string. The string must contain at least 20 characters.
1803
1687
  # The maximum string size is 100 KB.
@@ -1831,28 +1715,19 @@ module Aws::Comprehend
1831
1715
  include Aws::Structure
1832
1716
  end
1833
1717
 
1834
- # @note When making an API call, you may pass DetectEntitiesRequest
1835
- # data as a hash:
1836
- #
1837
- # {
1838
- # text: "CustomerInputString", # required
1839
- # language_code: "en", # accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1840
- # endpoint_arn: "EntityRecognizerEndpointArn",
1841
- # }
1842
- #
1843
1718
  # @!attribute [rw] text
1844
- # A UTF-8 text string. The maximum string size is 100 KB.
1719
+ # A UTF-8 text string. The maximum string size is 100 KB. If you enter
1720
+ # text using this parameter, do not use the `Bytes` parameter.
1845
1721
  # @return [String]
1846
1722
  #
1847
1723
  # @!attribute [rw] language_code
1848
1724
  # The language of the input documents. You can specify any of the
1849
- # primary languages supported by Amazon Comprehend. All documents must
1850
- # be in the same language.
1725
+ # primary languages supported by Amazon Comprehend. If your request
1726
+ # includes the endpoint for a custom entity recognition model, Amazon
1727
+ # Comprehend uses the language of your custom model, and it ignores
1728
+ # any language code that you specify here.
1851
1729
  #
1852
- # If your request includes the endpoint for a custom entity
1853
- # recognition model, Amazon Comprehend uses the language of your
1854
- # custom model, and it ignores any language code that you specify
1855
- # here.
1730
+ # All input documents must be in the same language.
1856
1731
  # @return [String]
1857
1732
  #
1858
1733
  # @!attribute [rw] endpoint_arn
@@ -1872,12 +1747,47 @@ module Aws::Comprehend
1872
1747
  # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
1873
1748
  # @return [String]
1874
1749
  #
1750
+ # @!attribute [rw] bytes
1751
+ # This field applies only when you use a custom entity recognition
1752
+ # model that was trained with PDF annotations. For other cases, enter
1753
+ # your text input in the `Text` field.
1754
+ #
1755
+ # Use the `Bytes` parameter to input a text, PDF, Word or image file.
1756
+ # Using a plain-text file in the `Bytes` parameter is equivelent to
1757
+ # using the `Text` parameter (the `Entities` field in the response is
1758
+ # identical).
1759
+ #
1760
+ # You can also use the `Bytes` parameter to input an Amazon Textract
1761
+ # `DetectDocumentText` or `AnalyzeDocument` output file.
1762
+ #
1763
+ # Provide the input document as a sequence of base64-encoded bytes. If
1764
+ # your code uses an Amazon Web Services SDK to detect entities, the
1765
+ # SDK may encode the document file bytes for you.
1766
+ #
1767
+ # The maximum length of this field depends on the input document type.
1768
+ # For details, see [ Inputs for real-time custom analysis][1] in the
1769
+ # Comprehend Developer Guide.
1770
+ #
1771
+ # If you use the `Bytes` parameter, do not use the `Text` parameter.
1772
+ #
1773
+ #
1774
+ #
1775
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
1776
+ # @return [String]
1777
+ #
1778
+ # @!attribute [rw] document_reader_config
1779
+ # Provides configuration parameters to override the default actions
1780
+ # for extracting text from PDF documents and image files.
1781
+ # @return [Types::DocumentReaderConfig]
1782
+ #
1875
1783
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
1876
1784
  #
1877
1785
  class DetectEntitiesRequest < Struct.new(
1878
1786
  :text,
1879
1787
  :language_code,
1880
- :endpoint_arn)
1788
+ :endpoint_arn,
1789
+ :bytes,
1790
+ :document_reader_config)
1881
1791
  SENSITIVE = [:text]
1882
1792
  include Aws::Structure
1883
1793
  end
@@ -1899,22 +1809,48 @@ module Aws::Comprehend
1899
1809
  # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
1900
1810
  # @return [Array<Types::Entity>]
1901
1811
  #
1812
+ # @!attribute [rw] document_metadata
1813
+ # Information about the document, discovered during text extraction.
1814
+ # This field is present in the response only if your request used the
1815
+ # `Byte` parameter.
1816
+ # @return [Types::DocumentMetadata]
1817
+ #
1818
+ # @!attribute [rw] document_type
1819
+ # The document type for each page in the input document. This field is
1820
+ # present in the response only if your request used the `Byte`
1821
+ # parameter.
1822
+ # @return [Array<Types::DocumentTypeListItem>]
1823
+ #
1824
+ # @!attribute [rw] blocks
1825
+ # Information about each block of text in the input document. Blocks
1826
+ # are nested. A page block contains a block for each line of text,
1827
+ # which contains a block for each word.
1828
+ #
1829
+ # The `Block` content for a Word input document does not include a
1830
+ # `Geometry` field.
1831
+ #
1832
+ # The `Block` field is not present in the response for plain-text
1833
+ # inputs.
1834
+ # @return [Array<Types::Block>]
1835
+ #
1836
+ # @!attribute [rw] errors
1837
+ # Page-level errors that the system detected while processing the
1838
+ # input document. The field is empty if the system encountered no
1839
+ # errors.
1840
+ # @return [Array<Types::ErrorsListItem>]
1841
+ #
1902
1842
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesResponse AWS API Documentation
1903
1843
  #
1904
1844
  class DetectEntitiesResponse < Struct.new(
1905
- :entities)
1845
+ :entities,
1846
+ :document_metadata,
1847
+ :document_type,
1848
+ :blocks,
1849
+ :errors)
1906
1850
  SENSITIVE = []
1907
1851
  include Aws::Structure
1908
1852
  end
1909
1853
 
1910
- # @note When making an API call, you may pass DetectKeyPhrasesRequest
1911
- # data as a hash:
1912
- #
1913
- # {
1914
- # text: "CustomerInputString", # required
1915
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1916
- # }
1917
- #
1918
1854
  # @!attribute [rw] text
1919
1855
  # A UTF-8 text string. The string must contain less than 100 KB of
1920
1856
  # UTF-8 encoded characters.
@@ -1951,14 +1887,6 @@ module Aws::Comprehend
1951
1887
  include Aws::Structure
1952
1888
  end
1953
1889
 
1954
- # @note When making an API call, you may pass DetectPiiEntitiesRequest
1955
- # data as a hash:
1956
- #
1957
- # {
1958
- # text: "String", # required
1959
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1960
- # }
1961
- #
1962
1890
  # @!attribute [rw] text
1963
1891
  # A UTF-8 text string. The maximum string size is 100 KB.
1964
1892
  # @return [String]
@@ -1992,14 +1920,6 @@ module Aws::Comprehend
1992
1920
  include Aws::Structure
1993
1921
  end
1994
1922
 
1995
- # @note When making an API call, you may pass DetectSentimentRequest
1996
- # data as a hash:
1997
- #
1998
- # {
1999
- # text: "CustomerInputString", # required
2000
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
2001
- # }
2002
- #
2003
1923
  # @!attribute [rw] text
2004
1924
  # A UTF-8 text string. The maximum string size is 5 KB.
2005
1925
  #
@@ -2044,14 +1964,6 @@ module Aws::Comprehend
2044
1964
  include Aws::Structure
2045
1965
  end
2046
1966
 
2047
- # @note When making an API call, you may pass DetectSyntaxRequest
2048
- # data as a hash:
2049
- #
2050
- # {
2051
- # text: "CustomerInputString", # required
2052
- # language_code: "en", # required, accepts en, es, fr, de, it, pt
2053
- # }
2054
- #
2055
1967
  # @!attribute [rw] text
2056
1968
  # A UTF-8 string. The maximum string size is 5 KB.
2057
1969
  # @return [String]
@@ -2092,14 +2004,6 @@ module Aws::Comprehend
2092
2004
  include Aws::Structure
2093
2005
  end
2094
2006
 
2095
- # @note When making an API call, you may pass DetectTargetedSentimentRequest
2096
- # data as a hash:
2097
- #
2098
- # {
2099
- # text: "CustomerInputString", # required
2100
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
2101
- # }
2102
- #
2103
2007
  # @!attribute [rw] text
2104
2008
  # A UTF-8 text string. The maximum string length is 5 KB.
2105
2009
  # @return [String]
@@ -2142,11 +2046,17 @@ module Aws::Comprehend
2142
2046
  # attributed.
2143
2047
  # @return [Float]
2144
2048
  #
2049
+ # @!attribute [rw] page
2050
+ # Page number in the input document. This field is present in the
2051
+ # response only if your request includes the `Byte` parameter.
2052
+ # @return [Integer]
2053
+ #
2145
2054
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClass AWS API Documentation
2146
2055
  #
2147
2056
  class DocumentClass < Struct.new(
2148
2057
  :name,
2149
- :score)
2058
+ :score,
2059
+ :page)
2150
2060
  SENSITIVE = []
2151
2061
  include Aws::Structure
2152
2062
  end
@@ -2155,16 +2065,6 @@ module Aws::Comprehend
2155
2065
  # jobs. For more information, see the operation. You can provide only
2156
2066
  # one filter parameter in each request.
2157
2067
  #
2158
- # @note When making an API call, you may pass DocumentClassificationJobFilter
2159
- # data as a hash:
2160
- #
2161
- # {
2162
- # job_name: "JobName",
2163
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
2164
- # submit_time_before: Time.now,
2165
- # submit_time_after: Time.now,
2166
- # }
2167
- #
2168
2068
  # @!attribute [rw] job_name
2169
2069
  # Filters on the name of the job.
2170
2070
  # @return [String]
@@ -2307,16 +2207,6 @@ module Aws::Comprehend
2307
2207
  # can only specify one filtering parameter in a request. For more
2308
2208
  # information, see the operation.
2309
2209
  #
2310
- # @note When making an API call, you may pass DocumentClassifierFilter
2311
- # data as a hash:
2312
- #
2313
- # {
2314
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
2315
- # document_classifier_name: "ComprehendArnName",
2316
- # submit_time_before: Time.now,
2317
- # submit_time_after: Time.now,
2318
- # }
2319
- #
2320
2210
  # @!attribute [rw] status
2321
2211
  # Filters the list of classifiers based on status.
2322
2212
  # @return [String]
@@ -2359,26 +2249,6 @@ module Aws::Comprehend
2359
2249
  #
2360
2250
  # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
2361
2251
  #
2362
- # @note When making an API call, you may pass DocumentClassifierInputDataConfig
2363
- # data as a hash:
2364
- #
2365
- # {
2366
- # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
2367
- # s3_uri: "S3Uri",
2368
- # test_s3_uri: "S3Uri",
2369
- # label_delimiter: "LabelDelimiter",
2370
- # augmented_manifests: [
2371
- # {
2372
- # s3_uri: "S3Uri", # required
2373
- # split: "TRAIN", # accepts TRAIN, TEST
2374
- # attribute_names: ["AttributeNamesListItem"], # required
2375
- # annotation_data_s3_uri: "S3Uri",
2376
- # source_documents_s3_uri: "S3Uri",
2377
- # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
2378
- # },
2379
- # ],
2380
- # }
2381
- #
2382
2252
  # @!attribute [rw] data_format
2383
2253
  # The format of your training data:
2384
2254
  #
@@ -2454,14 +2324,6 @@ module Aws::Comprehend
2454
2324
  # Provides output results configuration parameters for custom classifier
2455
2325
  # jobs.
2456
2326
  #
2457
- # @note When making an API call, you may pass DocumentClassifierOutputDataConfig
2458
- # data as a hash:
2459
- #
2460
- # {
2461
- # s3_uri: "S3Uri",
2462
- # kms_key_id: "KmsKeyId",
2463
- # }
2464
- #
2465
2327
  # @!attribute [rw] s3_uri
2466
2328
  # When you use the `OutputDataConfig` object while creating a custom
2467
2329
  # classifier, you specify the Amazon S3 location where you want to
@@ -2689,49 +2551,99 @@ module Aws::Comprehend
2689
2551
  # attributed.
2690
2552
  # @return [Float]
2691
2553
  #
2554
+ # @!attribute [rw] page
2555
+ # Page number where the label occurs. This field is present in the
2556
+ # response only if your request includes the `Byte` parameter.
2557
+ # @return [Integer]
2558
+ #
2692
2559
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentLabel AWS API Documentation
2693
2560
  #
2694
2561
  class DocumentLabel < Struct.new(
2695
2562
  :name,
2696
- :score)
2563
+ :score,
2564
+ :page)
2697
2565
  SENSITIVE = []
2698
2566
  include Aws::Structure
2699
2567
  end
2700
2568
 
2701
- # The input properties for a topic detection job.
2569
+ # Information about the document, discovered during text extraction.
2570
+ #
2571
+ # @!attribute [rw] pages
2572
+ # Number of pages in the document.
2573
+ # @return [Integer]
2574
+ #
2575
+ # @!attribute [rw] extracted_characters
2576
+ # List of pages in the document, with the number of characters
2577
+ # extracted from each page.
2578
+ # @return [Array<Types::ExtractedCharactersListItem>]
2579
+ #
2580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentMetadata AWS API Documentation
2581
+ #
2582
+ class DocumentMetadata < Struct.new(
2583
+ :pages,
2584
+ :extracted_characters)
2585
+ SENSITIVE = []
2586
+ include Aws::Structure
2587
+ end
2588
+
2589
+ # Provides configuration parameters to override the default actions for
2590
+ # extracting text from PDF documents and image files.
2591
+ #
2592
+ # By default, Amazon Comprehend performs the following actions to
2593
+ # extract text from files, based on the input file type:
2594
+ #
2595
+ # * **Word files** - Amazon Comprehend parser extracts the text.
2702
2596
  #
2703
- # @note When making an API call, you may pass DocumentReaderConfig
2704
- # data as a hash:
2597
+ # * **Digital PDF files** - Amazon Comprehend parser extracts the text.
2705
2598
  #
2706
- # {
2707
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
2708
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
2709
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
2710
- # }
2599
+ # * **Image files and scanned PDF files** - Amazon Comprehend uses the
2600
+ # Amazon Textract `DetectDocumentText` API to extract the text.
2601
+ #
2602
+ # `DocumentReaderConfig` does not apply to plain text files or Word
2603
+ # files.
2604
+ #
2605
+ # For image files and PDF documents, you can override these default
2606
+ # actions using the fields listed below. For more information, see [
2607
+ # Setting text extraction options][1].
2608
+ #
2609
+ #
2610
+ #
2611
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf
2711
2612
  #
2712
2613
  # @!attribute [rw] document_read_action
2713
- # This enum field will start with two values which will apply to PDFs:
2614
+ # This field defines the Amazon Textract API operation that Amazon
2615
+ # Comprehend uses to extract text from PDF files and image files.
2616
+ # Enter one of the following values:
2714
2617
  #
2715
- # * `TEXTRACT_DETECT_DOCUMENT_TEXT` - The service calls
2716
- # DetectDocumentText for PDF documents per page.
2618
+ # * `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service
2619
+ # uses the `DetectDocumentText` API operation.
2717
2620
  #
2718
- # * `TEXTRACT_ANALYZE_DOCUMENT` - The service calls AnalyzeDocument
2719
- # for PDF documents per page.
2621
+ # * `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses
2622
+ # the `AnalyzeDocument` API operation.
2720
2623
  # @return [String]
2721
2624
  #
2722
2625
  # @!attribute [rw] document_read_mode
2723
- # This enum field provides two values:
2626
+ # Determines the text extraction actions for PDF files. Enter one of
2627
+ # the following values:
2724
2628
  #
2725
- # * `SERVICE_DEFAULT` - use service defaults for Document reading. For
2726
- # Digital PDF it would mean using an internal parser instead of
2727
- # Textract APIs
2629
+ # * `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for
2630
+ # PDF files.
2728
2631
  #
2729
- # * `FORCE_DOCUMENT_READ_ACTION` - Always use specified action for
2730
- # DocumentReadAction, including Digital PDF.
2632
+ # * `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract
2633
+ # API specified by DocumentReadAction for all PDF files, including
2634
+ # digital PDF files.
2731
2635
  # @return [String]
2732
2636
  #
2733
2637
  # @!attribute [rw] feature_types
2734
- # Specifies how the text in an input file should be processed:
2638
+ # Specifies the type of Amazon Textract features to apply. If you
2639
+ # chose `TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must
2640
+ # specify one or both of the following values:
2641
+ #
2642
+ # * `TABLES` - Returns information about any tables that are detected
2643
+ # in the input document.
2644
+ #
2645
+ # * `FORMS` - Returns information and the data from any forms that are
2646
+ # detected in the input document.
2735
2647
  # @return [Array<String>]
2736
2648
  #
2737
2649
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentReaderConfig AWS API Documentation
@@ -2744,6 +2656,25 @@ module Aws::Comprehend
2744
2656
  include Aws::Structure
2745
2657
  end
2746
2658
 
2659
+ # Document type for each page in the document.
2660
+ #
2661
+ # @!attribute [rw] page
2662
+ # Page number.
2663
+ # @return [Integer]
2664
+ #
2665
+ # @!attribute [rw] type
2666
+ # Document type.
2667
+ # @return [String]
2668
+ #
2669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentTypeListItem AWS API Documentation
2670
+ #
2671
+ class DocumentTypeListItem < Struct.new(
2672
+ :page,
2673
+ :type)
2674
+ SENSITIVE = []
2675
+ include Aws::Structure
2676
+ end
2677
+
2747
2678
  # Returns the code for the dominant language in the input text and the
2748
2679
  # level of confidence that Amazon Comprehend has in the accuracy of the
2749
2680
  # detection.
@@ -2775,16 +2706,6 @@ module Aws::Comprehend
2775
2706
  # Provides information for filtering a list of dominant language
2776
2707
  # detection jobs. For more information, see the operation.
2777
2708
  #
2778
- # @note When making an API call, you may pass DominantLanguageDetectionJobFilter
2779
- # data as a hash:
2780
- #
2781
- # {
2782
- # job_name: "JobName",
2783
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
2784
- # submit_time_before: Time.now,
2785
- # submit_time_after: Time.now,
2786
- # }
2787
- #
2788
2709
  # @!attribute [rw] job_name
2789
2710
  # Filters on the name of the job.
2790
2711
  # @return [String]
@@ -2921,16 +2842,6 @@ module Aws::Comprehend
2921
2842
  # filter jobs on their name, model, status, or the date and time that
2922
2843
  # they were created. You can only set one filter at a time.
2923
2844
  #
2924
- # @note When making an API call, you may pass EndpointFilter
2925
- # data as a hash:
2926
- #
2927
- # {
2928
- # model_arn: "ComprehendModelArn",
2929
- # status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
2930
- # creation_time_before: Time.now,
2931
- # creation_time_after: Time.now,
2932
- # }
2933
- #
2934
2845
  # @!attribute [rw] model_arn
2935
2846
  # The Amazon Resource Number (ARN) of the model to which the endpoint
2936
2847
  # is attached.
@@ -3046,16 +2957,6 @@ module Aws::Comprehend
3046
2957
  # Provides information for filtering a list of dominant language
3047
2958
  # detection jobs. For more information, see the operation.
3048
2959
  #
3049
- # @note When making an API call, you may pass EntitiesDetectionJobFilter
3050
- # data as a hash:
3051
- #
3052
- # {
3053
- # job_name: "JobName",
3054
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3055
- # submit_time_before: Time.now,
3056
- # submit_time_after: Time.now,
3057
- # }
3058
- #
3059
2960
  # @!attribute [rw] job_name
3060
2961
  # Filters on the name of the job.
3061
2962
  # @return [String]
@@ -3206,7 +3107,11 @@ module Aws::Comprehend
3206
3107
  # @return [Float]
3207
3108
  #
3208
3109
  # @!attribute [rw] type
3209
- # The entity's type.
3110
+ # The entity type. For entity detection using the built-in model, this
3111
+ # field contains one of the standard entity types listed below.
3112
+ #
3113
+ # For custom entity detection, this field contains one of the entity
3114
+ # types that you specified when you trained your custom model.
3210
3115
  # @return [String]
3211
3116
  #
3212
3117
  # @!attribute [rw] text
@@ -3216,13 +3121,22 @@ module Aws::Comprehend
3216
3121
  # @!attribute [rw] begin_offset
3217
3122
  # The zero-based offset from the beginning of the source text to the
3218
3123
  # first character in the entity.
3124
+ #
3125
+ # This field is empty for non-text input.
3219
3126
  # @return [Integer]
3220
3127
  #
3221
3128
  # @!attribute [rw] end_offset
3222
3129
  # The zero-based offset from the beginning of the source text to the
3223
3130
  # last character in the entity.
3131
+ #
3132
+ # This field is empty for non-text input.
3224
3133
  # @return [Integer]
3225
3134
  #
3135
+ # @!attribute [rw] block_references
3136
+ # A reference to each block for this entity. This field is empty for
3137
+ # plain-text input.
3138
+ # @return [Array<Types::BlockReference>]
3139
+ #
3226
3140
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Entity AWS API Documentation
3227
3141
  #
3228
3142
  class Entity < Struct.new(
@@ -3230,7 +3144,8 @@ module Aws::Comprehend
3230
3144
  :type,
3231
3145
  :text,
3232
3146
  :begin_offset,
3233
- :end_offset)
3147
+ :end_offset,
3148
+ :block_references)
3234
3149
  SENSITIVE = []
3235
3150
  include Aws::Structure
3236
3151
  end
@@ -3258,14 +3173,6 @@ module Aws::Comprehend
3258
3173
 
3259
3174
  # Describes the annotations associated with a entity recognizer.
3260
3175
  #
3261
- # @note When making an API call, you may pass EntityRecognizerAnnotations
3262
- # data as a hash:
3263
- #
3264
- # {
3265
- # s3_uri: "S3Uri", # required
3266
- # test_s3_uri: "S3Uri",
3267
- # }
3268
- #
3269
3176
  # @!attribute [rw] s3_uri
3270
3177
  # Specifies the Amazon S3 location where the annotations for an entity
3271
3178
  # recognizer are located. The URI must be in the same region as the
@@ -3289,15 +3196,6 @@ module Aws::Comprehend
3289
3196
 
3290
3197
  # Describes the training documents submitted with an entity recognizer.
3291
3198
  #
3292
- # @note When making an API call, you may pass EntityRecognizerDocuments
3293
- # data as a hash:
3294
- #
3295
- # {
3296
- # s3_uri: "S3Uri", # required
3297
- # test_s3_uri: "S3Uri",
3298
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
3299
- # }
3300
- #
3301
3199
  # @!attribute [rw] s3_uri
3302
3200
  # Specifies the Amazon S3 location where the training documents for an
3303
3201
  # entity recognizer are located. The URI must be in the same region as
@@ -3332,13 +3230,6 @@ module Aws::Comprehend
3332
3230
 
3333
3231
  # Describes the entity recognizer submitted with an entity recognizer.
3334
3232
  #
3335
- # @note When making an API call, you may pass EntityRecognizerEntityList
3336
- # data as a hash:
3337
- #
3338
- # {
3339
- # s3_uri: "S3Uri", # required
3340
- # }
3341
- #
3342
3233
  # @!attribute [rw] s3_uri
3343
3234
  # Specifies the Amazon S3 location where the entity list is located.
3344
3235
  # The URI must be in the same region as the API endpoint that you are
@@ -3390,16 +3281,6 @@ module Aws::Comprehend
3390
3281
  # can only specify one filtering parameter in a request. For more
3391
3282
  # information, see the operation./&gt;
3392
3283
  #
3393
- # @note When making an API call, you may pass EntityRecognizerFilter
3394
- # data as a hash:
3395
- #
3396
- # {
3397
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
3398
- # recognizer_name: "ComprehendArnName",
3399
- # submit_time_before: Time.now,
3400
- # submit_time_after: Time.now,
3401
- # }
3402
- #
3403
3284
  # @!attribute [rw] status
3404
3285
  # The status of an entity recognizer.
3405
3286
  # @return [String]
@@ -3435,40 +3316,6 @@ module Aws::Comprehend
3435
3316
 
3436
3317
  # Specifies the format and location of the input data.
3437
3318
  #
3438
- # @note When making an API call, you may pass EntityRecognizerInputDataConfig
3439
- # data as a hash:
3440
- #
3441
- # {
3442
- # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
3443
- # entity_types: [ # required
3444
- # {
3445
- # type: "EntityTypeName", # required
3446
- # },
3447
- # ],
3448
- # documents: {
3449
- # s3_uri: "S3Uri", # required
3450
- # test_s3_uri: "S3Uri",
3451
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
3452
- # },
3453
- # annotations: {
3454
- # s3_uri: "S3Uri", # required
3455
- # test_s3_uri: "S3Uri",
3456
- # },
3457
- # entity_list: {
3458
- # s3_uri: "S3Uri", # required
3459
- # },
3460
- # augmented_manifests: [
3461
- # {
3462
- # s3_uri: "S3Uri", # required
3463
- # split: "TRAIN", # accepts TRAIN, TEST
3464
- # attribute_names: ["AttributeNamesListItem"], # required
3465
- # annotation_data_s3_uri: "S3Uri",
3466
- # source_documents_s3_uri: "S3Uri",
3467
- # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
3468
- # },
3469
- # ],
3470
- # }
3471
- #
3472
3319
  # @!attribute [rw] data_format
3473
3320
  # The format of your training data:
3474
3321
  #
@@ -3797,13 +3644,6 @@ module Aws::Comprehend
3797
3644
  # An entity type within a labeled training dataset that Amazon
3798
3645
  # Comprehend uses to train a custom entity recognizer.
3799
3646
  #
3800
- # @note When making an API call, you may pass EntityTypesListItem
3801
- # data as a hash:
3802
- #
3803
- # {
3804
- # type: "EntityTypeName", # required
3805
- # }
3806
- #
3807
3647
  # @!attribute [rw] type
3808
3648
  # An entity type within a labeled training dataset that Amazon
3809
3649
  # Comprehend uses to train a custom entity recognizer.
@@ -3822,17 +3662,56 @@ module Aws::Comprehend
3822
3662
  include Aws::Structure
3823
3663
  end
3824
3664
 
3825
- # Provides information for filtering a list of event detection jobs.
3665
+ # Text extraction encountered one or more page-level errors in the input
3666
+ # document.
3667
+ #
3668
+ # The `ErrorCode` contains one of the following values:
3669
+ #
3670
+ # * TEXTRACT\_BAD\_PAGE - Amazon Textract cannot read the page. For more
3671
+ # information about page limits in Amazon Textract, see [ Page Quotas
3672
+ # in Amazon Textract][1].
3673
+ #
3674
+ # * TEXTRACT\_PROVISIONED\_THROUGHPUT\_EXCEEDED - The number of requests
3675
+ # exceeded your throughput limit. For more information about
3676
+ # throughput quotas in Amazon Textract, see [ Default quotas in Amazon
3677
+ # Textract][2].
3678
+ #
3679
+ # * PAGE\_CHARACTERS\_EXCEEDED - Too many text characters on the page
3680
+ # (10,000 characters maximum).
3826
3681
  #
3827
- # @note When making an API call, you may pass EventsDetectionJobFilter
3828
- # data as a hash:
3682
+ # * PAGE\_SIZE\_EXCEEDED - The maximum page size is 10 MB.
3829
3683
  #
3830
- # {
3831
- # job_name: "JobName",
3832
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3833
- # submit_time_before: Time.now,
3834
- # submit_time_after: Time.now,
3835
- # }
3684
+ # * INTERNAL\_SERVER\_ERROR - The request encountered a service issue.
3685
+ # Try the API request again.
3686
+ #
3687
+ #
3688
+ #
3689
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/limits-document.html
3690
+ # [2]: https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html
3691
+ #
3692
+ # @!attribute [rw] page
3693
+ # Page number where the error occurred.
3694
+ # @return [Integer]
3695
+ #
3696
+ # @!attribute [rw] error_code
3697
+ # Error code for the cause of the error.
3698
+ # @return [String]
3699
+ #
3700
+ # @!attribute [rw] error_message
3701
+ # Text message explaining the reason for the error.
3702
+ # @return [String]
3703
+ #
3704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ErrorsListItem AWS API Documentation
3705
+ #
3706
+ class ErrorsListItem < Struct.new(
3707
+ :page,
3708
+ :error_code,
3709
+ :error_message)
3710
+ SENSITIVE = []
3711
+ include Aws::Structure
3712
+ end
3713
+
3714
+ # Provides information for filtering a list of event detection jobs.
3836
3715
  #
3837
3716
  # @!attribute [rw] job_name
3838
3717
  # Filters on the name of the events detection job.
@@ -3950,23 +3829,53 @@ module Aws::Comprehend
3950
3829
  include Aws::Structure
3951
3830
  end
3952
3831
 
3953
- # @note When making an API call, you may pass ImportModelRequest
3954
- # data as a hash:
3832
+ # Array of the number of characters extracted from each page.
3833
+ #
3834
+ # @!attribute [rw] page
3835
+ # Page number.
3836
+ # @return [Integer]
3837
+ #
3838
+ # @!attribute [rw] count
3839
+ # Number of characters extracted from each page.
3840
+ # @return [Integer]
3841
+ #
3842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ExtractedCharactersListItem AWS API Documentation
3843
+ #
3844
+ class ExtractedCharactersListItem < Struct.new(
3845
+ :page,
3846
+ :count)
3847
+ SENSITIVE = []
3848
+ include Aws::Structure
3849
+ end
3850
+
3851
+ # Information about the location of items on a document page.
3852
+ #
3853
+ # For additional information, see [Geometry][1] in the Amazon Textract
3854
+ # API reference.
3855
+ #
3856
+ #
3955
3857
  #
3956
- # {
3957
- # source_model_arn: "ComprehendModelArn", # required
3958
- # model_name: "ComprehendArnName",
3959
- # version_name: "VersionName",
3960
- # model_kms_key_id: "KmsKeyId",
3961
- # data_access_role_arn: "IamRoleArn",
3962
- # tags: [
3963
- # {
3964
- # key: "TagKey", # required
3965
- # value: "TagValue",
3966
- # },
3967
- # ],
3968
- # }
3858
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html
3969
3859
  #
3860
+ # @!attribute [rw] bounding_box
3861
+ # An axis-aligned coarse representation of the location of the
3862
+ # recognized item on the document page.
3863
+ # @return [Types::BoundingBox]
3864
+ #
3865
+ # @!attribute [rw] polygon
3866
+ # Within the bounding box, a fine-grained polygon around the
3867
+ # recognized item.
3868
+ # @return [Array<Types::Point>]
3869
+ #
3870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Geometry AWS API Documentation
3871
+ #
3872
+ class Geometry < Struct.new(
3873
+ :bounding_box,
3874
+ :polygon)
3875
+ SENSITIVE = []
3876
+ include Aws::Structure
3877
+ end
3878
+
3970
3879
  # @!attribute [rw] source_model_arn
3971
3880
  # The Amazon Resource Name (ARN) of the custom model to import.
3972
3881
  # @return [String]
@@ -4034,20 +3943,8 @@ module Aws::Comprehend
4034
3943
  include Aws::Structure
4035
3944
  end
4036
3945
 
4037
- # The input properties for an inference job.
4038
- #
4039
- # @note When making an API call, you may pass InputDataConfig
4040
- # data as a hash:
4041
- #
4042
- # {
4043
- # s3_uri: "S3Uri", # required
4044
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
4045
- # document_reader_config: {
4046
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
4047
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
4048
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
4049
- # },
4050
- # }
3946
+ # The input properties for an inference job. The document reader config
3947
+ # field applies only to non-text inputs for custom analysis.
4051
3948
  #
4052
3949
  # @!attribute [rw] s3_uri
4053
3950
  # The Amazon S3 URI for the input data. The URI must be in same region
@@ -4074,12 +3971,8 @@ module Aws::Comprehend
4074
3971
  # @return [String]
4075
3972
  #
4076
3973
  # @!attribute [rw] document_reader_config
4077
- # The document reader config field applies only for InputDataConfig of
4078
- # StartEntitiesDetectionJob.
4079
- #
4080
- # Use DocumentReaderConfig to provide specifications about how you
4081
- # want your inference documents read. Currently it applies for PDF
4082
- # documents in StartEntitiesDetectionJob custom inference.
3974
+ # Provides configuration parameters to override the default actions
3975
+ # for extracting text from PDF documents and image files.
4083
3976
  # @return [Types::DocumentReaderConfig]
4084
3977
  #
4085
3978
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InputDataConfig AWS API Documentation
@@ -4119,15 +4012,64 @@ module Aws::Comprehend
4119
4012
  include Aws::Structure
4120
4013
  end
4121
4014
 
4015
+ # Provides additional detail about why the request failed:
4016
+ #
4017
+ # * Document size is too large - Check the size of your file and
4018
+ # resubmit the request.
4019
+ #
4020
+ # * Document type is not supported - Check the file type and resubmit
4021
+ # the request.
4022
+ #
4023
+ # * Too many pages in the document - Check the number of pages in your
4024
+ # file and resubmit the request.
4025
+ #
4026
+ # * Access denied to Amazon Textract - Verify that your account has
4027
+ # permission to use Amazon Textract API operations and resubmit the
4028
+ # request.
4029
+ #
4030
+ # @!attribute [rw] reason
4031
+ # Reason code is `INVALID_DOCUMENT`.
4032
+ # @return [String]
4033
+ #
4034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InvalidRequestDetail AWS API Documentation
4035
+ #
4036
+ class InvalidRequestDetail < Struct.new(
4037
+ :reason)
4038
+ SENSITIVE = []
4039
+ include Aws::Structure
4040
+ end
4041
+
4122
4042
  # The request is invalid.
4123
4043
  #
4124
4044
  # @!attribute [rw] message
4125
4045
  # @return [String]
4126
4046
  #
4047
+ # @!attribute [rw] reason
4048
+ # @return [String]
4049
+ #
4050
+ # @!attribute [rw] detail
4051
+ # Provides additional detail about why the request failed:
4052
+ #
4053
+ # * Document size is too large - Check the size of your file and
4054
+ # resubmit the request.
4055
+ #
4056
+ # * Document type is not supported - Check the file type and resubmit
4057
+ # the request.
4058
+ #
4059
+ # * Too many pages in the document - Check the number of pages in your
4060
+ # file and resubmit the request.
4061
+ #
4062
+ # * Access denied to Amazon Textract - Verify that your account has
4063
+ # permission to use Amazon Textract API operations and resubmit the
4064
+ # request.
4065
+ # @return [Types::InvalidRequestDetail]
4066
+ #
4127
4067
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InvalidRequestException AWS API Documentation
4128
4068
  #
4129
4069
  class InvalidRequestException < Struct.new(
4130
- :message)
4070
+ :message,
4071
+ :reason,
4072
+ :detail)
4131
4073
  SENSITIVE = []
4132
4074
  include Aws::Structure
4133
4075
  end
@@ -4180,16 +4122,6 @@ module Aws::Comprehend
4180
4122
  # Provides information for filtering a list of dominant language
4181
4123
  # detection jobs. For more information, see the operation.
4182
4124
  #
4183
- # @note When making an API call, you may pass KeyPhrasesDetectionJobFilter
4184
- # data as a hash:
4185
- #
4186
- # {
4187
- # job_name: "JobName",
4188
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4189
- # submit_time_before: Time.now,
4190
- # submit_time_after: Time.now,
4191
- # }
4192
- #
4193
4125
  # @!attribute [rw] job_name
4194
4126
  # Filters on the name of the job.
4195
4127
  # @return [String]
@@ -4340,20 +4272,6 @@ module Aws::Comprehend
4340
4272
  include Aws::Structure
4341
4273
  end
4342
4274
 
4343
- # @note When making an API call, you may pass ListDocumentClassificationJobsRequest
4344
- # data as a hash:
4345
- #
4346
- # {
4347
- # filter: {
4348
- # job_name: "JobName",
4349
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4350
- # submit_time_before: Time.now,
4351
- # submit_time_after: Time.now,
4352
- # },
4353
- # next_token: "String",
4354
- # max_results: 1,
4355
- # }
4356
- #
4357
4275
  # @!attribute [rw] filter
4358
4276
  # Filters the jobs that are returned. You can filter jobs on their
4359
4277
  # names, status, or the date and time that they were submitted. You
@@ -4396,14 +4314,6 @@ module Aws::Comprehend
4396
4314
  include Aws::Structure
4397
4315
  end
4398
4316
 
4399
- # @note When making an API call, you may pass ListDocumentClassifierSummariesRequest
4400
- # data as a hash:
4401
- #
4402
- # {
4403
- # next_token: "String",
4404
- # max_results: 1,
4405
- # }
4406
- #
4407
4317
  # @!attribute [rw] next_token
4408
4318
  # Identifies the next page of results to return.
4409
4319
  # @return [String]
@@ -4439,20 +4349,6 @@ module Aws::Comprehend
4439
4349
  include Aws::Structure
4440
4350
  end
4441
4351
 
4442
- # @note When making an API call, you may pass ListDocumentClassifiersRequest
4443
- # data as a hash:
4444
- #
4445
- # {
4446
- # filter: {
4447
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
4448
- # document_classifier_name: "ComprehendArnName",
4449
- # submit_time_before: Time.now,
4450
- # submit_time_after: Time.now,
4451
- # },
4452
- # next_token: "String",
4453
- # max_results: 1,
4454
- # }
4455
- #
4456
4352
  # @!attribute [rw] filter
4457
4353
  # Filters the jobs that are returned. You can filter jobs on their
4458
4354
  # name, status, or the date and time that they were submitted. You can
@@ -4495,20 +4391,6 @@ module Aws::Comprehend
4495
4391
  include Aws::Structure
4496
4392
  end
4497
4393
 
4498
- # @note When making an API call, you may pass ListDominantLanguageDetectionJobsRequest
4499
- # data as a hash:
4500
- #
4501
- # {
4502
- # filter: {
4503
- # job_name: "JobName",
4504
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4505
- # submit_time_before: Time.now,
4506
- # submit_time_after: Time.now,
4507
- # },
4508
- # next_token: "String",
4509
- # max_results: 1,
4510
- # }
4511
- #
4512
4394
  # @!attribute [rw] filter
4513
4395
  # Filters that jobs that are returned. You can filter jobs on their
4514
4396
  # name, status, or the date and time that they were submitted. You can
@@ -4551,20 +4433,6 @@ module Aws::Comprehend
4551
4433
  include Aws::Structure
4552
4434
  end
4553
4435
 
4554
- # @note When making an API call, you may pass ListEndpointsRequest
4555
- # data as a hash:
4556
- #
4557
- # {
4558
- # filter: {
4559
- # model_arn: "ComprehendModelArn",
4560
- # status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
4561
- # creation_time_before: Time.now,
4562
- # creation_time_after: Time.now,
4563
- # },
4564
- # next_token: "String",
4565
- # max_results: 1,
4566
- # }
4567
- #
4568
4436
  # @!attribute [rw] filter
4569
4437
  # Filters the endpoints that are returned. You can filter endpoints on
4570
4438
  # their name, model, status, or the date and time that they were
@@ -4608,20 +4476,6 @@ module Aws::Comprehend
4608
4476
  include Aws::Structure
4609
4477
  end
4610
4478
 
4611
- # @note When making an API call, you may pass ListEntitiesDetectionJobsRequest
4612
- # data as a hash:
4613
- #
4614
- # {
4615
- # filter: {
4616
- # job_name: "JobName",
4617
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4618
- # submit_time_before: Time.now,
4619
- # submit_time_after: Time.now,
4620
- # },
4621
- # next_token: "String",
4622
- # max_results: 1,
4623
- # }
4624
- #
4625
4479
  # @!attribute [rw] filter
4626
4480
  # Filters the jobs that are returned. You can filter jobs on their
4627
4481
  # name, status, or the date and time that they were submitted. You can
@@ -4664,14 +4518,6 @@ module Aws::Comprehend
4664
4518
  include Aws::Structure
4665
4519
  end
4666
4520
 
4667
- # @note When making an API call, you may pass ListEntityRecognizerSummariesRequest
4668
- # data as a hash:
4669
- #
4670
- # {
4671
- # next_token: "String",
4672
- # max_results: 1,
4673
- # }
4674
- #
4675
4521
  # @!attribute [rw] next_token
4676
4522
  # Identifies the next page of results to return.
4677
4523
  # @return [String]
@@ -4707,20 +4553,6 @@ module Aws::Comprehend
4707
4553
  include Aws::Structure
4708
4554
  end
4709
4555
 
4710
- # @note When making an API call, you may pass ListEntityRecognizersRequest
4711
- # data as a hash:
4712
- #
4713
- # {
4714
- # filter: {
4715
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
4716
- # recognizer_name: "ComprehendArnName",
4717
- # submit_time_before: Time.now,
4718
- # submit_time_after: Time.now,
4719
- # },
4720
- # next_token: "String",
4721
- # max_results: 1,
4722
- # }
4723
- #
4724
4556
  # @!attribute [rw] filter
4725
4557
  # Filters the list of entities returned. You can filter on `Status`,
4726
4558
  # `SubmitTimeBefore`, or `SubmitTimeAfter`. You can only set one
@@ -4763,20 +4595,6 @@ module Aws::Comprehend
4763
4595
  include Aws::Structure
4764
4596
  end
4765
4597
 
4766
- # @note When making an API call, you may pass ListEventsDetectionJobsRequest
4767
- # data as a hash:
4768
- #
4769
- # {
4770
- # filter: {
4771
- # job_name: "JobName",
4772
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4773
- # submit_time_before: Time.now,
4774
- # submit_time_after: Time.now,
4775
- # },
4776
- # next_token: "String",
4777
- # max_results: 1,
4778
- # }
4779
- #
4780
4598
  # @!attribute [rw] filter
4781
4599
  # Filters the jobs that are returned. You can filter jobs on their
4782
4600
  # name, status, or the date and time that they were submitted. You can
@@ -4818,20 +4636,6 @@ module Aws::Comprehend
4818
4636
  include Aws::Structure
4819
4637
  end
4820
4638
 
4821
- # @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
4822
- # data as a hash:
4823
- #
4824
- # {
4825
- # filter: {
4826
- # job_name: "JobName",
4827
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4828
- # submit_time_before: Time.now,
4829
- # submit_time_after: Time.now,
4830
- # },
4831
- # next_token: "String",
4832
- # max_results: 1,
4833
- # }
4834
- #
4835
4639
  # @!attribute [rw] filter
4836
4640
  # Filters the jobs that are returned. You can filter jobs on their
4837
4641
  # name, status, or the date and time that they were submitted. You can
@@ -4874,20 +4678,6 @@ module Aws::Comprehend
4874
4678
  include Aws::Structure
4875
4679
  end
4876
4680
 
4877
- # @note When making an API call, you may pass ListPiiEntitiesDetectionJobsRequest
4878
- # data as a hash:
4879
- #
4880
- # {
4881
- # filter: {
4882
- # job_name: "JobName",
4883
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4884
- # submit_time_before: Time.now,
4885
- # submit_time_after: Time.now,
4886
- # },
4887
- # next_token: "String",
4888
- # max_results: 1,
4889
- # }
4890
- #
4891
4681
  # @!attribute [rw] filter
4892
4682
  # Filters the jobs that are returned. You can filter jobs on their
4893
4683
  # name, status, or the date and time that they were submitted. You can
@@ -4929,20 +4719,6 @@ module Aws::Comprehend
4929
4719
  include Aws::Structure
4930
4720
  end
4931
4721
 
4932
- # @note When making an API call, you may pass ListSentimentDetectionJobsRequest
4933
- # data as a hash:
4934
- #
4935
- # {
4936
- # filter: {
4937
- # job_name: "JobName",
4938
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
4939
- # submit_time_before: Time.now,
4940
- # submit_time_after: Time.now,
4941
- # },
4942
- # next_token: "String",
4943
- # max_results: 1,
4944
- # }
4945
- #
4946
4722
  # @!attribute [rw] filter
4947
4723
  # Filters the jobs that are returned. You can filter jobs on their
4948
4724
  # name, status, or the date and time that they were submitted. You can
@@ -4985,13 +4761,6 @@ module Aws::Comprehend
4985
4761
  include Aws::Structure
4986
4762
  end
4987
4763
 
4988
- # @note When making an API call, you may pass ListTagsForResourceRequest
4989
- # data as a hash:
4990
- #
4991
- # {
4992
- # resource_arn: "ComprehendArn", # required
4993
- # }
4994
- #
4995
4764
  # @!attribute [rw] resource_arn
4996
4765
  # The Amazon Resource Name (ARN) of the given Amazon Comprehend
4997
4766
  # resource you are querying.
@@ -5027,20 +4796,6 @@ module Aws::Comprehend
5027
4796
  include Aws::Structure
5028
4797
  end
5029
4798
 
5030
- # @note When making an API call, you may pass ListTargetedSentimentDetectionJobsRequest
5031
- # data as a hash:
5032
- #
5033
- # {
5034
- # filter: {
5035
- # job_name: "JobName",
5036
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
5037
- # submit_time_before: Time.now,
5038
- # submit_time_after: Time.now,
5039
- # },
5040
- # next_token: "String",
5041
- # max_results: 1,
5042
- # }
5043
- #
5044
4799
  # @!attribute [rw] filter
5045
4800
  # Filters the jobs that are returned. You can filter jobs on their
5046
4801
  # name, status, or the date and time that they were submitted. You can
@@ -5083,20 +4838,6 @@ module Aws::Comprehend
5083
4838
  include Aws::Structure
5084
4839
  end
5085
4840
 
5086
- # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
5087
- # data as a hash:
5088
- #
5089
- # {
5090
- # filter: {
5091
- # job_name: "JobName",
5092
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
5093
- # submit_time_before: Time.now,
5094
- # submit_time_after: Time.now,
5095
- # },
5096
- # next_token: "String",
5097
- # max_results: 1,
5098
- # }
5099
- #
5100
4841
  # @!attribute [rw] filter
5101
4842
  # Filters the jobs that are returned. Jobs can be filtered on their
5102
4843
  # name, status, or the date and time that they were submitted. You can
@@ -5169,14 +4910,6 @@ module Aws::Comprehend
5169
4910
 
5170
4911
  # Provides configuration parameters for the output of inference jobs.
5171
4912
  #
5172
- # @note When making an API call, you may pass OutputDataConfig
5173
- # data as a hash:
5174
- #
5175
- # {
5176
- # s3_uri: "S3Uri", # required
5177
- # kms_key_id: "KmsKeyId",
5178
- # }
5179
- #
5180
4913
  # @!attribute [rw] s3_uri
5181
4914
  # When you use the `OutputDataConfig` object with asynchronous
5182
4915
  # operations, you specify the Amazon S3 location where you want to
@@ -5250,16 +4983,6 @@ module Aws::Comprehend
5250
4983
  # Provides information for filtering a list of PII entity detection
5251
4984
  # jobs.
5252
4985
  #
5253
- # @note When making an API call, you may pass PiiEntitiesDetectionJobFilter
5254
- # data as a hash:
5255
- #
5256
- # {
5257
- # job_name: "JobName",
5258
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
5259
- # submit_time_before: Time.now,
5260
- # submit_time_after: Time.now,
5261
- # }
5262
- #
5263
4986
  # @!attribute [rw] job_name
5264
4987
  # Filters on the name of the job.
5265
4988
  # @return [String]
@@ -5445,15 +5168,32 @@ module Aws::Comprehend
5445
5168
  include Aws::Structure
5446
5169
  end
5447
5170
 
5448
- # @note When making an API call, you may pass PutResourcePolicyRequest
5449
- # data as a hash:
5171
+ # The X and Y coordinates of a point on a document page.
5172
+ #
5173
+ # For additional information, see [Point][1] in the Amazon Textract API
5174
+ # reference.
5175
+ #
5450
5176
  #
5451
- # {
5452
- # resource_arn: "ComprehendModelArn", # required
5453
- # resource_policy: "Policy", # required
5454
- # policy_revision_id: "PolicyRevisionId",
5455
- # }
5456
5177
  #
5178
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/API_Point.html
5179
+ #
5180
+ # @!attribute [rw] x
5181
+ # The value of the X coordinate for a point on a polygon
5182
+ # @return [Float]
5183
+ #
5184
+ # @!attribute [rw] y
5185
+ # The value of the Y coordinate for a point on a polygon
5186
+ # @return [Float]
5187
+ #
5188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Point AWS API Documentation
5189
+ #
5190
+ class Point < Struct.new(
5191
+ :x,
5192
+ :y)
5193
+ SENSITIVE = []
5194
+ include Aws::Structure
5195
+ end
5196
+
5457
5197
  # @!attribute [rw] resource_arn
5458
5198
  # The Amazon Resource Name (ARN) of the custom model to attach the
5459
5199
  # policy to.
@@ -5508,15 +5248,6 @@ module Aws::Comprehend
5508
5248
 
5509
5249
  # Provides configuration parameters for PII entity redaction.
5510
5250
  #
5511
- # @note When making an API call, you may pass RedactionConfig
5512
- # data as a hash:
5513
- #
5514
- # {
5515
- # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER
5516
- # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
5517
- # mask_character: "MaskCharacter",
5518
- # }
5519
- #
5520
5251
  # @!attribute [rw] pii_entity_types
5521
5252
  # An array of the types of PII entities that Amazon Comprehend detects
5522
5253
  # in the input text for your request.
@@ -5541,6 +5272,25 @@ module Aws::Comprehend
5541
5272
  include Aws::Structure
5542
5273
  end
5543
5274
 
5275
+ # List of child blocks for the current block.
5276
+ #
5277
+ # @!attribute [rw] ids
5278
+ # Identifers of the child blocks.
5279
+ # @return [Array<String>]
5280
+ #
5281
+ # @!attribute [rw] type
5282
+ # Only supported relationship is a child relationship.
5283
+ # @return [String]
5284
+ #
5285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RelationshipsListItem AWS API Documentation
5286
+ #
5287
+ class RelationshipsListItem < Struct.new(
5288
+ :ids,
5289
+ :type)
5290
+ SENSITIVE = []
5291
+ include Aws::Structure
5292
+ end
5293
+
5544
5294
  # The specified resource name is already in use. Use a different name
5545
5295
  # and try your request again.
5546
5296
  #
@@ -5600,16 +5350,6 @@ module Aws::Comprehend
5600
5350
  # Provides information for filtering a list of dominant language
5601
5351
  # detection jobs. For more information, see the operation.
5602
5352
  #
5603
- # @note When making an API call, you may pass SentimentDetectionJobFilter
5604
- # data as a hash:
5605
- #
5606
- # {
5607
- # job_name: "JobName",
5608
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
5609
- # submit_time_before: Time.now,
5610
- # submit_time_after: Time.now,
5611
- # }
5612
- #
5613
5353
  # @!attribute [rw] job_name
5614
5354
  # Filters on the name of the job.
5615
5355
  # @return [String]
@@ -5780,40 +5520,6 @@ module Aws::Comprehend
5780
5520
  include Aws::Structure
5781
5521
  end
5782
5522
 
5783
- # @note When making an API call, you may pass StartDocumentClassificationJobRequest
5784
- # data as a hash:
5785
- #
5786
- # {
5787
- # job_name: "JobName",
5788
- # document_classifier_arn: "DocumentClassifierArn", # required
5789
- # input_data_config: { # required
5790
- # s3_uri: "S3Uri", # required
5791
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
5792
- # document_reader_config: {
5793
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
5794
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
5795
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
5796
- # },
5797
- # },
5798
- # output_data_config: { # required
5799
- # s3_uri: "S3Uri", # required
5800
- # kms_key_id: "KmsKeyId",
5801
- # },
5802
- # data_access_role_arn: "IamRoleArn", # required
5803
- # client_request_token: "ClientRequestTokenString",
5804
- # volume_kms_key_id: "KmsKeyId",
5805
- # vpc_config: {
5806
- # security_group_ids: ["SecurityGroupId"], # required
5807
- # subnets: ["SubnetId"], # required
5808
- # },
5809
- # tags: [
5810
- # {
5811
- # key: "TagKey", # required
5812
- # value: "TagValue",
5813
- # },
5814
- # ],
5815
- # }
5816
- #
5817
5523
  # @!attribute [rw] job_name
5818
5524
  # The identifier of the job.
5819
5525
  # @return [String]
@@ -5936,39 +5642,6 @@ module Aws::Comprehend
5936
5642
  include Aws::Structure
5937
5643
  end
5938
5644
 
5939
- # @note When making an API call, you may pass StartDominantLanguageDetectionJobRequest
5940
- # data as a hash:
5941
- #
5942
- # {
5943
- # input_data_config: { # required
5944
- # s3_uri: "S3Uri", # required
5945
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
5946
- # document_reader_config: {
5947
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
5948
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
5949
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
5950
- # },
5951
- # },
5952
- # output_data_config: { # required
5953
- # s3_uri: "S3Uri", # required
5954
- # kms_key_id: "KmsKeyId",
5955
- # },
5956
- # data_access_role_arn: "IamRoleArn", # required
5957
- # job_name: "JobName",
5958
- # client_request_token: "ClientRequestTokenString",
5959
- # volume_kms_key_id: "KmsKeyId",
5960
- # vpc_config: {
5961
- # security_group_ids: ["SecurityGroupId"], # required
5962
- # subnets: ["SubnetId"], # required
5963
- # },
5964
- # tags: [
5965
- # {
5966
- # key: "TagKey", # required
5967
- # value: "TagValue",
5968
- # },
5969
- # ],
5970
- # }
5971
- #
5972
5645
  # @!attribute [rw] input_data_config
5973
5646
  # Specifies the format and location of the input data for the job.
5974
5647
  # @return [Types::InputDataConfig]
@@ -6088,41 +5761,6 @@ module Aws::Comprehend
6088
5761
  include Aws::Structure
6089
5762
  end
6090
5763
 
6091
- # @note When making an API call, you may pass StartEntitiesDetectionJobRequest
6092
- # data as a hash:
6093
- #
6094
- # {
6095
- # input_data_config: { # required
6096
- # s3_uri: "S3Uri", # required
6097
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6098
- # document_reader_config: {
6099
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6100
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6101
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6102
- # },
6103
- # },
6104
- # output_data_config: { # required
6105
- # s3_uri: "S3Uri", # required
6106
- # kms_key_id: "KmsKeyId",
6107
- # },
6108
- # data_access_role_arn: "IamRoleArn", # required
6109
- # job_name: "JobName",
6110
- # entity_recognizer_arn: "EntityRecognizerArn",
6111
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6112
- # client_request_token: "ClientRequestTokenString",
6113
- # volume_kms_key_id: "KmsKeyId",
6114
- # vpc_config: {
6115
- # security_group_ids: ["SecurityGroupId"], # required
6116
- # subnets: ["SubnetId"], # required
6117
- # },
6118
- # tags: [
6119
- # {
6120
- # key: "TagKey", # required
6121
- # value: "TagValue",
6122
- # },
6123
- # ],
6124
- # }
6125
- #
6126
5764
  # @!attribute [rw] input_data_config
6127
5765
  # Specifies the format and location of the input data for the job.
6128
5766
  # @return [Types::InputDataConfig]
@@ -6262,36 +5900,6 @@ module Aws::Comprehend
6262
5900
  include Aws::Structure
6263
5901
  end
6264
5902
 
6265
- # @note When making an API call, you may pass StartEventsDetectionJobRequest
6266
- # data as a hash:
6267
- #
6268
- # {
6269
- # input_data_config: { # required
6270
- # s3_uri: "S3Uri", # required
6271
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6272
- # document_reader_config: {
6273
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6274
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6275
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6276
- # },
6277
- # },
6278
- # output_data_config: { # required
6279
- # s3_uri: "S3Uri", # required
6280
- # kms_key_id: "KmsKeyId",
6281
- # },
6282
- # data_access_role_arn: "IamRoleArn", # required
6283
- # job_name: "JobName",
6284
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6285
- # client_request_token: "ClientRequestTokenString",
6286
- # target_event_types: ["EventTypeString"], # required
6287
- # tags: [
6288
- # {
6289
- # key: "TagKey", # required
6290
- # value: "TagValue",
6291
- # },
6292
- # ],
6293
- # }
6294
- #
6295
5903
  # @!attribute [rw] input_data_config
6296
5904
  # Specifies the format and location of the input data for the job.
6297
5905
  # @return [Types::InputDataConfig]
@@ -6380,40 +5988,6 @@ module Aws::Comprehend
6380
5988
  include Aws::Structure
6381
5989
  end
6382
5990
 
6383
- # @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
6384
- # data as a hash:
6385
- #
6386
- # {
6387
- # input_data_config: { # required
6388
- # s3_uri: "S3Uri", # required
6389
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6390
- # document_reader_config: {
6391
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6392
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6393
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6394
- # },
6395
- # },
6396
- # output_data_config: { # required
6397
- # s3_uri: "S3Uri", # required
6398
- # kms_key_id: "KmsKeyId",
6399
- # },
6400
- # data_access_role_arn: "IamRoleArn", # required
6401
- # job_name: "JobName",
6402
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6403
- # client_request_token: "ClientRequestTokenString",
6404
- # volume_kms_key_id: "KmsKeyId",
6405
- # vpc_config: {
6406
- # security_group_ids: ["SecurityGroupId"], # required
6407
- # subnets: ["SubnetId"], # required
6408
- # },
6409
- # tags: [
6410
- # {
6411
- # key: "TagKey", # required
6412
- # value: "TagValue",
6413
- # },
6414
- # ],
6415
- # }
6416
- #
6417
5991
  # @!attribute [rw] input_data_config
6418
5992
  # Specifies the format and location of the input data for the job.
6419
5993
  # @return [Types::InputDataConfig]
@@ -6539,41 +6113,6 @@ module Aws::Comprehend
6539
6113
  include Aws::Structure
6540
6114
  end
6541
6115
 
6542
- # @note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
6543
- # data as a hash:
6544
- #
6545
- # {
6546
- # input_data_config: { # required
6547
- # s3_uri: "S3Uri", # required
6548
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6549
- # document_reader_config: {
6550
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6551
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6552
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6553
- # },
6554
- # },
6555
- # output_data_config: { # required
6556
- # s3_uri: "S3Uri", # required
6557
- # kms_key_id: "KmsKeyId",
6558
- # },
6559
- # mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
6560
- # redaction_config: {
6561
- # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER
6562
- # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
6563
- # mask_character: "MaskCharacter",
6564
- # },
6565
- # data_access_role_arn: "IamRoleArn", # required
6566
- # job_name: "JobName",
6567
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6568
- # client_request_token: "ClientRequestTokenString",
6569
- # tags: [
6570
- # {
6571
- # key: "TagKey", # required
6572
- # value: "TagValue",
6573
- # },
6574
- # ],
6575
- # }
6576
- #
6577
6116
  # @!attribute [rw] input_data_config
6578
6117
  # The input properties for a PII entities detection job.
6579
6118
  # @return [Types::InputDataConfig]
@@ -6673,40 +6212,6 @@ module Aws::Comprehend
6673
6212
  include Aws::Structure
6674
6213
  end
6675
6214
 
6676
- # @note When making an API call, you may pass StartSentimentDetectionJobRequest
6677
- # data as a hash:
6678
- #
6679
- # {
6680
- # input_data_config: { # required
6681
- # s3_uri: "S3Uri", # required
6682
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6683
- # document_reader_config: {
6684
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6685
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6686
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6687
- # },
6688
- # },
6689
- # output_data_config: { # required
6690
- # s3_uri: "S3Uri", # required
6691
- # kms_key_id: "KmsKeyId",
6692
- # },
6693
- # data_access_role_arn: "IamRoleArn", # required
6694
- # job_name: "JobName",
6695
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6696
- # client_request_token: "ClientRequestTokenString",
6697
- # volume_kms_key_id: "KmsKeyId",
6698
- # vpc_config: {
6699
- # security_group_ids: ["SecurityGroupId"], # required
6700
- # subnets: ["SubnetId"], # required
6701
- # },
6702
- # tags: [
6703
- # {
6704
- # key: "TagKey", # required
6705
- # value: "TagValue",
6706
- # },
6707
- # ],
6708
- # }
6709
- #
6710
6215
  # @!attribute [rw] input_data_config
6711
6216
  # Specifies the format and location of the input data for the job.
6712
6217
  # @return [Types::InputDataConfig]
@@ -6832,42 +6337,9 @@ module Aws::Comprehend
6832
6337
  include Aws::Structure
6833
6338
  end
6834
6339
 
6835
- # @note When making an API call, you may pass StartTargetedSentimentDetectionJobRequest
6836
- # data as a hash:
6837
- #
6838
- # {
6839
- # input_data_config: { # required
6840
- # s3_uri: "S3Uri", # required
6841
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
6842
- # document_reader_config: {
6843
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
6844
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
6845
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
6846
- # },
6847
- # },
6848
- # output_data_config: { # required
6849
- # s3_uri: "S3Uri", # required
6850
- # kms_key_id: "KmsKeyId",
6851
- # },
6852
- # data_access_role_arn: "IamRoleArn", # required
6853
- # job_name: "JobName",
6854
- # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
6855
- # client_request_token: "ClientRequestTokenString",
6856
- # volume_kms_key_id: "KmsKeyId",
6857
- # vpc_config: {
6858
- # security_group_ids: ["SecurityGroupId"], # required
6859
- # subnets: ["SubnetId"], # required
6860
- # },
6861
- # tags: [
6862
- # {
6863
- # key: "TagKey", # required
6864
- # value: "TagValue",
6865
- # },
6866
- # ],
6867
- # }
6868
- #
6869
6340
  # @!attribute [rw] input_data_config
6870
- # The input properties for an inference job.
6341
+ # The input properties for an inference job. The document reader
6342
+ # config field applies only to non-text inputs for custom analysis.
6871
6343
  # @return [Types::InputDataConfig]
6872
6344
  #
6873
6345
  # @!attribute [rw] output_data_config
@@ -6991,40 +6463,6 @@ module Aws::Comprehend
6991
6463
  include Aws::Structure
6992
6464
  end
6993
6465
 
6994
- # @note When making an API call, you may pass StartTopicsDetectionJobRequest
6995
- # data as a hash:
6996
- #
6997
- # {
6998
- # input_data_config: { # required
6999
- # s3_uri: "S3Uri", # required
7000
- # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
7001
- # document_reader_config: {
7002
- # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
7003
- # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
7004
- # feature_types: ["TABLES"], # accepts TABLES, FORMS
7005
- # },
7006
- # },
7007
- # output_data_config: { # required
7008
- # s3_uri: "S3Uri", # required
7009
- # kms_key_id: "KmsKeyId",
7010
- # },
7011
- # data_access_role_arn: "IamRoleArn", # required
7012
- # job_name: "JobName",
7013
- # number_of_topics: 1,
7014
- # client_request_token: "ClientRequestTokenString",
7015
- # volume_kms_key_id: "KmsKeyId",
7016
- # vpc_config: {
7017
- # security_group_ids: ["SecurityGroupId"], # required
7018
- # subnets: ["SubnetId"], # required
7019
- # },
7020
- # tags: [
7021
- # {
7022
- # key: "TagKey", # required
7023
- # value: "TagValue",
7024
- # },
7025
- # ],
7026
- # }
7027
- #
7028
6466
  # @!attribute [rw] input_data_config
7029
6467
  # Specifies the format and location of the input data for the job.
7030
6468
  # @return [Types::InputDataConfig]
@@ -7151,13 +6589,6 @@ module Aws::Comprehend
7151
6589
  include Aws::Structure
7152
6590
  end
7153
6591
 
7154
- # @note When making an API call, you may pass StopDominantLanguageDetectionJobRequest
7155
- # data as a hash:
7156
- #
7157
- # {
7158
- # job_id: "JobId", # required
7159
- # }
7160
- #
7161
6592
  # @!attribute [rw] job_id
7162
6593
  # The identifier of the dominant language detection job to stop.
7163
6594
  # @return [String]
@@ -7189,13 +6620,6 @@ module Aws::Comprehend
7189
6620
  include Aws::Structure
7190
6621
  end
7191
6622
 
7192
- # @note When making an API call, you may pass StopEntitiesDetectionJobRequest
7193
- # data as a hash:
7194
- #
7195
- # {
7196
- # job_id: "JobId", # required
7197
- # }
7198
- #
7199
6623
  # @!attribute [rw] job_id
7200
6624
  # The identifier of the entities detection job to stop.
7201
6625
  # @return [String]
@@ -7227,13 +6651,6 @@ module Aws::Comprehend
7227
6651
  include Aws::Structure
7228
6652
  end
7229
6653
 
7230
- # @note When making an API call, you may pass StopEventsDetectionJobRequest
7231
- # data as a hash:
7232
- #
7233
- # {
7234
- # job_id: "JobId", # required
7235
- # }
7236
- #
7237
6654
  # @!attribute [rw] job_id
7238
6655
  # The identifier of the events detection job to stop.
7239
6656
  # @return [String]
@@ -7263,13 +6680,6 @@ module Aws::Comprehend
7263
6680
  include Aws::Structure
7264
6681
  end
7265
6682
 
7266
- # @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
7267
- # data as a hash:
7268
- #
7269
- # {
7270
- # job_id: "JobId", # required
7271
- # }
7272
- #
7273
6683
  # @!attribute [rw] job_id
7274
6684
  # The identifier of the key phrases detection job to stop.
7275
6685
  # @return [String]
@@ -7301,13 +6711,6 @@ module Aws::Comprehend
7301
6711
  include Aws::Structure
7302
6712
  end
7303
6713
 
7304
- # @note When making an API call, you may pass StopPiiEntitiesDetectionJobRequest
7305
- # data as a hash:
7306
- #
7307
- # {
7308
- # job_id: "JobId", # required
7309
- # }
7310
- #
7311
6714
  # @!attribute [rw] job_id
7312
6715
  # The identifier of the PII entities detection job to stop.
7313
6716
  # @return [String]
@@ -7337,13 +6740,6 @@ module Aws::Comprehend
7337
6740
  include Aws::Structure
7338
6741
  end
7339
6742
 
7340
- # @note When making an API call, you may pass StopSentimentDetectionJobRequest
7341
- # data as a hash:
7342
- #
7343
- # {
7344
- # job_id: "JobId", # required
7345
- # }
7346
- #
7347
6743
  # @!attribute [rw] job_id
7348
6744
  # The identifier of the sentiment detection job to stop.
7349
6745
  # @return [String]
@@ -7375,13 +6771,6 @@ module Aws::Comprehend
7375
6771
  include Aws::Structure
7376
6772
  end
7377
6773
 
7378
- # @note When making an API call, you may pass StopTargetedSentimentDetectionJobRequest
7379
- # data as a hash:
7380
- #
7381
- # {
7382
- # job_id: "JobId", # required
7383
- # }
7384
- #
7385
6774
  # @!attribute [rw] job_id
7386
6775
  # The identifier of the targeted sentiment detection job to stop.
7387
6776
  # @return [String]
@@ -7413,13 +6802,6 @@ module Aws::Comprehend
7413
6802
  include Aws::Structure
7414
6803
  end
7415
6804
 
7416
- # @note When making an API call, you may pass StopTrainingDocumentClassifierRequest
7417
- # data as a hash:
7418
- #
7419
- # {
7420
- # document_classifier_arn: "DocumentClassifierArn", # required
7421
- # }
7422
- #
7423
6805
  # @!attribute [rw] document_classifier_arn
7424
6806
  # The Amazon Resource Name (ARN) that identifies the document
7425
6807
  # classifier currently being trained.
@@ -7437,13 +6819,6 @@ module Aws::Comprehend
7437
6819
  #
7438
6820
  class StopTrainingDocumentClassifierResponse < Aws::EmptyStructure; end
7439
6821
 
7440
- # @note When making an API call, you may pass StopTrainingEntityRecognizerRequest
7441
- # data as a hash:
7442
- #
7443
- # {
7444
- # entity_recognizer_arn: "EntityRecognizerArn", # required
7445
- # }
7446
- #
7447
6822
  # @!attribute [rw] entity_recognizer_arn
7448
6823
  # The Amazon Resource Name (ARN) that identifies the entity recognizer
7449
6824
  # currently being trained.
@@ -7511,14 +6886,6 @@ module Aws::Comprehend
7511
6886
  # ‘Department’:’Sales’ might be added to a resource to indicate its use
7512
6887
  # by a particular department.
7513
6888
  #
7514
- # @note When making an API call, you may pass Tag
7515
- # data as a hash:
7516
- #
7517
- # {
7518
- # key: "TagKey", # required
7519
- # value: "TagValue",
7520
- # }
7521
- #
7522
6889
  # @!attribute [rw] key
7523
6890
  # The initial part of a key-value pair that forms a tag associated
7524
6891
  # with a given resource. For instance, if you want to show which
@@ -7544,19 +6911,6 @@ module Aws::Comprehend
7544
6911
  include Aws::Structure
7545
6912
  end
7546
6913
 
7547
- # @note When making an API call, you may pass TagResourceRequest
7548
- # data as a hash:
7549
- #
7550
- # {
7551
- # resource_arn: "ComprehendArn", # required
7552
- # tags: [ # required
7553
- # {
7554
- # key: "TagKey", # required
7555
- # value: "TagValue",
7556
- # },
7557
- # ],
7558
- # }
7559
- #
7560
6914
  # @!attribute [rw] resource_arn
7561
6915
  # The Amazon Resource Name (ARN) of the given Amazon Comprehend
7562
6916
  # resource to which you want to associate the tags.
@@ -7584,16 +6938,6 @@ module Aws::Comprehend
7584
6938
  # Provides information for filtering a list of dominant language
7585
6939
  # detection jobs. For more information, see the operation.
7586
6940
  #
7587
- # @note When making an API call, you may pass TargetedSentimentDetectionJobFilter
7588
- # data as a hash:
7589
- #
7590
- # {
7591
- # job_name: "JobName",
7592
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
7593
- # submit_time_before: Time.now,
7594
- # submit_time_after: Time.now,
7595
- # }
7596
- #
7597
6941
  # @!attribute [rw] job_name
7598
6942
  # Filters on the name of the job.
7599
6943
  # @return [String]
@@ -7671,7 +7015,8 @@ module Aws::Comprehend
7671
7015
  # @return [Time]
7672
7016
  #
7673
7017
  # @!attribute [rw] input_data_config
7674
- # The input properties for an inference job.
7018
+ # The input properties for an inference job. The document reader
7019
+ # config field applies only to non-text inputs for custom analysis.
7675
7020
  # @return [Types::InputDataConfig]
7676
7021
  #
7677
7022
  # @!attribute [rw] output_data_config
@@ -7882,16 +7227,6 @@ module Aws::Comprehend
7882
7227
  # Provides information for filtering topic detection jobs. For more
7883
7228
  # information, see .
7884
7229
  #
7885
- # @note When making an API call, you may pass TopicsDetectionJobFilter
7886
- # data as a hash:
7887
- #
7888
- # {
7889
- # job_name: "JobName",
7890
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
7891
- # submit_time_before: Time.now,
7892
- # submit_time_after: Time.now,
7893
- # }
7894
- #
7895
7230
  # @!attribute [rw] job_name
7896
7231
  # @return [String]
7897
7232
  #
@@ -8049,14 +7384,6 @@ module Aws::Comprehend
8049
7384
  include Aws::Structure
8050
7385
  end
8051
7386
 
8052
- # @note When making an API call, you may pass UntagResourceRequest
8053
- # data as a hash:
8054
- #
8055
- # {
8056
- # resource_arn: "ComprehendArn", # required
8057
- # tag_keys: ["TagKey"], # required
8058
- # }
8059
- #
8060
7387
  # @!attribute [rw] resource_arn
8061
7388
  # The Amazon Resource Name (ARN) of the given Amazon Comprehend
8062
7389
  # resource from which you want to remove the tags.
@@ -8083,16 +7410,6 @@ module Aws::Comprehend
8083
7410
  #
8084
7411
  class UntagResourceResponse < Aws::EmptyStructure; end
8085
7412
 
8086
- # @note When making an API call, you may pass UpdateEndpointRequest
8087
- # data as a hash:
8088
- #
8089
- # {
8090
- # endpoint_arn: "ComprehendEndpointArn", # required
8091
- # desired_model_arn: "ComprehendModelArn",
8092
- # desired_inference_units: 1,
8093
- # desired_data_access_role_arn: "IamRoleArn",
8094
- # }
8095
- #
8096
7413
  # @!attribute [rw] endpoint_arn
8097
7414
  # The Amazon Resource Number (ARN) of the endpoint being updated.
8098
7415
  # @return [String]
@@ -8135,14 +7452,6 @@ module Aws::Comprehend
8135
7452
  #
8136
7453
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
8137
7454
  #
8138
- # @note When making an API call, you may pass VpcConfig
8139
- # data as a hash:
8140
- #
8141
- # {
8142
- # security_group_ids: ["SecurityGroupId"], # required
8143
- # subnets: ["SubnetId"], # required
8144
- # }
8145
- #
8146
7455
  # @!attribute [rw] security_group_ids
8147
7456
  # The ID number for a security group on an instance of your private
8148
7457
  # VPC. Security groups on your VPC function serve as a virtual