aws-sdk-comprehend 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -96,7 +96,7 @@ module Aws::Comprehend
96
96
  #
97
97
  # {
98
98
  # text_list: ["String"], # required
99
- # language_code: "String", # required
99
+ # language_code: "en", # required, accepts en, es
100
100
  # }
101
101
  #
102
102
  # @!attribute [rw] text_list
@@ -106,8 +106,9 @@ module Aws::Comprehend
106
106
  # @return [Array<String>]
107
107
  #
108
108
  # @!attribute [rw] language_code
109
- # The language of the input documents. All documents must be in the
110
- # same language.
109
+ # The language of the input documents. You can specify English
110
+ # ("en") or Spanish ("es"). All documents must be in the same
111
+ # language.
111
112
  # @return [String]
112
113
  #
113
114
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesRequest AWS API Documentation
@@ -165,7 +166,7 @@ module Aws::Comprehend
165
166
  #
166
167
  # {
167
168
  # text_list: ["String"], # required
168
- # language_code: "String", # required
169
+ # language_code: "en", # required, accepts en, es
169
170
  # }
170
171
  #
171
172
  # @!attribute [rw] text_list
@@ -175,8 +176,9 @@ module Aws::Comprehend
175
176
  # @return [Array<String>]
176
177
  #
177
178
  # @!attribute [rw] language_code
178
- # The language of the input documents. All documents must be in the
179
- # same language.
179
+ # The language of the input documents. You can specify English
180
+ # ("en") or Spanish ("es"). All documents must be in the same
181
+ # language.
180
182
  # @return [String]
181
183
  #
182
184
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesRequest AWS API Documentation
@@ -239,7 +241,7 @@ module Aws::Comprehend
239
241
  #
240
242
  # {
241
243
  # text_list: ["String"], # required
242
- # language_code: "String", # required
244
+ # language_code: "en", # required, accepts en, es
243
245
  # }
244
246
  #
245
247
  # @!attribute [rw] text_list
@@ -249,8 +251,9 @@ module Aws::Comprehend
249
251
  # @return [Array<String>]
250
252
  #
251
253
  # @!attribute [rw] language_code
252
- # The language of the input documents. All documents must be in the
253
- # same language.
254
+ # The language of the input documents. You can specify English
255
+ # ("en") or Spanish ("es"). All documents must be in the same
256
+ # language.
254
257
  # @return [String]
255
258
  #
256
259
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentRequest AWS API Documentation
@@ -308,6 +311,130 @@ module Aws::Comprehend
308
311
  include Aws::Structure
309
312
  end
310
313
 
314
+ # @note When making an API call, you may pass DescribeDominantLanguageDetectionJobRequest
315
+ # data as a hash:
316
+ #
317
+ # {
318
+ # job_id: "JobId", # required
319
+ # }
320
+ #
321
+ # @!attribute [rw] job_id
322
+ # The identifier that Amazon Comprehend generated for the job. The
323
+ # operation returns this identifier in its response.
324
+ # @return [String]
325
+ #
326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJobRequest AWS API Documentation
327
+ #
328
+ class DescribeDominantLanguageDetectionJobRequest < Struct.new(
329
+ :job_id)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] dominant_language_detection_job_properties
334
+ # An object that contains the properties associated with a dominant
335
+ # language detection job.
336
+ # @return [Types::DominantLanguageDetectionJobProperties]
337
+ #
338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJobResponse AWS API Documentation
339
+ #
340
+ class DescribeDominantLanguageDetectionJobResponse < Struct.new(
341
+ :dominant_language_detection_job_properties)
342
+ include Aws::Structure
343
+ end
344
+
345
+ # @note When making an API call, you may pass DescribeEntitiesDetectionJobRequest
346
+ # data as a hash:
347
+ #
348
+ # {
349
+ # job_id: "JobId", # required
350
+ # }
351
+ #
352
+ # @!attribute [rw] job_id
353
+ # The identifier that Amazon Comprehend generated for the job. The
354
+ # operation returns this identifier in its response.
355
+ # @return [String]
356
+ #
357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJobRequest AWS API Documentation
358
+ #
359
+ class DescribeEntitiesDetectionJobRequest < Struct.new(
360
+ :job_id)
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @!attribute [rw] entities_detection_job_properties
365
+ # An object that contains the properties associated with an entities
366
+ # detection job.
367
+ # @return [Types::EntitiesDetectionJobProperties]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJobResponse AWS API Documentation
370
+ #
371
+ class DescribeEntitiesDetectionJobResponse < Struct.new(
372
+ :entities_detection_job_properties)
373
+ include Aws::Structure
374
+ end
375
+
376
+ # @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
377
+ # data as a hash:
378
+ #
379
+ # {
380
+ # job_id: "JobId", # required
381
+ # }
382
+ #
383
+ # @!attribute [rw] job_id
384
+ # The identifier that Amazon Comprehend generated for the job. The
385
+ # operation returns this identifier in its response.
386
+ # @return [String]
387
+ #
388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJobRequest AWS API Documentation
389
+ #
390
+ class DescribeKeyPhrasesDetectionJobRequest < Struct.new(
391
+ :job_id)
392
+ include Aws::Structure
393
+ end
394
+
395
+ # @!attribute [rw] key_phrases_detection_job_properties
396
+ # An object that contains the properties associated with a key phrases
397
+ # detection job.
398
+ # @return [Types::KeyPhrasesDetectionJobProperties]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJobResponse AWS API Documentation
401
+ #
402
+ class DescribeKeyPhrasesDetectionJobResponse < Struct.new(
403
+ :key_phrases_detection_job_properties)
404
+ include Aws::Structure
405
+ end
406
+
407
+ # @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
408
+ # data as a hash:
409
+ #
410
+ # {
411
+ # job_id: "JobId", # required
412
+ # }
413
+ #
414
+ # @!attribute [rw] job_id
415
+ # The identifier that Amazon Comprehend generated for the job. The
416
+ # operation returns this identifier in its response.
417
+ # @return [String]
418
+ #
419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJobRequest AWS API Documentation
420
+ #
421
+ class DescribeSentimentDetectionJobRequest < Struct.new(
422
+ :job_id)
423
+ include Aws::Structure
424
+ end
425
+
426
+ # @!attribute [rw] sentiment_detection_job_properties
427
+ # An object that contains the properties associated with a sentiment
428
+ # detection job.
429
+ # @return [Types::SentimentDetectionJobProperties]
430
+ #
431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJobResponse AWS API Documentation
432
+ #
433
+ class DescribeSentimentDetectionJobResponse < Struct.new(
434
+ :sentiment_detection_job_properties)
435
+ include Aws::Structure
436
+ end
437
+
311
438
  # @note When making an API call, you may pass DescribeTopicsDetectionJobRequest
312
439
  # data as a hash:
313
440
  #
@@ -390,16 +517,9 @@ module Aws::Comprehend
390
517
  # @return [String]
391
518
  #
392
519
  # @!attribute [rw] language_code
393
- # The RFC 5646 language code of the input text. If the request does
394
- # not specify the language code, the service detects the dominant
395
- # language. If you specify a language code that the service does not
396
- # support, it returns `UnsupportedLanguageException` exception. For
397
- # more information about RFC 5646, see [Tags for Identifying
398
- # Languages][1] on the *IETF Tools* web site.
399
- #
400
- #
401
- #
402
- # [1]: https://tools.ietf.org/html/rfc5646
520
+ # The language of the input documents. You can specify English
521
+ # ("en") or Spanish ("es"). All documents must be in the same
522
+ # language.
403
523
  # @return [String]
404
524
  #
405
525
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
@@ -439,16 +559,9 @@ module Aws::Comprehend
439
559
  # @return [String]
440
560
  #
441
561
  # @!attribute [rw] language_code
442
- # The RFC 5646 language code for the input text. If you don't specify
443
- # a language code, Amazon Comprehend detects the dominant language. If
444
- # you specify the code for a language that Amazon Comprehend does not
445
- # support, it returns and `UnsupportedLanguageException`. For more
446
- # information about RFC 5646, see [Tags for Identifying Languages][1]
447
- # on the *IETF Tools* web site.
448
- #
449
- #
450
- #
451
- # [1]: https://tools.ietf.org/html/rfc5646
562
+ # The language of the input documents. You can specify English
563
+ # ("en") or Spanish ("es"). All documents must be in the same
564
+ # language.
452
565
  # @return [String]
453
566
  #
454
567
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrasesRequest AWS API Documentation
@@ -488,16 +601,9 @@ module Aws::Comprehend
488
601
  # @return [String]
489
602
  #
490
603
  # @!attribute [rw] language_code
491
- # The RFC 5646 language code for the input text. If you don't specify
492
- # a language code, Amazon Comprehend detects the dominant language. If
493
- # you specify the code for a language that Amazon Comprehend does not
494
- # support, it returns and `UnsupportedLanguageException`. For more
495
- # information about RFC 5646, see [Tags for Identifying Languages][1]
496
- # on the *IETF Tools* web site.
497
- #
498
- #
499
- #
500
- # [1]: https://tools.ietf.org/html/rfc5646
604
+ # The language of the input documents. You can specify English
605
+ # ("en") or Spanish ("es"). All documents must be in the same
606
+ # language.
501
607
  # @return [String]
502
608
  #
503
609
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentimentRequest AWS API Documentation
@@ -531,7 +637,13 @@ module Aws::Comprehend
531
637
  # detection.
532
638
  #
533
639
  # @!attribute [rw] language_code
534
- # The RFC 5646 language code for the dominant language.
640
+ # The RFC 5646 language code for the dominant language. For more
641
+ # information about RFC 5646, see [Tags for Identifying Languages][1]
642
+ # on the *IETF Tools* web site.
643
+ #
644
+ #
645
+ #
646
+ # [1]: https://tools.ietf.org/html/rfc5646
535
647
  # @return [String]
536
648
  #
537
649
  # @!attribute [rw] score
@@ -547,6 +659,208 @@ module Aws::Comprehend
547
659
  include Aws::Structure
548
660
  end
549
661
 
662
+ # Provides information for filtering a list of dominant language
663
+ # detection jobs. For more information, see the operation.
664
+ #
665
+ # @note When making an API call, you may pass DominantLanguageDetectionJobFilter
666
+ # data as a hash:
667
+ #
668
+ # {
669
+ # job_name: "JobName",
670
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
671
+ # submit_time_before: Time.now,
672
+ # submit_time_after: Time.now,
673
+ # }
674
+ #
675
+ # @!attribute [rw] job_name
676
+ # Filters on the name of the job.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] job_status
680
+ # Filters the list of jobs based on job status. Returns only jobs with
681
+ # the specified status.
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] submit_time_before
685
+ # Filters the list of jobs based on the time that the job was
686
+ # submitted for processing. Returns only jobs submitted before the
687
+ # specified time. Jobs are returned in ascending order, oldest to
688
+ # newest.
689
+ # @return [Time]
690
+ #
691
+ # @!attribute [rw] submit_time_after
692
+ # Filters the list of jobs based on the time that the job was
693
+ # submitted for processing. Returns only jobs submitted after the
694
+ # specified time. Jobs are returned in descending order, newest to
695
+ # oldest.
696
+ # @return [Time]
697
+ #
698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguageDetectionJobFilter AWS API Documentation
699
+ #
700
+ class DominantLanguageDetectionJobFilter < Struct.new(
701
+ :job_name,
702
+ :job_status,
703
+ :submit_time_before,
704
+ :submit_time_after)
705
+ include Aws::Structure
706
+ end
707
+
708
+ # Provides information about a dominant language detection job.
709
+ #
710
+ # @!attribute [rw] job_id
711
+ # The identifier assigned to the dominant language detection job.
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] job_name
715
+ # The name that you assigned to the dominant language detection job.
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] job_status
719
+ # The current status of the dominant language detection job. If the
720
+ # status is `FAILED`, the `Message` field shows the reason for the
721
+ # failure.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] message
725
+ # A description for the status of a job.
726
+ # @return [String]
727
+ #
728
+ # @!attribute [rw] submit_time
729
+ # The time that the dominant language detection job was submitted for
730
+ # processing.
731
+ # @return [Time]
732
+ #
733
+ # @!attribute [rw] end_time
734
+ # The time that the dominant language detection job completed.
735
+ # @return [Time]
736
+ #
737
+ # @!attribute [rw] input_data_config
738
+ # The input data configuration that you supplied when you created the
739
+ # dominant language detection job.
740
+ # @return [Types::InputDataConfig]
741
+ #
742
+ # @!attribute [rw] output_data_config
743
+ # The output data configuration that you supplied when you created the
744
+ # dominant language detection job.
745
+ # @return [Types::OutputDataConfig]
746
+ #
747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguageDetectionJobProperties AWS API Documentation
748
+ #
749
+ class DominantLanguageDetectionJobProperties < Struct.new(
750
+ :job_id,
751
+ :job_name,
752
+ :job_status,
753
+ :message,
754
+ :submit_time,
755
+ :end_time,
756
+ :input_data_config,
757
+ :output_data_config)
758
+ include Aws::Structure
759
+ end
760
+
761
+ # Provides information for filtering a list of dominant language
762
+ # detection jobs. For more information, see the operation.
763
+ #
764
+ # @note When making an API call, you may pass EntitiesDetectionJobFilter
765
+ # data as a hash:
766
+ #
767
+ # {
768
+ # job_name: "JobName",
769
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
770
+ # submit_time_before: Time.now,
771
+ # submit_time_after: Time.now,
772
+ # }
773
+ #
774
+ # @!attribute [rw] job_name
775
+ # Filters on the name of the job.
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] job_status
779
+ # Filters the list of jobs based on job status. Returns only jobs with
780
+ # the specified status.
781
+ # @return [String]
782
+ #
783
+ # @!attribute [rw] submit_time_before
784
+ # Filters the list of jobs based on the time that the job was
785
+ # submitted for processing. Returns only jobs submitted before the
786
+ # specified time. Jobs are returned in ascending order, oldest to
787
+ # newest.
788
+ # @return [Time]
789
+ #
790
+ # @!attribute [rw] submit_time_after
791
+ # Filters the list of jobs based on the time that the job was
792
+ # submitted for processing. Returns only jobs submitted after the
793
+ # specified time. Jobs are returned in descending order, newest to
794
+ # oldest.
795
+ # @return [Time]
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobFilter AWS API Documentation
798
+ #
799
+ class EntitiesDetectionJobFilter < Struct.new(
800
+ :job_name,
801
+ :job_status,
802
+ :submit_time_before,
803
+ :submit_time_after)
804
+ include Aws::Structure
805
+ end
806
+
807
+ # Provides information about an entities detection job.
808
+ #
809
+ # @!attribute [rw] job_id
810
+ # The identifier assigned to the entities detection job.
811
+ # @return [String]
812
+ #
813
+ # @!attribute [rw] job_name
814
+ # The name that you assigned the entities detection job.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] job_status
818
+ # The current status of the entities detection job. If the status is
819
+ # `FAILED`, the `Message` field shows the reason for the failure.
820
+ # @return [String]
821
+ #
822
+ # @!attribute [rw] message
823
+ # A description of the status of a job.
824
+ # @return [String]
825
+ #
826
+ # @!attribute [rw] submit_time
827
+ # The time that the entities detection job was submitted for
828
+ # processing.
829
+ # @return [Time]
830
+ #
831
+ # @!attribute [rw] end_time
832
+ # The time that the entities detection job completed
833
+ # @return [Time]
834
+ #
835
+ # @!attribute [rw] input_data_config
836
+ # The input data configuration that you supplied when you created the
837
+ # entities detection job.
838
+ # @return [Types::InputDataConfig]
839
+ #
840
+ # @!attribute [rw] output_data_config
841
+ # The output data configuration that you supplied when you created the
842
+ # entities detection job.
843
+ # @return [Types::OutputDataConfig]
844
+ #
845
+ # @!attribute [rw] language_code
846
+ # The language code of the input documents.
847
+ # @return [String]
848
+ #
849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties AWS API Documentation
850
+ #
851
+ class EntitiesDetectionJobProperties < Struct.new(
852
+ :job_id,
853
+ :job_name,
854
+ :job_status,
855
+ :message,
856
+ :submit_time,
857
+ :end_time,
858
+ :input_data_config,
859
+ :output_data_config,
860
+ :language_code)
861
+ include Aws::Structure
862
+ end
863
+
550
864
  # Provides information about an entity.
551
865
  #
552
866
  # @!attribute [rw] score
@@ -670,13 +984,332 @@ module Aws::Comprehend
670
984
  include Aws::Structure
671
985
  end
672
986
 
673
- # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
987
+ # Provides information for filtering a list of dominant language
988
+ # detection jobs. For more information, see the operation.
989
+ #
990
+ # @note When making an API call, you may pass KeyPhrasesDetectionJobFilter
674
991
  # data as a hash:
675
992
  #
676
993
  # {
677
- # filter: {
678
- # job_name: "JobName",
679
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED
994
+ # job_name: "JobName",
995
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
996
+ # submit_time_before: Time.now,
997
+ # submit_time_after: Time.now,
998
+ # }
999
+ #
1000
+ # @!attribute [rw] job_name
1001
+ # Filters on the name of the job.
1002
+ # @return [String]
1003
+ #
1004
+ # @!attribute [rw] job_status
1005
+ # Filters the list of jobs based on job status. Returns only jobs with
1006
+ # the specified status.
1007
+ # @return [String]
1008
+ #
1009
+ # @!attribute [rw] submit_time_before
1010
+ # Filters the list of jobs based on the time that the job was
1011
+ # submitted for processing. Returns only jobs submitted before the
1012
+ # specified time. Jobs are returned in ascending order, oldest to
1013
+ # newest.
1014
+ # @return [Time]
1015
+ #
1016
+ # @!attribute [rw] submit_time_after
1017
+ # Filters the list of jobs based on the time that the job was
1018
+ # submitted for processing. Returns only jobs submitted after the
1019
+ # specified time. Jobs are returned in descending order, newest to
1020
+ # oldest.
1021
+ # @return [Time]
1022
+ #
1023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrasesDetectionJobFilter AWS API Documentation
1024
+ #
1025
+ class KeyPhrasesDetectionJobFilter < Struct.new(
1026
+ :job_name,
1027
+ :job_status,
1028
+ :submit_time_before,
1029
+ :submit_time_after)
1030
+ include Aws::Structure
1031
+ end
1032
+
1033
+ # Provides information about a key phrases detection job.
1034
+ #
1035
+ # @!attribute [rw] job_id
1036
+ # The identifier assigned to the key phrases detection job.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] job_name
1040
+ # The name that you assigned the key phrases detection job.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] job_status
1044
+ # The current status of the key phrases detection job. If the status
1045
+ # is `FAILED`, the `Message` field shows the reason for the failure.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] message
1049
+ # A description of the status of a job.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] submit_time
1053
+ # The time that the key phrases detection job was submitted for
1054
+ # processing.
1055
+ # @return [Time]
1056
+ #
1057
+ # @!attribute [rw] end_time
1058
+ # The time that the key phrases detection job completed.
1059
+ # @return [Time]
1060
+ #
1061
+ # @!attribute [rw] input_data_config
1062
+ # The input data configuration that you supplied when you created the
1063
+ # key phrases detection job.
1064
+ # @return [Types::InputDataConfig]
1065
+ #
1066
+ # @!attribute [rw] output_data_config
1067
+ # The output data configuration that you supplied when you created the
1068
+ # key phrases detection job.
1069
+ # @return [Types::OutputDataConfig]
1070
+ #
1071
+ # @!attribute [rw] language_code
1072
+ # The language code of the input documents.
1073
+ # @return [String]
1074
+ #
1075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrasesDetectionJobProperties AWS API Documentation
1076
+ #
1077
+ class KeyPhrasesDetectionJobProperties < Struct.new(
1078
+ :job_id,
1079
+ :job_name,
1080
+ :job_status,
1081
+ :message,
1082
+ :submit_time,
1083
+ :end_time,
1084
+ :input_data_config,
1085
+ :output_data_config,
1086
+ :language_code)
1087
+ include Aws::Structure
1088
+ end
1089
+
1090
+ # @note When making an API call, you may pass ListDominantLanguageDetectionJobsRequest
1091
+ # data as a hash:
1092
+ #
1093
+ # {
1094
+ # filter: {
1095
+ # job_name: "JobName",
1096
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
1097
+ # submit_time_before: Time.now,
1098
+ # submit_time_after: Time.now,
1099
+ # },
1100
+ # next_token: "String",
1101
+ # max_results: 1,
1102
+ # }
1103
+ #
1104
+ # @!attribute [rw] filter
1105
+ # Filters that jobs that are returned. You can filter jobs on their
1106
+ # name, status, or the date and time that they were submitted. You can
1107
+ # only set one filter at a time.
1108
+ # @return [Types::DominantLanguageDetectionJobFilter]
1109
+ #
1110
+ # @!attribute [rw] next_token
1111
+ # Identifies the next page of results to return.
1112
+ # @return [String]
1113
+ #
1114
+ # @!attribute [rw] max_results
1115
+ # The maximum number of results to return in each page. The default is
1116
+ # 100.
1117
+ # @return [Integer]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobsRequest AWS API Documentation
1120
+ #
1121
+ class ListDominantLanguageDetectionJobsRequest < Struct.new(
1122
+ :filter,
1123
+ :next_token,
1124
+ :max_results)
1125
+ include Aws::Structure
1126
+ end
1127
+
1128
+ # @!attribute [rw] dominant_language_detection_job_properties_list
1129
+ # A list containing the properties of each job that is returned.
1130
+ # @return [Array<Types::DominantLanguageDetectionJobProperties>]
1131
+ #
1132
+ # @!attribute [rw] next_token
1133
+ # Identifies the next page of results to return.
1134
+ # @return [String]
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobsResponse AWS API Documentation
1137
+ #
1138
+ class ListDominantLanguageDetectionJobsResponse < Struct.new(
1139
+ :dominant_language_detection_job_properties_list,
1140
+ :next_token)
1141
+ include Aws::Structure
1142
+ end
1143
+
1144
+ # @note When making an API call, you may pass ListEntitiesDetectionJobsRequest
1145
+ # data as a hash:
1146
+ #
1147
+ # {
1148
+ # filter: {
1149
+ # job_name: "JobName",
1150
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
1151
+ # submit_time_before: Time.now,
1152
+ # submit_time_after: Time.now,
1153
+ # },
1154
+ # next_token: "String",
1155
+ # max_results: 1,
1156
+ # }
1157
+ #
1158
+ # @!attribute [rw] filter
1159
+ # Filters the jobs that are returned. You can filter jobs on their
1160
+ # name, status, or the date and time that they were submitted. You can
1161
+ # only set one filter at a time.
1162
+ # @return [Types::EntitiesDetectionJobFilter]
1163
+ #
1164
+ # @!attribute [rw] next_token
1165
+ # Identifies the next page of results to return.
1166
+ # @return [String]
1167
+ #
1168
+ # @!attribute [rw] max_results
1169
+ # The maximum number of results to return in each page. The default is
1170
+ # 100.
1171
+ # @return [Integer]
1172
+ #
1173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobsRequest AWS API Documentation
1174
+ #
1175
+ class ListEntitiesDetectionJobsRequest < Struct.new(
1176
+ :filter,
1177
+ :next_token,
1178
+ :max_results)
1179
+ include Aws::Structure
1180
+ end
1181
+
1182
+ # @!attribute [rw] entities_detection_job_properties_list
1183
+ # A list containing the properties of each job that is returned.
1184
+ # @return [Array<Types::EntitiesDetectionJobProperties>]
1185
+ #
1186
+ # @!attribute [rw] next_token
1187
+ # Identifies the next page of results to return.
1188
+ # @return [String]
1189
+ #
1190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobsResponse AWS API Documentation
1191
+ #
1192
+ class ListEntitiesDetectionJobsResponse < Struct.new(
1193
+ :entities_detection_job_properties_list,
1194
+ :next_token)
1195
+ include Aws::Structure
1196
+ end
1197
+
1198
+ # @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
1199
+ # data as a hash:
1200
+ #
1201
+ # {
1202
+ # filter: {
1203
+ # job_name: "JobName",
1204
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
1205
+ # submit_time_before: Time.now,
1206
+ # submit_time_after: Time.now,
1207
+ # },
1208
+ # next_token: "String",
1209
+ # max_results: 1,
1210
+ # }
1211
+ #
1212
+ # @!attribute [rw] filter
1213
+ # Filters the jobs that are returned. You can filter jobs on their
1214
+ # name, status, or the date and time that they were submitted. You can
1215
+ # only set one filter at a time.
1216
+ # @return [Types::KeyPhrasesDetectionJobFilter]
1217
+ #
1218
+ # @!attribute [rw] next_token
1219
+ # Identifies the next page of results to return.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] max_results
1223
+ # The maximum number of results to return in each page. The default is
1224
+ # 100.
1225
+ # @return [Integer]
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobsRequest AWS API Documentation
1228
+ #
1229
+ class ListKeyPhrasesDetectionJobsRequest < Struct.new(
1230
+ :filter,
1231
+ :next_token,
1232
+ :max_results)
1233
+ include Aws::Structure
1234
+ end
1235
+
1236
+ # @!attribute [rw] key_phrases_detection_job_properties_list
1237
+ # A list containing the properties of each job that is returned.
1238
+ # @return [Array<Types::KeyPhrasesDetectionJobProperties>]
1239
+ #
1240
+ # @!attribute [rw] next_token
1241
+ # Identifies the next page of results to return.
1242
+ # @return [String]
1243
+ #
1244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobsResponse AWS API Documentation
1245
+ #
1246
+ class ListKeyPhrasesDetectionJobsResponse < Struct.new(
1247
+ :key_phrases_detection_job_properties_list,
1248
+ :next_token)
1249
+ include Aws::Structure
1250
+ end
1251
+
1252
+ # @note When making an API call, you may pass ListSentimentDetectionJobsRequest
1253
+ # data as a hash:
1254
+ #
1255
+ # {
1256
+ # filter: {
1257
+ # job_name: "JobName",
1258
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
1259
+ # submit_time_before: Time.now,
1260
+ # submit_time_after: Time.now,
1261
+ # },
1262
+ # next_token: "String",
1263
+ # max_results: 1,
1264
+ # }
1265
+ #
1266
+ # @!attribute [rw] filter
1267
+ # Filters the jobs that are returned. You can filter jobs on their
1268
+ # name, status, or the date and time that they were submitted. You can
1269
+ # only set one filter at a time.
1270
+ # @return [Types::SentimentDetectionJobFilter]
1271
+ #
1272
+ # @!attribute [rw] next_token
1273
+ # Identifies the next page of results to return.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] max_results
1277
+ # The maximum number of results to return in each page. The default is
1278
+ # 100.
1279
+ # @return [Integer]
1280
+ #
1281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobsRequest AWS API Documentation
1282
+ #
1283
+ class ListSentimentDetectionJobsRequest < Struct.new(
1284
+ :filter,
1285
+ :next_token,
1286
+ :max_results)
1287
+ include Aws::Structure
1288
+ end
1289
+
1290
+ # @!attribute [rw] sentiment_detection_job_properties_list
1291
+ # A list containing the properties of each job that is returned.
1292
+ # @return [Array<Types::SentimentDetectionJobProperties>]
1293
+ #
1294
+ # @!attribute [rw] next_token
1295
+ # Identifies the next page of results to return.
1296
+ # @return [String]
1297
+ #
1298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobsResponse AWS API Documentation
1299
+ #
1300
+ class ListSentimentDetectionJobsResponse < Struct.new(
1301
+ :sentiment_detection_job_properties_list,
1302
+ :next_token)
1303
+ include Aws::Structure
1304
+ end
1305
+
1306
+ # @note When making an API call, you may pass ListTopicsDetectionJobsRequest
1307
+ # data as a hash:
1308
+ #
1309
+ # {
1310
+ # filter: {
1311
+ # job_name: "JobName",
1312
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
680
1313
  # submit_time_before: Time.now,
681
1314
  # submit_time_after: Time.now,
682
1315
  # },
@@ -684,103 +1317,557 @@ module Aws::Comprehend
684
1317
  # max_results: 1,
685
1318
  # }
686
1319
  #
687
- # @!attribute [rw] filter
688
- # Filters the jobs that are returned. Jobs can be filtered on their
689
- # name, status, or the date and time that they were submitted. You can
690
- # set only one filter at a time.
691
- # @return [Types::TopicsDetectionJobFilter]
1320
+ # @!attribute [rw] filter
1321
+ # Filters the jobs that are returned. Jobs can be filtered on their
1322
+ # name, status, or the date and time that they were submitted. You can
1323
+ # set only one filter at a time.
1324
+ # @return [Types::TopicsDetectionJobFilter]
1325
+ #
1326
+ # @!attribute [rw] next_token
1327
+ # Identifies the next page of results to return.
1328
+ # @return [String]
1329
+ #
1330
+ # @!attribute [rw] max_results
1331
+ # The maximum number of results to return in each page. The default is
1332
+ # 100.
1333
+ # @return [Integer]
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsRequest AWS API Documentation
1336
+ #
1337
+ class ListTopicsDetectionJobsRequest < Struct.new(
1338
+ :filter,
1339
+ :next_token,
1340
+ :max_results)
1341
+ include Aws::Structure
1342
+ end
1343
+
1344
+ # @!attribute [rw] topics_detection_job_properties_list
1345
+ # A list containing the properties of each job that is returned.
1346
+ # @return [Array<Types::TopicsDetectionJobProperties>]
1347
+ #
1348
+ # @!attribute [rw] next_token
1349
+ # Identifies the next page of results to return.
1350
+ # @return [String]
1351
+ #
1352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsResponse AWS API Documentation
1353
+ #
1354
+ class ListTopicsDetectionJobsResponse < Struct.new(
1355
+ :topics_detection_job_properties_list,
1356
+ :next_token)
1357
+ include Aws::Structure
1358
+ end
1359
+
1360
+ # Provides configuration parameters for the output of topic detection
1361
+ # jobs.
1362
+ #
1363
+ # @note When making an API call, you may pass OutputDataConfig
1364
+ # data as a hash:
1365
+ #
1366
+ # {
1367
+ # s3_uri: "S3Uri", # required
1368
+ # }
1369
+ #
1370
+ # @!attribute [rw] s3_uri
1371
+ # When you use the `OutputDataConfig` object with asynchronous
1372
+ # operations, you specify the Amazon S3 location where you want to
1373
+ # write the output data. The URI must be in the same region as the API
1374
+ # endpoint that you are calling. The location is used as the prefix
1375
+ # for the actual location of the output file.
1376
+ #
1377
+ # When the topic detection job is finished, the service creates an
1378
+ # output file in a directory specific to the job. The `S3Uri` field
1379
+ # contains the location of the output file, called `output.tar.gz`. It
1380
+ # is a compressed archive that contains the ouput of the operation.
1381
+ # @return [String]
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/OutputDataConfig AWS API Documentation
1384
+ #
1385
+ class OutputDataConfig < Struct.new(
1386
+ :s3_uri)
1387
+ include Aws::Structure
1388
+ end
1389
+
1390
+ # Provides information for filtering a list of dominant language
1391
+ # detection jobs. For more information, see the operation.
1392
+ #
1393
+ # @note When making an API call, you may pass SentimentDetectionJobFilter
1394
+ # data as a hash:
1395
+ #
1396
+ # {
1397
+ # job_name: "JobName",
1398
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
1399
+ # submit_time_before: Time.now,
1400
+ # submit_time_after: Time.now,
1401
+ # }
1402
+ #
1403
+ # @!attribute [rw] job_name
1404
+ # Filters on the name of the job.
1405
+ # @return [String]
1406
+ #
1407
+ # @!attribute [rw] job_status
1408
+ # Filters the list of jobs based on job status. Returns only jobs with
1409
+ # the specified status.
1410
+ # @return [String]
1411
+ #
1412
+ # @!attribute [rw] submit_time_before
1413
+ # Filters the list of jobs based on the time that the job was
1414
+ # submitted for processing. Returns only jobs submitted before the
1415
+ # specified time. Jobs are returned in ascending order, oldest to
1416
+ # newest.
1417
+ # @return [Time]
1418
+ #
1419
+ # @!attribute [rw] submit_time_after
1420
+ # Filters the list of jobs based on the time that the job was
1421
+ # submitted for processing. Returns only jobs submitted after the
1422
+ # specified time. Jobs are returned in descending order, newest to
1423
+ # oldest.
1424
+ # @return [Time]
1425
+ #
1426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentDetectionJobFilter AWS API Documentation
1427
+ #
1428
+ class SentimentDetectionJobFilter < Struct.new(
1429
+ :job_name,
1430
+ :job_status,
1431
+ :submit_time_before,
1432
+ :submit_time_after)
1433
+ include Aws::Structure
1434
+ end
1435
+
1436
+ # Provides information about a sentiment detection job.
1437
+ #
1438
+ # @!attribute [rw] job_id
1439
+ # The identifier assigned to the sentiment detection job.
1440
+ # @return [String]
1441
+ #
1442
+ # @!attribute [rw] job_name
1443
+ # The name that you assigned to the sentiment detection job
1444
+ # @return [String]
1445
+ #
1446
+ # @!attribute [rw] job_status
1447
+ # The current status of the sentiment detection job. If the status is
1448
+ # `FAILED`, the `Messages` field shows the reason for the failure.
1449
+ # @return [String]
1450
+ #
1451
+ # @!attribute [rw] message
1452
+ # A description of the status of a job.
1453
+ # @return [String]
1454
+ #
1455
+ # @!attribute [rw] submit_time
1456
+ # The time that the sentiment detection job was submitted for
1457
+ # processing.
1458
+ # @return [Time]
1459
+ #
1460
+ # @!attribute [rw] end_time
1461
+ # The time that the sentiment detection job ended.
1462
+ # @return [Time]
1463
+ #
1464
+ # @!attribute [rw] input_data_config
1465
+ # The input data configuration that you supplied when you created the
1466
+ # sentiment detection job.
1467
+ # @return [Types::InputDataConfig]
1468
+ #
1469
+ # @!attribute [rw] output_data_config
1470
+ # The output data configuration that you supplied when you created the
1471
+ # sentiment detection job.
1472
+ # @return [Types::OutputDataConfig]
1473
+ #
1474
+ # @!attribute [rw] language_code
1475
+ # The language code of the input documents.
1476
+ # @return [String]
1477
+ #
1478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentDetectionJobProperties AWS API Documentation
1479
+ #
1480
+ class SentimentDetectionJobProperties < Struct.new(
1481
+ :job_id,
1482
+ :job_name,
1483
+ :job_status,
1484
+ :message,
1485
+ :submit_time,
1486
+ :end_time,
1487
+ :input_data_config,
1488
+ :output_data_config,
1489
+ :language_code)
1490
+ include Aws::Structure
1491
+ end
1492
+
1493
+ # Describes the level of confidence that Amazon Comprehend has in the
1494
+ # accuracy of its detection of sentiments.
1495
+ #
1496
+ # @!attribute [rw] positive
1497
+ # The level of confidence that Amazon Comprehend has in the accuracy
1498
+ # of its detection of the `POSITIVE` sentiment.
1499
+ # @return [Float]
1500
+ #
1501
+ # @!attribute [rw] negative
1502
+ # The level of confidence that Amazon Comprehend has in the accuracy
1503
+ # of its detection of the `NEGATIVE` sentiment.
1504
+ # @return [Float]
1505
+ #
1506
+ # @!attribute [rw] neutral
1507
+ # The level of confidence that Amazon Comprehend has in the accuracy
1508
+ # of its detection of the `NEUTRAL` sentiment.
1509
+ # @return [Float]
1510
+ #
1511
+ # @!attribute [rw] mixed
1512
+ # The level of confidence that Amazon Comprehend has in the accuracy
1513
+ # of its detection of the `MIXED` sentiment.
1514
+ # @return [Float]
1515
+ #
1516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentScore AWS API Documentation
1517
+ #
1518
+ class SentimentScore < Struct.new(
1519
+ :positive,
1520
+ :negative,
1521
+ :neutral,
1522
+ :mixed)
1523
+ include Aws::Structure
1524
+ end
1525
+
1526
+ # @note When making an API call, you may pass StartDominantLanguageDetectionJobRequest
1527
+ # data as a hash:
1528
+ #
1529
+ # {
1530
+ # input_data_config: { # required
1531
+ # s3_uri: "S3Uri", # required
1532
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1533
+ # },
1534
+ # output_data_config: { # required
1535
+ # s3_uri: "S3Uri", # required
1536
+ # },
1537
+ # data_access_role_arn: "IamRoleArn", # required
1538
+ # job_name: "JobName",
1539
+ # client_request_token: "ClientRequestTokenString",
1540
+ # }
1541
+ #
1542
+ # @!attribute [rw] input_data_config
1543
+ # Specifies the format and location of the input data for the job.
1544
+ # @return [Types::InputDataConfig]
1545
+ #
1546
+ # @!attribute [rw] output_data_config
1547
+ # Specifies where to send the output files.
1548
+ # @return [Types::OutputDataConfig]
1549
+ #
1550
+ # @!attribute [rw] data_access_role_arn
1551
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1552
+ # (IAM) role that grants Amazon Comprehend read access to your input
1553
+ # data.
1554
+ # @return [String]
1555
+ #
1556
+ # @!attribute [rw] job_name
1557
+ # An identifier for the job.
1558
+ # @return [String]
1559
+ #
1560
+ # @!attribute [rw] client_request_token
1561
+ # A unique identifier for the request. If you do not set the client
1562
+ # request token, Amazon Comprehend generates one.
1563
+ #
1564
+ # **A suitable default value is auto-generated.** You should normally
1565
+ # not need to pass this option.
1566
+ # @return [String]
1567
+ #
1568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
1569
+ #
1570
+ class StartDominantLanguageDetectionJobRequest < Struct.new(
1571
+ :input_data_config,
1572
+ :output_data_config,
1573
+ :data_access_role_arn,
1574
+ :job_name,
1575
+ :client_request_token)
1576
+ include Aws::Structure
1577
+ end
1578
+
1579
+ # @!attribute [rw] job_id
1580
+ # The identifier generated for the job. To get the status of a job,
1581
+ # use this identifier with the operation.
1582
+ # @return [String]
1583
+ #
1584
+ # @!attribute [rw] job_status
1585
+ # The status of the job.
1586
+ #
1587
+ # * SUBMITTED - The job has been received and is queued for
1588
+ # processing.
1589
+ #
1590
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
1591
+ #
1592
+ # * COMPLETED - The job was successfully completed and the output is
1593
+ # available.
1594
+ #
1595
+ # * FAILED - The job did not complete. To get details, use the
1596
+ # operation.
1597
+ # @return [String]
1598
+ #
1599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobResponse AWS API Documentation
1600
+ #
1601
+ class StartDominantLanguageDetectionJobResponse < Struct.new(
1602
+ :job_id,
1603
+ :job_status)
1604
+ include Aws::Structure
1605
+ end
1606
+
1607
+ # @note When making an API call, you may pass StartEntitiesDetectionJobRequest
1608
+ # data as a hash:
1609
+ #
1610
+ # {
1611
+ # input_data_config: { # required
1612
+ # s3_uri: "S3Uri", # required
1613
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1614
+ # },
1615
+ # output_data_config: { # required
1616
+ # s3_uri: "S3Uri", # required
1617
+ # },
1618
+ # data_access_role_arn: "IamRoleArn", # required
1619
+ # job_name: "JobName",
1620
+ # language_code: "en", # required, accepts en, es
1621
+ # client_request_token: "ClientRequestTokenString",
1622
+ # }
1623
+ #
1624
+ # @!attribute [rw] input_data_config
1625
+ # Specifies the format and location of the input data for the job.
1626
+ # @return [Types::InputDataConfig]
1627
+ #
1628
+ # @!attribute [rw] output_data_config
1629
+ # Specifies where to send the output files.
1630
+ # @return [Types::OutputDataConfig]
1631
+ #
1632
+ # @!attribute [rw] data_access_role_arn
1633
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1634
+ # (IAM) role that grants Amazon Comprehend read access to your input
1635
+ # data.
1636
+ # @return [String]
1637
+ #
1638
+ # @!attribute [rw] job_name
1639
+ # The identifier of the job.
1640
+ # @return [String]
1641
+ #
1642
+ # @!attribute [rw] language_code
1643
+ # The language of the input documents. You can specify English
1644
+ # ("en") or Spanish ("es"). All documents must be in the same
1645
+ # language.
1646
+ # @return [String]
1647
+ #
1648
+ # @!attribute [rw] client_request_token
1649
+ # A unique identifier for the request. If you don't set the client
1650
+ # request token, Amazon Comprehend generates one.
1651
+ #
1652
+ # **A suitable default value is auto-generated.** You should normally
1653
+ # not need to pass this option.
1654
+ # @return [String]
1655
+ #
1656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
1657
+ #
1658
+ class StartEntitiesDetectionJobRequest < Struct.new(
1659
+ :input_data_config,
1660
+ :output_data_config,
1661
+ :data_access_role_arn,
1662
+ :job_name,
1663
+ :language_code,
1664
+ :client_request_token)
1665
+ include Aws::Structure
1666
+ end
1667
+
1668
+ # @!attribute [rw] job_id
1669
+ # The identifier generated for the job. To get the status of job, use
1670
+ # this identifier with the operation.
1671
+ # @return [String]
1672
+ #
1673
+ # @!attribute [rw] job_status
1674
+ # The status of the job.
1675
+ #
1676
+ # * SUBMITTED - The job has been received and is queued for
1677
+ # processing.
1678
+ #
1679
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
1680
+ #
1681
+ # * COMPLETED - The job was successfully completed and the output is
1682
+ # available.
1683
+ #
1684
+ # * FAILED - The job did not complete. To get details, use the
1685
+ # operation.
1686
+ # @return [String]
1687
+ #
1688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobResponse AWS API Documentation
1689
+ #
1690
+ class StartEntitiesDetectionJobResponse < Struct.new(
1691
+ :job_id,
1692
+ :job_status)
1693
+ include Aws::Structure
1694
+ end
1695
+
1696
+ # @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
1697
+ # data as a hash:
1698
+ #
1699
+ # {
1700
+ # input_data_config: { # required
1701
+ # s3_uri: "S3Uri", # required
1702
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1703
+ # },
1704
+ # output_data_config: { # required
1705
+ # s3_uri: "S3Uri", # required
1706
+ # },
1707
+ # data_access_role_arn: "IamRoleArn", # required
1708
+ # job_name: "JobName",
1709
+ # language_code: "en", # required, accepts en, es
1710
+ # client_request_token: "ClientRequestTokenString",
1711
+ # }
1712
+ #
1713
+ # @!attribute [rw] input_data_config
1714
+ # Specifies the format and location of the input data for the job.
1715
+ # @return [Types::InputDataConfig]
692
1716
  #
693
- # @!attribute [rw] next_token
694
- # Identifies the next page of results to return.
1717
+ # @!attribute [rw] output_data_config
1718
+ # Specifies where to send the output files.
1719
+ # @return [Types::OutputDataConfig]
1720
+ #
1721
+ # @!attribute [rw] data_access_role_arn
1722
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1723
+ # (IAM) role that grants Amazon Comprehend read access to your input
1724
+ # data.
695
1725
  # @return [String]
696
1726
  #
697
- # @!attribute [rw] max_results
698
- # The maximum number of results to return in each page.
699
- # @return [Integer]
1727
+ # @!attribute [rw] job_name
1728
+ # The identifier of the job.
1729
+ # @return [String]
700
1730
  #
701
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsRequest AWS API Documentation
1731
+ # @!attribute [rw] language_code
1732
+ # The language of the input documents. You can specify English
1733
+ # ("en") or Spanish ("es"). All documents must be in the same
1734
+ # language.
1735
+ # @return [String]
702
1736
  #
703
- class ListTopicsDetectionJobsRequest < Struct.new(
704
- :filter,
705
- :next_token,
706
- :max_results)
1737
+ # @!attribute [rw] client_request_token
1738
+ # A unique identifier for the request. If you don't set the client
1739
+ # request token, Amazon Comprehend generates one.
1740
+ #
1741
+ # **A suitable default value is auto-generated.** You should normally
1742
+ # not need to pass this option.
1743
+ # @return [String]
1744
+ #
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJobRequest AWS API Documentation
1746
+ #
1747
+ class StartKeyPhrasesDetectionJobRequest < Struct.new(
1748
+ :input_data_config,
1749
+ :output_data_config,
1750
+ :data_access_role_arn,
1751
+ :job_name,
1752
+ :language_code,
1753
+ :client_request_token)
707
1754
  include Aws::Structure
708
1755
  end
709
1756
 
710
- # @!attribute [rw] topics_detection_job_properties_list
711
- # A list containing the properties of each job that is returned.
712
- # @return [Array<Types::TopicsDetectionJobProperties>]
1757
+ # @!attribute [rw] job_id
1758
+ # The identifier generated for the job. To get the status of a job,
1759
+ # use this identifier with the operation.
1760
+ # @return [String]
713
1761
  #
714
- # @!attribute [rw] next_token
715
- # Identifies the next page of results to return.
1762
+ # @!attribute [rw] job_status
1763
+ # The status of the job.
1764
+ #
1765
+ # * SUBMITTED - The job has been received and is queued for
1766
+ # processing.
1767
+ #
1768
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
1769
+ #
1770
+ # * COMPLETED - The job was successfully completed and the output is
1771
+ # available.
1772
+ #
1773
+ # * FAILED - The job did not complete. To get details, use the
1774
+ # operation.
716
1775
  # @return [String]
717
1776
  #
718
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsResponse AWS API Documentation
1777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJobResponse AWS API Documentation
719
1778
  #
720
- class ListTopicsDetectionJobsResponse < Struct.new(
721
- :topics_detection_job_properties_list,
722
- :next_token)
1779
+ class StartKeyPhrasesDetectionJobResponse < Struct.new(
1780
+ :job_id,
1781
+ :job_status)
723
1782
  include Aws::Structure
724
1783
  end
725
1784
 
726
- # Provides configuration parameters for the output of topic detection
727
- # jobs.
728
- #
729
- # @note When making an API call, you may pass OutputDataConfig
1785
+ # @note When making an API call, you may pass StartSentimentDetectionJobRequest
730
1786
  # data as a hash:
731
1787
  #
732
1788
  # {
733
- # s3_uri: "S3Uri", # required
1789
+ # input_data_config: { # required
1790
+ # s3_uri: "S3Uri", # required
1791
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1792
+ # },
1793
+ # output_data_config: { # required
1794
+ # s3_uri: "S3Uri", # required
1795
+ # },
1796
+ # data_access_role_arn: "IamRoleArn", # required
1797
+ # job_name: "JobName",
1798
+ # language_code: "en", # required, accepts en, es
1799
+ # client_request_token: "ClientRequestTokenString",
734
1800
  # }
735
1801
  #
736
- # @!attribute [rw] s3_uri
737
- # The Amazon S3 URI where you want to write the output data. The URI
738
- # must be in the same region as the API endpoint that you are calling.
1802
+ # @!attribute [rw] input_data_config
1803
+ # Specifies the format and location of the input data for the job.
1804
+ # @return [Types::InputDataConfig]
1805
+ #
1806
+ # @!attribute [rw] output_data_config
1807
+ # Specifies where to send the output files.
1808
+ # @return [Types::OutputDataConfig]
739
1809
  #
740
- # The service creates an output file called `output.tar.gz`. It is a
741
- # compressed archive that contains two files, `topic-terms.csv` that
742
- # lists the terms associated with each topic, and `doc-topics.csv`
743
- # that lists the documents associated with each topic. For more
744
- # information, see topic-modeling.
1810
+ # @!attribute [rw] data_access_role_arn
1811
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1812
+ # (IAM) role that grants Amazon Comprehend read access to your input
1813
+ # data.
745
1814
  # @return [String]
746
1815
  #
747
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/OutputDataConfig AWS API Documentation
1816
+ # @!attribute [rw] job_name
1817
+ # The identifier of the job.
1818
+ # @return [String]
748
1819
  #
749
- class OutputDataConfig < Struct.new(
750
- :s3_uri)
1820
+ # @!attribute [rw] language_code
1821
+ # The language of the input documents. You can specify English
1822
+ # ("en") or Spanish ("es"). All documents must be in the same
1823
+ # language.
1824
+ # @return [String]
1825
+ #
1826
+ # @!attribute [rw] client_request_token
1827
+ # A unique identifier for the request. If you don't set the client
1828
+ # request token, Amazon Comprehend generates one.
1829
+ #
1830
+ # **A suitable default value is auto-generated.** You should normally
1831
+ # not need to pass this option.
1832
+ # @return [String]
1833
+ #
1834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJobRequest AWS API Documentation
1835
+ #
1836
+ class StartSentimentDetectionJobRequest < Struct.new(
1837
+ :input_data_config,
1838
+ :output_data_config,
1839
+ :data_access_role_arn,
1840
+ :job_name,
1841
+ :language_code,
1842
+ :client_request_token)
751
1843
  include Aws::Structure
752
1844
  end
753
1845
 
754
- # Describes the level of confidence that Amazon Comprehend has in the
755
- # accuracy of its detection of sentiments.
1846
+ # @!attribute [rw] job_id
1847
+ # The identifier generated for the job. To get the status of a job,
1848
+ # use this identifier with the operation.
1849
+ # @return [String]
756
1850
  #
757
- # @!attribute [rw] positive
758
- # The level of confidence that Amazon Comprehend has in the accuracy
759
- # of its detection of the `POSITIVE` sentiment.
760
- # @return [Float]
1851
+ # @!attribute [rw] job_status
1852
+ # The status of the job.
761
1853
  #
762
- # @!attribute [rw] negative
763
- # The level of confidence that Amazon Comprehend has in the accuracy
764
- # of its detection of the `NEGATIVE` sentiment.
765
- # @return [Float]
1854
+ # * SUBMITTED - The job has been received and is queued for
1855
+ # processing.
766
1856
  #
767
- # @!attribute [rw] neutral
768
- # The level of confidence that Amazon Comprehend has in the accuracy
769
- # of its detection of the `NEUTRAL` sentiment.
770
- # @return [Float]
1857
+ # * IN\_PROGRESS - Amazon Comprehend is processing the job.
771
1858
  #
772
- # @!attribute [rw] mixed
773
- # The level of confidence that Amazon Comprehend has in the accuracy
774
- # of its detection of the `MIXED` sentiment.
775
- # @return [Float]
1859
+ # * COMPLETED - The job was successfully completed and the output is
1860
+ # available.
776
1861
  #
777
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentScore AWS API Documentation
1862
+ # * FAILED - The job did not complete. To get details, use the
1863
+ # operation.
1864
+ # @return [String]
778
1865
  #
779
- class SentimentScore < Struct.new(
780
- :positive,
781
- :negative,
782
- :neutral,
783
- :mixed)
1866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJobResponse AWS API Documentation
1867
+ #
1868
+ class StartSentimentDetectionJobResponse < Struct.new(
1869
+ :job_id,
1870
+ :job_status)
784
1871
  include Aws::Structure
785
1872
  end
786
1873
 
@@ -806,7 +1893,10 @@ module Aws::Comprehend
806
1893
  # @return [Types::InputDataConfig]
807
1894
  #
808
1895
  # @!attribute [rw] output_data_config
809
- # Specifies where to send the output files.
1896
+ # Specifies where to send the output files. The output is a compressed
1897
+ # archive with two files, `topic-terms.csv` that lists the terms
1898
+ # associated with each topic, and `doc-topics.csv` that lists the
1899
+ # documents associated with each topic
810
1900
  # @return [Types::OutputDataConfig]
811
1901
  #
812
1902
  # @!attribute [rw] data_access_role_arn
@@ -871,6 +1961,150 @@ module Aws::Comprehend
871
1961
  include Aws::Structure
872
1962
  end
873
1963
 
1964
+ # @note When making an API call, you may pass StopDominantLanguageDetectionJobRequest
1965
+ # data as a hash:
1966
+ #
1967
+ # {
1968
+ # job_id: "JobId", # required
1969
+ # }
1970
+ #
1971
+ # @!attribute [rw] job_id
1972
+ # The identifier of the dominant language detection job to stop.
1973
+ # @return [String]
1974
+ #
1975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJobRequest AWS API Documentation
1976
+ #
1977
+ class StopDominantLanguageDetectionJobRequest < Struct.new(
1978
+ :job_id)
1979
+ include Aws::Structure
1980
+ end
1981
+
1982
+ # @!attribute [rw] job_id
1983
+ # The identifier of the dominant language detection job to stop.
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] job_status
1987
+ # Either `STOPPING` if the job is currently running, or `STOPPED` if
1988
+ # the job was previously stopped with the
1989
+ # `StopDominantLanguageDetectionJob` operation.
1990
+ # @return [String]
1991
+ #
1992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJobResponse AWS API Documentation
1993
+ #
1994
+ class StopDominantLanguageDetectionJobResponse < Struct.new(
1995
+ :job_id,
1996
+ :job_status)
1997
+ include Aws::Structure
1998
+ end
1999
+
2000
+ # @note When making an API call, you may pass StopEntitiesDetectionJobRequest
2001
+ # data as a hash:
2002
+ #
2003
+ # {
2004
+ # job_id: "JobId", # required
2005
+ # }
2006
+ #
2007
+ # @!attribute [rw] job_id
2008
+ # The identifier of the entities detection job to stop.
2009
+ # @return [String]
2010
+ #
2011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJobRequest AWS API Documentation
2012
+ #
2013
+ class StopEntitiesDetectionJobRequest < Struct.new(
2014
+ :job_id)
2015
+ include Aws::Structure
2016
+ end
2017
+
2018
+ # @!attribute [rw] job_id
2019
+ # The identifier of the entities detection job to stop.
2020
+ # @return [String]
2021
+ #
2022
+ # @!attribute [rw] job_status
2023
+ # Either `STOPPING` if the job is currently running, or `STOPPED` if
2024
+ # the job was previously stopped with the `StopEntitiesDetectionJob`
2025
+ # operation.
2026
+ # @return [String]
2027
+ #
2028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJobResponse AWS API Documentation
2029
+ #
2030
+ class StopEntitiesDetectionJobResponse < Struct.new(
2031
+ :job_id,
2032
+ :job_status)
2033
+ include Aws::Structure
2034
+ end
2035
+
2036
+ # @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
2037
+ # data as a hash:
2038
+ #
2039
+ # {
2040
+ # job_id: "JobId", # required
2041
+ # }
2042
+ #
2043
+ # @!attribute [rw] job_id
2044
+ # The identifier of the key phrases detection job to stop.
2045
+ # @return [String]
2046
+ #
2047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJobRequest AWS API Documentation
2048
+ #
2049
+ class StopKeyPhrasesDetectionJobRequest < Struct.new(
2050
+ :job_id)
2051
+ include Aws::Structure
2052
+ end
2053
+
2054
+ # @!attribute [rw] job_id
2055
+ # The identifier of the key phrases detection job to stop.
2056
+ # @return [String]
2057
+ #
2058
+ # @!attribute [rw] job_status
2059
+ # Either `STOPPING` if the job is currently running, or `STOPPED` if
2060
+ # the job was previously stopped with the `StopKeyPhrasesDetectionJob`
2061
+ # operation.
2062
+ # @return [String]
2063
+ #
2064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJobResponse AWS API Documentation
2065
+ #
2066
+ class StopKeyPhrasesDetectionJobResponse < Struct.new(
2067
+ :job_id,
2068
+ :job_status)
2069
+ include Aws::Structure
2070
+ end
2071
+
2072
+ # @note When making an API call, you may pass StopSentimentDetectionJobRequest
2073
+ # data as a hash:
2074
+ #
2075
+ # {
2076
+ # job_id: "JobId", # required
2077
+ # }
2078
+ #
2079
+ # @!attribute [rw] job_id
2080
+ # The identifier of the sentiment detection job to stop.
2081
+ # @return [String]
2082
+ #
2083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJobRequest AWS API Documentation
2084
+ #
2085
+ class StopSentimentDetectionJobRequest < Struct.new(
2086
+ :job_id)
2087
+ include Aws::Structure
2088
+ end
2089
+
2090
+ # @!attribute [rw] job_id
2091
+ # The identifier of the sentiment detection job to stop.
2092
+ # @return [String]
2093
+ #
2094
+ # @!attribute [rw] job_status
2095
+ # Either `STOPPING` if the job is currently running, or `STOPPED` if
2096
+ # the job was previously stopped with the `StopSentimentDetectionJob`
2097
+ # operation.
2098
+ # @return [String]
2099
+ #
2100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJobResponse AWS API Documentation
2101
+ #
2102
+ class StopSentimentDetectionJobResponse < Struct.new(
2103
+ :job_id,
2104
+ :job_status)
2105
+ include Aws::Structure
2106
+ end
2107
+
874
2108
  # Provides information for filtering topic detection jobs. For more
875
2109
  # information, see .
876
2110
  #
@@ -879,7 +2113,7 @@ module Aws::Comprehend
879
2113
  #
880
2114
  # {
881
2115
  # job_name: "JobName",
882
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED
2116
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
883
2117
  # submit_time_before: Time.now,
884
2118
  # submit_time_after: Time.now,
885
2119
  # }