aws-sdk-comprehend 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 72ddbe05f19f359a165a9b62ba02ca323126efa4
4
- data.tar.gz: aa54848da3baa5d6a78d8dc1e8b8f78332729dee
3
+ metadata.gz: 625051c59f0354164715c28f8fcc3a060082edf9
4
+ data.tar.gz: 53501ef9ade6e3f9bfdfe1b8f419e90a3d237216
5
5
  SHA512:
6
- metadata.gz: e02d30db524df455f0c360deecbe08d6cfb49fef770b7abfcbacdb3effadf71c309b39c3bd8d4e970a617607b2a943986ff881d212cf95dc0d2f2a7f744040a8
7
- data.tar.gz: 2defb1087fd61cd49481309d6a855dde4298db0c5e6f681a9155a8720e0e94531a442598f08de0e7103b58b6aae3be9e87abde8cd32d6ac81826e1609a4d7f2f
6
+ metadata.gz: f1069b05b030e794ee7c5f2a9cfd078e61db681c2b3793a55cf675b154170d9d3b5b2865d12fb009b13beba312c20a4f406184f2278c9b91fdf48ef3659d32ad
7
+ data.tar.gz: 1144f902dca8d82cdaa90cbba369997da9a1a837761e5ef6e0bde80f6fe79d41d0a001e27cb9fe7bc3fa31ba973acd53aa2cb875d5310c5e1ce44905f16af0fc
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-comprehend/customizations'
42
42
  # @service
43
43
  module Aws::Comprehend
44
44
 
45
- GEM_VERSION = '1.1.0'
45
+ GEM_VERSION = '1.2.0'
46
46
 
47
47
  end
@@ -212,8 +212,9 @@ module Aws::Comprehend
212
212
  req.send_request(options)
213
213
  end
214
214
 
215
- # Inspects the text of a batch of documents and returns information
216
- # about them. For more information about entities, see how-entities
215
+ # Inspects the text of a batch of documents for named entities and
216
+ # returns information about them. For more information about named
217
+ # entities, see how-entities
217
218
  #
218
219
  # @option params [required, Array<String>] :text_list
219
220
  # A list containing the text of the input documents. The list can
@@ -221,8 +222,8 @@ module Aws::Comprehend
221
222
  # than 5,000 bytes of UTF-8 encoded characters.
222
223
  #
223
224
  # @option params [required, String] :language_code
224
- # The language of the input documents. All documents must be in the same
225
- # language.
225
+ # The language of the input documents. You can specify English ("en")
226
+ # or Spanish ("es"). All documents must be in the same language.
226
227
  #
227
228
  # @return [Types::BatchDetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
228
229
  #
@@ -233,7 +234,7 @@ module Aws::Comprehend
233
234
  #
234
235
  # resp = client.batch_detect_entities({
235
236
  # text_list: ["String"], # required
236
- # language_code: "String", # required
237
+ # language_code: "en", # required, accepts en, es
237
238
  # })
238
239
  #
239
240
  # @example Response structure
@@ -268,8 +269,8 @@ module Aws::Comprehend
268
269
  # that 5,000 bytes of UTF-8 encoded characters.
269
270
  #
270
271
  # @option params [required, String] :language_code
271
- # The language of the input documents. All documents must be in the same
272
- # language.
272
+ # The language of the input documents. You can specify English ("en")
273
+ # or Spanish ("es"). All documents must be in the same language.
273
274
  #
274
275
  # @return [Types::BatchDetectKeyPhrasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
275
276
  #
@@ -280,7 +281,7 @@ module Aws::Comprehend
280
281
  #
281
282
  # resp = client.batch_detect_key_phrases({
282
283
  # text_list: ["String"], # required
283
- # language_code: "String", # required
284
+ # language_code: "en", # required, accepts en, es
284
285
  # })
285
286
  #
286
287
  # @example Response structure
@@ -316,8 +317,8 @@ module Aws::Comprehend
316
317
  # that 5,000 bytes of UTF-8 encoded characters.
317
318
  #
318
319
  # @option params [required, String] :language_code
319
- # The language of the input documents. All documents must be in the same
320
- # language.
320
+ # The language of the input documents. You can specify English ("en")
321
+ # or Spanish ("es"). All documents must be in the same language.
321
322
  #
322
323
  # @return [Types::BatchDetectSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
323
324
  #
@@ -328,7 +329,7 @@ module Aws::Comprehend
328
329
  #
329
330
  # resp = client.batch_detect_sentiment({
330
331
  # text_list: ["String"], # required
331
- # language_code: "String", # required
332
+ # language_code: "en", # required, accepts en, es
332
333
  # })
333
334
  #
334
335
  # @example Response structure
@@ -354,6 +355,161 @@ module Aws::Comprehend
354
355
  req.send_request(options)
355
356
  end
356
357
 
358
+ # Gets the properties associated with a dominant language detection job.
359
+ # Use this operation to get the status of a detection job.
360
+ #
361
+ # @option params [required, String] :job_id
362
+ # The identifier that Amazon Comprehend generated for the job. The
363
+ # operation returns this identifier in its response.
364
+ #
365
+ # @return [Types::DescribeDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
366
+ #
367
+ # * {Types::DescribeDominantLanguageDetectionJobResponse#dominant_language_detection_job_properties #dominant_language_detection_job_properties} => Types::DominantLanguageDetectionJobProperties
368
+ #
369
+ # @example Request syntax with placeholder values
370
+ #
371
+ # resp = client.describe_dominant_language_detection_job({
372
+ # job_id: "JobId", # required
373
+ # })
374
+ #
375
+ # @example Response structure
376
+ #
377
+ # resp.dominant_language_detection_job_properties.job_id #=> String
378
+ # resp.dominant_language_detection_job_properties.job_name #=> String
379
+ # resp.dominant_language_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
380
+ # resp.dominant_language_detection_job_properties.message #=> String
381
+ # resp.dominant_language_detection_job_properties.submit_time #=> Time
382
+ # resp.dominant_language_detection_job_properties.end_time #=> Time
383
+ # resp.dominant_language_detection_job_properties.input_data_config.s3_uri #=> String
384
+ # resp.dominant_language_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
385
+ # resp.dominant_language_detection_job_properties.output_data_config.s3_uri #=> String
386
+ #
387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob AWS API Documentation
388
+ #
389
+ # @overload describe_dominant_language_detection_job(params = {})
390
+ # @param [Hash] params ({})
391
+ def describe_dominant_language_detection_job(params = {}, options = {})
392
+ req = build_request(:describe_dominant_language_detection_job, params)
393
+ req.send_request(options)
394
+ end
395
+
396
+ # Gets the properties associated with an entities detection job. Use
397
+ # this operation to get the status of a detection job.
398
+ #
399
+ # @option params [required, String] :job_id
400
+ # The identifier that Amazon Comprehend generated for the job. The
401
+ # operation returns this identifier in its response.
402
+ #
403
+ # @return [Types::DescribeEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
404
+ #
405
+ # * {Types::DescribeEntitiesDetectionJobResponse#entities_detection_job_properties #entities_detection_job_properties} => Types::EntitiesDetectionJobProperties
406
+ #
407
+ # @example Request syntax with placeholder values
408
+ #
409
+ # resp = client.describe_entities_detection_job({
410
+ # job_id: "JobId", # required
411
+ # })
412
+ #
413
+ # @example Response structure
414
+ #
415
+ # resp.entities_detection_job_properties.job_id #=> String
416
+ # resp.entities_detection_job_properties.job_name #=> String
417
+ # resp.entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
418
+ # resp.entities_detection_job_properties.message #=> String
419
+ # resp.entities_detection_job_properties.submit_time #=> Time
420
+ # resp.entities_detection_job_properties.end_time #=> Time
421
+ # resp.entities_detection_job_properties.input_data_config.s3_uri #=> String
422
+ # resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
423
+ # resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
424
+ # resp.entities_detection_job_properties.language_code #=> String, one of "en", "es"
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob AWS API Documentation
427
+ #
428
+ # @overload describe_entities_detection_job(params = {})
429
+ # @param [Hash] params ({})
430
+ def describe_entities_detection_job(params = {}, options = {})
431
+ req = build_request(:describe_entities_detection_job, params)
432
+ req.send_request(options)
433
+ end
434
+
435
+ # Gets the properties associated with a key phrases detection job. Use
436
+ # this operation to get the status of a detection job.
437
+ #
438
+ # @option params [required, String] :job_id
439
+ # The identifier that Amazon Comprehend generated for the job. The
440
+ # operation returns this identifier in its response.
441
+ #
442
+ # @return [Types::DescribeKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
443
+ #
444
+ # * {Types::DescribeKeyPhrasesDetectionJobResponse#key_phrases_detection_job_properties #key_phrases_detection_job_properties} => Types::KeyPhrasesDetectionJobProperties
445
+ #
446
+ # @example Request syntax with placeholder values
447
+ #
448
+ # resp = client.describe_key_phrases_detection_job({
449
+ # job_id: "JobId", # required
450
+ # })
451
+ #
452
+ # @example Response structure
453
+ #
454
+ # resp.key_phrases_detection_job_properties.job_id #=> String
455
+ # resp.key_phrases_detection_job_properties.job_name #=> String
456
+ # resp.key_phrases_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
457
+ # resp.key_phrases_detection_job_properties.message #=> String
458
+ # resp.key_phrases_detection_job_properties.submit_time #=> Time
459
+ # resp.key_phrases_detection_job_properties.end_time #=> Time
460
+ # resp.key_phrases_detection_job_properties.input_data_config.s3_uri #=> String
461
+ # resp.key_phrases_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
462
+ # resp.key_phrases_detection_job_properties.output_data_config.s3_uri #=> String
463
+ # resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es"
464
+ #
465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob AWS API Documentation
466
+ #
467
+ # @overload describe_key_phrases_detection_job(params = {})
468
+ # @param [Hash] params ({})
469
+ def describe_key_phrases_detection_job(params = {}, options = {})
470
+ req = build_request(:describe_key_phrases_detection_job, params)
471
+ req.send_request(options)
472
+ end
473
+
474
+ # Gets the properties associated with a sentiment detection job. Use
475
+ # this operation to get the status of a detection job.
476
+ #
477
+ # @option params [required, String] :job_id
478
+ # The identifier that Amazon Comprehend generated for the job. The
479
+ # operation returns this identifier in its response.
480
+ #
481
+ # @return [Types::DescribeSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
482
+ #
483
+ # * {Types::DescribeSentimentDetectionJobResponse#sentiment_detection_job_properties #sentiment_detection_job_properties} => Types::SentimentDetectionJobProperties
484
+ #
485
+ # @example Request syntax with placeholder values
486
+ #
487
+ # resp = client.describe_sentiment_detection_job({
488
+ # job_id: "JobId", # required
489
+ # })
490
+ #
491
+ # @example Response structure
492
+ #
493
+ # resp.sentiment_detection_job_properties.job_id #=> String
494
+ # resp.sentiment_detection_job_properties.job_name #=> String
495
+ # resp.sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
496
+ # resp.sentiment_detection_job_properties.message #=> String
497
+ # resp.sentiment_detection_job_properties.submit_time #=> Time
498
+ # resp.sentiment_detection_job_properties.end_time #=> Time
499
+ # resp.sentiment_detection_job_properties.input_data_config.s3_uri #=> String
500
+ # resp.sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
501
+ # resp.sentiment_detection_job_properties.output_data_config.s3_uri #=> String
502
+ # resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es"
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob AWS API Documentation
505
+ #
506
+ # @overload describe_sentiment_detection_job(params = {})
507
+ # @param [Hash] params ({})
508
+ def describe_sentiment_detection_job(params = {}, options = {})
509
+ req = build_request(:describe_sentiment_detection_job, params)
510
+ req.send_request(options)
511
+ end
512
+
357
513
  # Gets the properties associated with a topic detection job. Use this
358
514
  # operation to get the status of a detection job.
359
515
  #
@@ -374,7 +530,7 @@ module Aws::Comprehend
374
530
  #
375
531
  # resp.topics_detection_job_properties.job_id #=> String
376
532
  # resp.topics_detection_job_properties.job_name #=> String
377
- # resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
533
+ # resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
378
534
  # resp.topics_detection_job_properties.message #=> String
379
535
  # resp.topics_detection_job_properties.submit_time #=> Time
380
536
  # resp.topics_detection_job_properties.end_time #=> Time
@@ -429,24 +585,16 @@ module Aws::Comprehend
429
585
  req.send_request(options)
430
586
  end
431
587
 
432
- # Inspects text for entities, and returns information about them. For
433
- # more information, about entities, see how-entities.
588
+ # Inspects text for named entities, and returns information about them.
589
+ # For more information, about named entities, see how-entities.
434
590
  #
435
591
  # @option params [required, String] :text
436
592
  # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
437
593
  # of UTF-8 encoded characters.
438
594
  #
439
595
  # @option params [required, String] :language_code
440
- # The RFC 5646 language code of the input text. If the request does not
441
- # specify the language code, the service detects the dominant language.
442
- # If you specify a language code that the service does not support, it
443
- # returns `UnsupportedLanguageException` exception. For more information
444
- # about RFC 5646, see [Tags for Identifying Languages][1] on the *IETF
445
- # Tools* web site.
446
- #
447
- #
448
- #
449
- # [1]: https://tools.ietf.org/html/rfc5646
596
+ # The language of the input documents. You can specify English ("en")
597
+ # or Spanish ("es"). All documents must be in the same language.
450
598
  #
451
599
  # @return [Types::DetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
600
  #
@@ -484,16 +632,8 @@ module Aws::Comprehend
484
632
  # of UTF-8 encoded characters.
485
633
  #
486
634
  # @option params [required, String] :language_code
487
- # The RFC 5646 language code for the input text. If you don't specify a
488
- # language code, Amazon Comprehend detects the dominant language. If you
489
- # specify the code for a language that Amazon Comprehend does not
490
- # support, it returns and `UnsupportedLanguageException`. For more
491
- # information about RFC 5646, see [Tags for Identifying Languages][1] on
492
- # the *IETF Tools* web site.
493
- #
494
- #
495
- #
496
- # [1]: https://tools.ietf.org/html/rfc5646
635
+ # The language of the input documents. You can specify English ("en")
636
+ # or Spanish ("es"). All documents must be in the same language.
497
637
  #
498
638
  # @return [Types::DetectKeyPhrasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
499
639
  #
@@ -531,16 +671,8 @@ module Aws::Comprehend
531
671
  # of UTF-8 encoded characters.
532
672
  #
533
673
  # @option params [required, String] :language_code
534
- # The RFC 5646 language code for the input text. If you don't specify a
535
- # language code, Amazon Comprehend detects the dominant language. If you
536
- # specify the code for a language that Amazon Comprehend does not
537
- # support, it returns and `UnsupportedLanguageException`. For more
538
- # information about RFC 5646, see [Tags for Identifying Languages][1] on
539
- # the *IETF Tools* web site.
540
- #
541
- #
542
- #
543
- # [1]: https://tools.ietf.org/html/rfc5646
674
+ # The language of the input documents. You can specify English ("en")
675
+ # or Spanish ("es"). All documents must be in the same language.
544
676
  #
545
677
  # @return [Types::DetectSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
546
678
  #
@@ -571,6 +703,230 @@ module Aws::Comprehend
571
703
  req.send_request(options)
572
704
  end
573
705
 
706
+ # Gets a list of the dominant language detection jobs that you have
707
+ # submitted.
708
+ #
709
+ # @option params [Types::DominantLanguageDetectionJobFilter] :filter
710
+ # Filters that jobs that are returned. You can filter jobs on their
711
+ # name, status, or the date and time that they were submitted. You can
712
+ # only set one filter at a time.
713
+ #
714
+ # @option params [String] :next_token
715
+ # Identifies the next page of results to return.
716
+ #
717
+ # @option params [Integer] :max_results
718
+ # The maximum number of results to return in each page. The default is
719
+ # 100.
720
+ #
721
+ # @return [Types::ListDominantLanguageDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
722
+ #
723
+ # * {Types::ListDominantLanguageDetectionJobsResponse#dominant_language_detection_job_properties_list #dominant_language_detection_job_properties_list} => Array&lt;Types::DominantLanguageDetectionJobProperties&gt;
724
+ # * {Types::ListDominantLanguageDetectionJobsResponse#next_token #next_token} => String
725
+ #
726
+ # @example Request syntax with placeholder values
727
+ #
728
+ # resp = client.list_dominant_language_detection_jobs({
729
+ # filter: {
730
+ # job_name: "JobName",
731
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
732
+ # submit_time_before: Time.now,
733
+ # submit_time_after: Time.now,
734
+ # },
735
+ # next_token: "String",
736
+ # max_results: 1,
737
+ # })
738
+ #
739
+ # @example Response structure
740
+ #
741
+ # resp.dominant_language_detection_job_properties_list #=> Array
742
+ # resp.dominant_language_detection_job_properties_list[0].job_id #=> String
743
+ # resp.dominant_language_detection_job_properties_list[0].job_name #=> String
744
+ # resp.dominant_language_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
745
+ # resp.dominant_language_detection_job_properties_list[0].message #=> String
746
+ # resp.dominant_language_detection_job_properties_list[0].submit_time #=> Time
747
+ # resp.dominant_language_detection_job_properties_list[0].end_time #=> Time
748
+ # resp.dominant_language_detection_job_properties_list[0].input_data_config.s3_uri #=> String
749
+ # resp.dominant_language_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
750
+ # resp.dominant_language_detection_job_properties_list[0].output_data_config.s3_uri #=> String
751
+ # resp.next_token #=> String
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs AWS API Documentation
754
+ #
755
+ # @overload list_dominant_language_detection_jobs(params = {})
756
+ # @param [Hash] params ({})
757
+ def list_dominant_language_detection_jobs(params = {}, options = {})
758
+ req = build_request(:list_dominant_language_detection_jobs, params)
759
+ req.send_request(options)
760
+ end
761
+
762
+ # Gets a list of the entity detection jobs that you have submitted.
763
+ #
764
+ # @option params [Types::EntitiesDetectionJobFilter] :filter
765
+ # Filters the jobs that are returned. You can filter jobs on their name,
766
+ # status, or the date and time that they were submitted. You can only
767
+ # set one filter at a time.
768
+ #
769
+ # @option params [String] :next_token
770
+ # Identifies the next page of results to return.
771
+ #
772
+ # @option params [Integer] :max_results
773
+ # The maximum number of results to return in each page. The default is
774
+ # 100.
775
+ #
776
+ # @return [Types::ListEntitiesDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
777
+ #
778
+ # * {Types::ListEntitiesDetectionJobsResponse#entities_detection_job_properties_list #entities_detection_job_properties_list} => Array&lt;Types::EntitiesDetectionJobProperties&gt;
779
+ # * {Types::ListEntitiesDetectionJobsResponse#next_token #next_token} => String
780
+ #
781
+ # @example Request syntax with placeholder values
782
+ #
783
+ # resp = client.list_entities_detection_jobs({
784
+ # filter: {
785
+ # job_name: "JobName",
786
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
787
+ # submit_time_before: Time.now,
788
+ # submit_time_after: Time.now,
789
+ # },
790
+ # next_token: "String",
791
+ # max_results: 1,
792
+ # })
793
+ #
794
+ # @example Response structure
795
+ #
796
+ # resp.entities_detection_job_properties_list #=> Array
797
+ # resp.entities_detection_job_properties_list[0].job_id #=> String
798
+ # resp.entities_detection_job_properties_list[0].job_name #=> String
799
+ # resp.entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
800
+ # resp.entities_detection_job_properties_list[0].message #=> String
801
+ # resp.entities_detection_job_properties_list[0].submit_time #=> Time
802
+ # resp.entities_detection_job_properties_list[0].end_time #=> Time
803
+ # resp.entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
804
+ # resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
805
+ # resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
806
+ # resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
807
+ # resp.next_token #=> String
808
+ #
809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs AWS API Documentation
810
+ #
811
+ # @overload list_entities_detection_jobs(params = {})
812
+ # @param [Hash] params ({})
813
+ def list_entities_detection_jobs(params = {}, options = {})
814
+ req = build_request(:list_entities_detection_jobs, params)
815
+ req.send_request(options)
816
+ end
817
+
818
+ # Get a list of key phrase detection jobs that you have submitted.
819
+ #
820
+ # @option params [Types::KeyPhrasesDetectionJobFilter] :filter
821
+ # Filters the jobs that are returned. You can filter jobs on their name,
822
+ # status, or the date and time that they were submitted. You can only
823
+ # set one filter at a time.
824
+ #
825
+ # @option params [String] :next_token
826
+ # Identifies the next page of results to return.
827
+ #
828
+ # @option params [Integer] :max_results
829
+ # The maximum number of results to return in each page. The default is
830
+ # 100.
831
+ #
832
+ # @return [Types::ListKeyPhrasesDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
833
+ #
834
+ # * {Types::ListKeyPhrasesDetectionJobsResponse#key_phrases_detection_job_properties_list #key_phrases_detection_job_properties_list} => Array&lt;Types::KeyPhrasesDetectionJobProperties&gt;
835
+ # * {Types::ListKeyPhrasesDetectionJobsResponse#next_token #next_token} => String
836
+ #
837
+ # @example Request syntax with placeholder values
838
+ #
839
+ # resp = client.list_key_phrases_detection_jobs({
840
+ # filter: {
841
+ # job_name: "JobName",
842
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
843
+ # submit_time_before: Time.now,
844
+ # submit_time_after: Time.now,
845
+ # },
846
+ # next_token: "String",
847
+ # max_results: 1,
848
+ # })
849
+ #
850
+ # @example Response structure
851
+ #
852
+ # resp.key_phrases_detection_job_properties_list #=> Array
853
+ # resp.key_phrases_detection_job_properties_list[0].job_id #=> String
854
+ # resp.key_phrases_detection_job_properties_list[0].job_name #=> String
855
+ # resp.key_phrases_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
856
+ # resp.key_phrases_detection_job_properties_list[0].message #=> String
857
+ # resp.key_phrases_detection_job_properties_list[0].submit_time #=> Time
858
+ # resp.key_phrases_detection_job_properties_list[0].end_time #=> Time
859
+ # resp.key_phrases_detection_job_properties_list[0].input_data_config.s3_uri #=> String
860
+ # resp.key_phrases_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
861
+ # resp.key_phrases_detection_job_properties_list[0].output_data_config.s3_uri #=> String
862
+ # resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
863
+ # resp.next_token #=> String
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs AWS API Documentation
866
+ #
867
+ # @overload list_key_phrases_detection_jobs(params = {})
868
+ # @param [Hash] params ({})
869
+ def list_key_phrases_detection_jobs(params = {}, options = {})
870
+ req = build_request(:list_key_phrases_detection_jobs, params)
871
+ req.send_request(options)
872
+ end
873
+
874
+ # Gets a list of sentiment detection jobs that you have submitted.
875
+ #
876
+ # @option params [Types::SentimentDetectionJobFilter] :filter
877
+ # Filters the jobs that are returned. You can filter jobs on their name,
878
+ # status, or the date and time that they were submitted. You can only
879
+ # set one filter at a time.
880
+ #
881
+ # @option params [String] :next_token
882
+ # Identifies the next page of results to return.
883
+ #
884
+ # @option params [Integer] :max_results
885
+ # The maximum number of results to return in each page. The default is
886
+ # 100.
887
+ #
888
+ # @return [Types::ListSentimentDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
889
+ #
890
+ # * {Types::ListSentimentDetectionJobsResponse#sentiment_detection_job_properties_list #sentiment_detection_job_properties_list} => Array&lt;Types::SentimentDetectionJobProperties&gt;
891
+ # * {Types::ListSentimentDetectionJobsResponse#next_token #next_token} => String
892
+ #
893
+ # @example Request syntax with placeholder values
894
+ #
895
+ # resp = client.list_sentiment_detection_jobs({
896
+ # filter: {
897
+ # job_name: "JobName",
898
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
899
+ # submit_time_before: Time.now,
900
+ # submit_time_after: Time.now,
901
+ # },
902
+ # next_token: "String",
903
+ # max_results: 1,
904
+ # })
905
+ #
906
+ # @example Response structure
907
+ #
908
+ # resp.sentiment_detection_job_properties_list #=> Array
909
+ # resp.sentiment_detection_job_properties_list[0].job_id #=> String
910
+ # resp.sentiment_detection_job_properties_list[0].job_name #=> String
911
+ # resp.sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
912
+ # resp.sentiment_detection_job_properties_list[0].message #=> String
913
+ # resp.sentiment_detection_job_properties_list[0].submit_time #=> Time
914
+ # resp.sentiment_detection_job_properties_list[0].end_time #=> Time
915
+ # resp.sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
916
+ # resp.sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
917
+ # resp.sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
918
+ # resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
919
+ # resp.next_token #=> String
920
+ #
921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs AWS API Documentation
922
+ #
923
+ # @overload list_sentiment_detection_jobs(params = {})
924
+ # @param [Hash] params ({})
925
+ def list_sentiment_detection_jobs(params = {}, options = {})
926
+ req = build_request(:list_sentiment_detection_jobs, params)
927
+ req.send_request(options)
928
+ end
929
+
574
930
  # Gets a list of the topic detection jobs that you have submitted.
575
931
  #
576
932
  # @option params [Types::TopicsDetectionJobFilter] :filter
@@ -582,7 +938,8 @@ module Aws::Comprehend
582
938
  # Identifies the next page of results to return.
583
939
  #
584
940
  # @option params [Integer] :max_results
585
- # The maximum number of results to return in each page.
941
+ # The maximum number of results to return in each page. The default is
942
+ # 100.
586
943
  #
587
944
  # @return [Types::ListTopicsDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
588
945
  #
@@ -594,7 +951,7 @@ module Aws::Comprehend
594
951
  # resp = client.list_topics_detection_jobs({
595
952
  # filter: {
596
953
  # job_name: "JobName",
597
- # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED
954
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
598
955
  # submit_time_before: Time.now,
599
956
  # submit_time_after: Time.now,
600
957
  # },
@@ -607,7 +964,7 @@ module Aws::Comprehend
607
964
  # resp.topics_detection_job_properties_list #=> Array
608
965
  # resp.topics_detection_job_properties_list[0].job_id #=> String
609
966
  # resp.topics_detection_job_properties_list[0].job_name #=> String
610
- # resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
967
+ # resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
611
968
  # resp.topics_detection_job_properties_list[0].message #=> String
612
969
  # resp.topics_detection_job_properties_list[0].submit_time #=> Time
613
970
  # resp.topics_detection_job_properties_list[0].end_time #=> Time
@@ -626,6 +983,254 @@ module Aws::Comprehend
626
983
  req.send_request(options)
627
984
  end
628
985
 
986
+ # Starts an asynchronous dominant language detection job for a
987
+ # collection of documents. Use the operation to track the status of a
988
+ # job.
989
+ #
990
+ # @option params [required, Types::InputDataConfig] :input_data_config
991
+ # Specifies the format and location of the input data for the job.
992
+ #
993
+ # @option params [required, Types::OutputDataConfig] :output_data_config
994
+ # Specifies where to send the output files.
995
+ #
996
+ # @option params [required, String] :data_access_role_arn
997
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
998
+ # (IAM) role that grants Amazon Comprehend read access to your input
999
+ # data.
1000
+ #
1001
+ # @option params [String] :job_name
1002
+ # An identifier for the job.
1003
+ #
1004
+ # @option params [String] :client_request_token
1005
+ # A unique identifier for the request. If you do not set the client
1006
+ # request token, Amazon Comprehend generates one.
1007
+ #
1008
+ # **A suitable default value is auto-generated.** You should normally
1009
+ # not need to pass this option.**
1010
+ #
1011
+ # @return [Types::StartDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1012
+ #
1013
+ # * {Types::StartDominantLanguageDetectionJobResponse#job_id #job_id} => String
1014
+ # * {Types::StartDominantLanguageDetectionJobResponse#job_status #job_status} => String
1015
+ #
1016
+ # @example Request syntax with placeholder values
1017
+ #
1018
+ # resp = client.start_dominant_language_detection_job({
1019
+ # input_data_config: { # required
1020
+ # s3_uri: "S3Uri", # required
1021
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1022
+ # },
1023
+ # output_data_config: { # required
1024
+ # s3_uri: "S3Uri", # required
1025
+ # },
1026
+ # data_access_role_arn: "IamRoleArn", # required
1027
+ # job_name: "JobName",
1028
+ # client_request_token: "ClientRequestTokenString",
1029
+ # })
1030
+ #
1031
+ # @example Response structure
1032
+ #
1033
+ # resp.job_id #=> String
1034
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1035
+ #
1036
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob AWS API Documentation
1037
+ #
1038
+ # @overload start_dominant_language_detection_job(params = {})
1039
+ # @param [Hash] params ({})
1040
+ def start_dominant_language_detection_job(params = {}, options = {})
1041
+ req = build_request(:start_dominant_language_detection_job, params)
1042
+ req.send_request(options)
1043
+ end
1044
+
1045
+ # Starts an asynchronous entity detection job for a collection of
1046
+ # documents. Use the operation to track the status of a job.
1047
+ #
1048
+ # @option params [required, Types::InputDataConfig] :input_data_config
1049
+ # Specifies the format and location of the input data for the job.
1050
+ #
1051
+ # @option params [required, Types::OutputDataConfig] :output_data_config
1052
+ # Specifies where to send the output files.
1053
+ #
1054
+ # @option params [required, String] :data_access_role_arn
1055
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1056
+ # (IAM) role that grants Amazon Comprehend read access to your input
1057
+ # data.
1058
+ #
1059
+ # @option params [String] :job_name
1060
+ # The identifier of the job.
1061
+ #
1062
+ # @option params [required, String] :language_code
1063
+ # The language of the input documents. You can specify English ("en")
1064
+ # or Spanish ("es"). All documents must be in the same language.
1065
+ #
1066
+ # @option params [String] :client_request_token
1067
+ # A unique identifier for the request. If you don't set the client
1068
+ # request token, Amazon Comprehend generates one.
1069
+ #
1070
+ # **A suitable default value is auto-generated.** You should normally
1071
+ # not need to pass this option.**
1072
+ #
1073
+ # @return [Types::StartEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1074
+ #
1075
+ # * {Types::StartEntitiesDetectionJobResponse#job_id #job_id} => String
1076
+ # * {Types::StartEntitiesDetectionJobResponse#job_status #job_status} => String
1077
+ #
1078
+ # @example Request syntax with placeholder values
1079
+ #
1080
+ # resp = client.start_entities_detection_job({
1081
+ # input_data_config: { # required
1082
+ # s3_uri: "S3Uri", # required
1083
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1084
+ # },
1085
+ # output_data_config: { # required
1086
+ # s3_uri: "S3Uri", # required
1087
+ # },
1088
+ # data_access_role_arn: "IamRoleArn", # required
1089
+ # job_name: "JobName",
1090
+ # language_code: "en", # required, accepts en, es
1091
+ # client_request_token: "ClientRequestTokenString",
1092
+ # })
1093
+ #
1094
+ # @example Response structure
1095
+ #
1096
+ # resp.job_id #=> String
1097
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob AWS API Documentation
1100
+ #
1101
+ # @overload start_entities_detection_job(params = {})
1102
+ # @param [Hash] params ({})
1103
+ def start_entities_detection_job(params = {}, options = {})
1104
+ req = build_request(:start_entities_detection_job, params)
1105
+ req.send_request(options)
1106
+ end
1107
+
1108
+ # Starts an asynchronous key phrase detection job for a collection of
1109
+ # documents. Use the operation to track the status of a job.
1110
+ #
1111
+ # @option params [required, Types::InputDataConfig] :input_data_config
1112
+ # Specifies the format and location of the input data for the job.
1113
+ #
1114
+ # @option params [required, Types::OutputDataConfig] :output_data_config
1115
+ # Specifies where to send the output files.
1116
+ #
1117
+ # @option params [required, String] :data_access_role_arn
1118
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1119
+ # (IAM) role that grants Amazon Comprehend read access to your input
1120
+ # data.
1121
+ #
1122
+ # @option params [String] :job_name
1123
+ # The identifier of the job.
1124
+ #
1125
+ # @option params [required, String] :language_code
1126
+ # The language of the input documents. You can specify English ("en")
1127
+ # or Spanish ("es"). All documents must be in the same language.
1128
+ #
1129
+ # @option params [String] :client_request_token
1130
+ # A unique identifier for the request. If you don't set the client
1131
+ # request token, Amazon Comprehend generates one.
1132
+ #
1133
+ # **A suitable default value is auto-generated.** You should normally
1134
+ # not need to pass this option.**
1135
+ #
1136
+ # @return [Types::StartKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1137
+ #
1138
+ # * {Types::StartKeyPhrasesDetectionJobResponse#job_id #job_id} => String
1139
+ # * {Types::StartKeyPhrasesDetectionJobResponse#job_status #job_status} => String
1140
+ #
1141
+ # @example Request syntax with placeholder values
1142
+ #
1143
+ # resp = client.start_key_phrases_detection_job({
1144
+ # input_data_config: { # required
1145
+ # s3_uri: "S3Uri", # required
1146
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1147
+ # },
1148
+ # output_data_config: { # required
1149
+ # s3_uri: "S3Uri", # required
1150
+ # },
1151
+ # data_access_role_arn: "IamRoleArn", # required
1152
+ # job_name: "JobName",
1153
+ # language_code: "en", # required, accepts en, es
1154
+ # client_request_token: "ClientRequestTokenString",
1155
+ # })
1156
+ #
1157
+ # @example Response structure
1158
+ #
1159
+ # resp.job_id #=> String
1160
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob AWS API Documentation
1163
+ #
1164
+ # @overload start_key_phrases_detection_job(params = {})
1165
+ # @param [Hash] params ({})
1166
+ def start_key_phrases_detection_job(params = {}, options = {})
1167
+ req = build_request(:start_key_phrases_detection_job, params)
1168
+ req.send_request(options)
1169
+ end
1170
+
1171
+ # Starts an asynchronous sentiment detection job for a collection of
1172
+ # documents. use the operation to track the status of a job.
1173
+ #
1174
+ # @option params [required, Types::InputDataConfig] :input_data_config
1175
+ # Specifies the format and location of the input data for the job.
1176
+ #
1177
+ # @option params [required, Types::OutputDataConfig] :output_data_config
1178
+ # Specifies where to send the output files.
1179
+ #
1180
+ # @option params [required, String] :data_access_role_arn
1181
+ # The Amazon Resource Name (ARN) of the AWS Identity and Management
1182
+ # (IAM) role that grants Amazon Comprehend read access to your input
1183
+ # data.
1184
+ #
1185
+ # @option params [String] :job_name
1186
+ # The identifier of the job.
1187
+ #
1188
+ # @option params [required, String] :language_code
1189
+ # The language of the input documents. You can specify English ("en")
1190
+ # or Spanish ("es"). All documents must be in the same language.
1191
+ #
1192
+ # @option params [String] :client_request_token
1193
+ # A unique identifier for the request. If you don't set the client
1194
+ # request token, Amazon Comprehend generates one.
1195
+ #
1196
+ # **A suitable default value is auto-generated.** You should normally
1197
+ # not need to pass this option.**
1198
+ #
1199
+ # @return [Types::StartSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1200
+ #
1201
+ # * {Types::StartSentimentDetectionJobResponse#job_id #job_id} => String
1202
+ # * {Types::StartSentimentDetectionJobResponse#job_status #job_status} => String
1203
+ #
1204
+ # @example Request syntax with placeholder values
1205
+ #
1206
+ # resp = client.start_sentiment_detection_job({
1207
+ # input_data_config: { # required
1208
+ # s3_uri: "S3Uri", # required
1209
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
1210
+ # },
1211
+ # output_data_config: { # required
1212
+ # s3_uri: "S3Uri", # required
1213
+ # },
1214
+ # data_access_role_arn: "IamRoleArn", # required
1215
+ # job_name: "JobName",
1216
+ # language_code: "en", # required, accepts en, es
1217
+ # client_request_token: "ClientRequestTokenString",
1218
+ # })
1219
+ #
1220
+ # @example Response structure
1221
+ #
1222
+ # resp.job_id #=> String
1223
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1224
+ #
1225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob AWS API Documentation
1226
+ #
1227
+ # @overload start_sentiment_detection_job(params = {})
1228
+ # @param [Hash] params ({})
1229
+ def start_sentiment_detection_job(params = {}, options = {})
1230
+ req = build_request(:start_sentiment_detection_job, params)
1231
+ req.send_request(options)
1232
+ end
1233
+
629
1234
  # Starts an asynchronous topic detection job. Use the
630
1235
  # `DescribeTopicDetectionJob` operation to track the status of a job.
631
1236
  #
@@ -633,7 +1238,10 @@ module Aws::Comprehend
633
1238
  # Specifies the format and location of the input data for the job.
634
1239
  #
635
1240
  # @option params [required, Types::OutputDataConfig] :output_data_config
636
- # Specifies where to send the output files.
1241
+ # Specifies where to send the output files. The output is a compressed
1242
+ # archive with two files, `topic-terms.csv` that lists the terms
1243
+ # associated with each topic, and `doc-topics.csv` that lists the
1244
+ # documents associated with each topic
637
1245
  #
638
1246
  # @option params [required, String] :data_access_role_arn
639
1247
  # The Amazon Resource Name (ARN) of the AWS Identity and Access
@@ -677,7 +1285,7 @@ module Aws::Comprehend
677
1285
  # @example Response structure
678
1286
  #
679
1287
  # resp.job_id #=> String
680
- # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
1288
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
681
1289
  #
682
1290
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob AWS API Documentation
683
1291
  #
@@ -688,6 +1296,166 @@ module Aws::Comprehend
688
1296
  req.send_request(options)
689
1297
  end
690
1298
 
1299
+ # Stops a dominant language detection job in progress.
1300
+ #
1301
+ # If the job state is `IN_PROGRESS` the job will be marked for
1302
+ # termination and put into the `STOPPING` state.
1303
+ #
1304
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
1305
+ # `StopDominantLanguageDetectionJob` operation, the operation will
1306
+ # return a 400 Internal Request Exception.
1307
+ #
1308
+ # When a job is stopped, any document that has already been processed
1309
+ # will be written to the output location.
1310
+ #
1311
+ # @option params [required, String] :job_id
1312
+ # The identifier of the dominant language detection job to stop.
1313
+ #
1314
+ # @return [Types::StopDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1315
+ #
1316
+ # * {Types::StopDominantLanguageDetectionJobResponse#job_id #job_id} => String
1317
+ # * {Types::StopDominantLanguageDetectionJobResponse#job_status #job_status} => String
1318
+ #
1319
+ # @example Request syntax with placeholder values
1320
+ #
1321
+ # resp = client.stop_dominant_language_detection_job({
1322
+ # job_id: "JobId", # required
1323
+ # })
1324
+ #
1325
+ # @example Response structure
1326
+ #
1327
+ # resp.job_id #=> String
1328
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1329
+ #
1330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob AWS API Documentation
1331
+ #
1332
+ # @overload stop_dominant_language_detection_job(params = {})
1333
+ # @param [Hash] params ({})
1334
+ def stop_dominant_language_detection_job(params = {}, options = {})
1335
+ req = build_request(:stop_dominant_language_detection_job, params)
1336
+ req.send_request(options)
1337
+ end
1338
+
1339
+ # Stops an entities detection job in progress.
1340
+ #
1341
+ # If the job state is `IN_PROGRESS` the job will be marked for
1342
+ # termination and put into the `STOPPING` state.
1343
+ #
1344
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
1345
+ # `StopDominantLanguageDetectionJob` operation, the operation will
1346
+ # return a 400 Internal Request Exception.
1347
+ #
1348
+ # When a job is stopped, any document that has already been processed
1349
+ # will be written to the output location.
1350
+ #
1351
+ # @option params [required, String] :job_id
1352
+ # The identifier of the entities detection job to stop.
1353
+ #
1354
+ # @return [Types::StopEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1355
+ #
1356
+ # * {Types::StopEntitiesDetectionJobResponse#job_id #job_id} => String
1357
+ # * {Types::StopEntitiesDetectionJobResponse#job_status #job_status} => String
1358
+ #
1359
+ # @example Request syntax with placeholder values
1360
+ #
1361
+ # resp = client.stop_entities_detection_job({
1362
+ # job_id: "JobId", # required
1363
+ # })
1364
+ #
1365
+ # @example Response structure
1366
+ #
1367
+ # resp.job_id #=> String
1368
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1369
+ #
1370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob AWS API Documentation
1371
+ #
1372
+ # @overload stop_entities_detection_job(params = {})
1373
+ # @param [Hash] params ({})
1374
+ def stop_entities_detection_job(params = {}, options = {})
1375
+ req = build_request(:stop_entities_detection_job, params)
1376
+ req.send_request(options)
1377
+ end
1378
+
1379
+ # Stops a key phrases detection job in progress.
1380
+ #
1381
+ # If the job state is `IN_PROGRESS` the job will be marked for
1382
+ # termination and put into the `STOPPING` state.
1383
+ #
1384
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
1385
+ # `StopDominantLanguageDetectionJob` operation, the operation will
1386
+ # return a 400 Internal Request Exception.
1387
+ #
1388
+ # When a job is stopped, any document that has already been processed
1389
+ # will be written to the output location.
1390
+ #
1391
+ # @option params [required, String] :job_id
1392
+ # The identifier of the key phrases detection job to stop.
1393
+ #
1394
+ # @return [Types::StopKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1395
+ #
1396
+ # * {Types::StopKeyPhrasesDetectionJobResponse#job_id #job_id} => String
1397
+ # * {Types::StopKeyPhrasesDetectionJobResponse#job_status #job_status} => String
1398
+ #
1399
+ # @example Request syntax with placeholder values
1400
+ #
1401
+ # resp = client.stop_key_phrases_detection_job({
1402
+ # job_id: "JobId", # required
1403
+ # })
1404
+ #
1405
+ # @example Response structure
1406
+ #
1407
+ # resp.job_id #=> String
1408
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1409
+ #
1410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob AWS API Documentation
1411
+ #
1412
+ # @overload stop_key_phrases_detection_job(params = {})
1413
+ # @param [Hash] params ({})
1414
+ def stop_key_phrases_detection_job(params = {}, options = {})
1415
+ req = build_request(:stop_key_phrases_detection_job, params)
1416
+ req.send_request(options)
1417
+ end
1418
+
1419
+ # Stops a sentiment detection job in progress.
1420
+ #
1421
+ # If the job state is `IN_PROGRESS` the job will be marked for
1422
+ # termination and put into the `STOPPING` state.
1423
+ #
1424
+ # If the job is in the `COMPLETED` or `FAILED` state when you call the
1425
+ # `StopDominantLanguageDetectionJob` operation, the operation will
1426
+ # return a 400 Internal Request Exception.
1427
+ #
1428
+ # When a job is stopped, any document that has already been processed
1429
+ # will be written to the output location.
1430
+ #
1431
+ # @option params [required, String] :job_id
1432
+ # The identifier of the sentiment detection job to stop.
1433
+ #
1434
+ # @return [Types::StopSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1435
+ #
1436
+ # * {Types::StopSentimentDetectionJobResponse#job_id #job_id} => String
1437
+ # * {Types::StopSentimentDetectionJobResponse#job_status #job_status} => String
1438
+ #
1439
+ # @example Request syntax with placeholder values
1440
+ #
1441
+ # resp = client.stop_sentiment_detection_job({
1442
+ # job_id: "JobId", # required
1443
+ # })
1444
+ #
1445
+ # @example Response structure
1446
+ #
1447
+ # resp.job_id #=> String
1448
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1449
+ #
1450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob AWS API Documentation
1451
+ #
1452
+ # @overload stop_sentiment_detection_job(params = {})
1453
+ # @param [Hash] params ({})
1454
+ def stop_sentiment_detection_job(params = {}, options = {})
1455
+ req = build_request(:stop_sentiment_detection_job, params)
1456
+ req.send_request(options)
1457
+ end
1458
+
691
1459
  # @!endgroup
692
1460
 
693
1461
  # @param params ({})
@@ -701,7 +1469,7 @@ module Aws::Comprehend
701
1469
  params: params,
702
1470
  config: config)
703
1471
  context[:gem_name] = 'aws-sdk-comprehend'
704
- context[:gem_version] = '1.1.0'
1472
+ context[:gem_version] = '1.2.0'
705
1473
  Seahorse::Client::Request.new(handlers, context)
706
1474
  end
707
1475