forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAmazonComprehend.java
More file actions
1203 lines (1150 loc) · 62.3 KB
/
AmazonComprehend.java
File metadata and controls
1203 lines (1150 loc) · 62.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.comprehend.model.*;
/**
* Interface for accessing Amazon Comprehend.
* <p>
* <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.comprehend.AbstractAmazonComprehend} instead.
* </p>
* <p>
* <p>
* Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine
* the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the
* predominant language used, and more.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonComprehend {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "comprehend";
/**
* <p>
* Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon
* Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon
* Comprehend Supported Languages</a>.
* </p>
*
* @param batchDetectDominantLanguageRequest
* @return Result of the BatchDetectDominantLanguage operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectDominantLanguage
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage"
* target="_top">AWS API Documentation</a>
*/
BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest batchDetectDominantLanguageRequest);
/**
* <p>
* Inspects the text of a batch of documents for named entities and returns information about them. For more
* information about named entities, see <a>how-entities</a>
* </p>
*
* @param batchDetectEntitiesRequest
* @return Result of the BatchDetectEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectEntities
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities" target="_top">AWS
* API Documentation</a>
*/
BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest batchDetectEntitiesRequest);
/**
* <p>
* Detects the key noun phrases found in a batch of documents.
* </p>
*
* @param batchDetectKeyPhrasesRequest
* @return Result of the BatchDetectKeyPhrases operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectKeyPhrases
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases"
* target="_top">AWS API Documentation</a>
*/
BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest batchDetectKeyPhrasesRequest);
/**
* <p>
* Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>,
* <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.
* </p>
*
* @param batchDetectSentimentRequest
* @return Result of the BatchDetectSentiment operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectSentiment
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment"
* target="_top">AWS API Documentation</a>
*/
BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest batchDetectSentimentRequest);
/**
* <p>
* Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and
* returns information about them. For more information, see <a>how-syntax</a>.
* </p>
*
* @param batchDetectSyntaxRequest
* @return Result of the BatchDetectSyntax operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws BatchSizeLimitExceededException
* The number of documents in the request exceeds the limit of 25. Try your request again with fewer
* documents.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.BatchDetectSyntax
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntax" target="_top">AWS
* API Documentation</a>
*/
BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest batchDetectSyntaxRequest);
/**
* <p>
* Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a
* set of training documents that labeled with the categories that you want to use. After the classifier is trained
* you can use it to categorize a set of labeled documents into the categories. For more information, see
* <a>how-document-classification</a>.
* </p>
*
* @param createDocumentClassifierRequest
* @return Result of the CreateDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified name is already in use. Use a different name and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceLimitExceededException
* The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
* and then try your request again.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.CreateDocumentClassifier
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifier"
* target="_top">AWS API Documentation</a>
*/
CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest createDocumentClassifierRequest);
/**
* <p>
* Creates an entity recognizer using submitted files. After your <code>CreateEntityRecognizer</code> request is
* submitted, you can check job status using the API.
* </p>
*
* @param createEntityRecognizerRequest
* @return Result of the CreateEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceInUseException
* The specified name is already in use. Use a different name and try your request again.
* @throws TooManyTagsException
* The request contains more tags than can be associated with a resource (50 tags per resource). The maximum
* number of tags includes both existing tags and those included in your current request.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceLimitExceededException
* The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup,
* and then try your request again.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.CreateEntityRecognizer
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizer"
* target="_top">AWS API Documentation</a>
*/
CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest createEntityRecognizerRequest);
/**
* <p>
* Deletes a previously created document classifier
* </p>
* <p>
* Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
* job is using the model, a <code>ResourceInUseException</code> will be returned.
* </p>
* <p>
* This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a
* background job. Once removed, the classifier disappears from your account and is no longer available for use.
* </p>
*
* @param deleteDocumentClassifierRequest
* @return Result of the DeleteDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check to see if the resource is in the <code>TRAINED</code>
* state and try your request again.
* @throws ResourceInUseException
* The specified name is already in use. Use a different name and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteDocumentClassifier
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifier"
* target="_top">AWS API Documentation</a>
*/
DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest deleteDocumentClassifierRequest);
/**
* <p>
* Deletes an entity recognizer.
* </p>
* <p>
* Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
* job is using the model, a <code>ResourceInUseException</code> will be returned.
* </p>
* <p>
* This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a
* background job. Once removed, the recognizer disappears from your account and is no longer available for use.
* </p>
*
* @param deleteEntityRecognizerRequest
* @return Result of the DeleteEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check to see if the resource is in the <code>TRAINED</code>
* state and try your request again.
* @throws ResourceInUseException
* The specified name is already in use. Use a different name and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DeleteEntityRecognizer
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizer"
* target="_top">AWS API Documentation</a>
*/
DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest deleteEntityRecognizerRequest);
/**
* <p>
* Gets the properties associated with a document classification job. Use this operation to get the status of a
* classification job.
* </p>
*
* @param describeDocumentClassificationJobRequest
* @return Result of the DescribeDocumentClassificationJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDocumentClassificationJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob"
* target="_top">AWS API Documentation</a>
*/
DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest describeDocumentClassificationJobRequest);
/**
* <p>
* Gets the properties associated with a document classifier.
* </p>
*
* @param describeDocumentClassifierRequest
* @return Result of the DescribeDocumentClassifier operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDocumentClassifier
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier"
* target="_top">AWS API Documentation</a>
*/
DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest describeDocumentClassifierRequest);
/**
* <p>
* Gets the properties associated with a dominant language detection job. Use this operation to get the status of a
* detection job.
* </p>
*
* @param describeDominantLanguageDetectionJobRequest
* @return Result of the DescribeDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeDominantLanguageDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob"
* target="_top">AWS API Documentation</a>
*/
DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(
DescribeDominantLanguageDetectionJobRequest describeDominantLanguageDetectionJobRequest);
/**
* <p>
* Gets the properties associated with an entities detection job. Use this operation to get the status of a
* detection job.
* </p>
*
* @param describeEntitiesDetectionJobRequest
* @return Result of the DescribeEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEntitiesDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob"
* target="_top">AWS API Documentation</a>
*/
DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest describeEntitiesDetectionJobRequest);
/**
* <p>
* Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
* metadata, metrics, and so on.
* </p>
*
* @param describeEntityRecognizerRequest
* @return Result of the DescribeEntityRecognizer operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeEntityRecognizer
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer"
* target="_top">AWS API Documentation</a>
*/
DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest describeEntityRecognizerRequest);
/**
* <p>
* Gets the properties associated with a key phrases detection job. Use this operation to get the status of a
* detection job.
* </p>
*
* @param describeKeyPhrasesDetectionJobRequest
* @return Result of the DescribeKeyPhrasesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeKeyPhrasesDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob"
* target="_top">AWS API Documentation</a>
*/
DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest describeKeyPhrasesDetectionJobRequest);
/**
* <p>
* Gets the properties associated with a sentiment detection job. Use this operation to get the status of a
* detection job.
* </p>
*
* @param describeSentimentDetectionJobRequest
* @return Result of the DescribeSentimentDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeSentimentDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob"
* target="_top">AWS API Documentation</a>
*/
DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest describeSentimentDetectionJobRequest);
/**
* <p>
* Gets the properties associated with a topic detection job. Use this operation to get the status of a detection
* job.
* </p>
*
* @param describeTopicsDetectionJobRequest
* @return Result of the DescribeTopicsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DescribeTopicsDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob"
* target="_top">AWS API Documentation</a>
*/
DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest describeTopicsDetectionJobRequest);
/**
* <p>
* Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect,
* see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported
* Languages</a>.
* </p>
*
* @param detectDominantLanguageRequest
* @return Result of the DetectDominantLanguage operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectDominantLanguage
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage"
* target="_top">AWS API Documentation</a>
*/
DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest detectDominantLanguageRequest);
/**
* <p>
* Inspects text for named entities, and returns information about them. For more information, about named entities,
* see <a>how-entities</a>.
* </p>
*
* @param detectEntitiesRequest
* @return Result of the DetectEntities operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectEntities
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities" target="_top">AWS API
* Documentation</a>
*/
DetectEntitiesResult detectEntities(DetectEntitiesRequest detectEntitiesRequest);
/**
* <p>
* Detects the key noun phrases found in the text.
* </p>
*
* @param detectKeyPhrasesRequest
* @return Result of the DetectKeyPhrases operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectKeyPhrases
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases" target="_top">AWS
* API Documentation</a>
*/
DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest detectKeyPhrasesRequest);
/**
* <p>
* Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>,
* <code>MIXED</code>, or <code>NEGATIVE</code>).
* </p>
*
* @param detectSentimentRequest
* @return Result of the DetectSentiment operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectSentiment
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment" target="_top">AWS API
* Documentation</a>
*/
DetectSentimentResult detectSentiment(DetectSentimentRequest detectSentimentRequest);
/**
* <p>
* Inspects text for syntax and the part of speech of words in the document. For more information,
* <a>how-syntax</a>.
* </p>
*
* @param detectSyntaxRequest
* @return Result of the DetectSyntax operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TextSizeLimitExceededException
* The size of the input text exceeds the limit. Use a smaller document.
* @throws UnsupportedLanguageException
* Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs
* (such as <code>CreateEntityRecognizer</code>), only English is accepted. For most other APIs, Amazon
* Comprehend accepts only English or Spanish text.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.DetectSyntax
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax" target="_top">AWS API
* Documentation</a>
*/
DetectSyntaxResult detectSyntax(DetectSyntaxRequest detectSyntaxRequest);
/**
* <p>
* Gets a list of the documentation classification jobs that you have submitted.
* </p>
*
* @param listDocumentClassificationJobsRequest
* @return Result of the ListDocumentClassificationJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDocumentClassificationJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs"
* target="_top">AWS API Documentation</a>
*/
ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest listDocumentClassificationJobsRequest);
/**
* <p>
* Gets a list of the document classifiers that you have created.
* </p>
*
* @param listDocumentClassifiersRequest
* @return Result of the ListDocumentClassifiers operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDocumentClassifiers
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers"
* target="_top">AWS API Documentation</a>
*/
ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest listDocumentClassifiersRequest);
/**
* <p>
* Gets a list of the dominant language detection jobs that you have submitted.
* </p>
*
* @param listDominantLanguageDetectionJobsRequest
* @return Result of the ListDominantLanguageDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListDominantLanguageDetectionJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs"
* target="_top">AWS API Documentation</a>
*/
ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest listDominantLanguageDetectionJobsRequest);
/**
* <p>
* Gets a list of the entity detection jobs that you have submitted.
* </p>
*
* @param listEntitiesDetectionJobsRequest
* @return Result of the ListEntitiesDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEntitiesDetectionJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs"
* target="_top">AWS API Documentation</a>
*/
ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest listEntitiesDetectionJobsRequest);
/**
* <p>
* Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
* training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This
* call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
* </p>
* <p>
* The results of this list are not in any particular order. Please get the list and sort locally if needed.
* </p>
*
* @param listEntityRecognizersRequest
* @return Result of the ListEntityRecognizers operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListEntityRecognizers
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers"
* target="_top">AWS API Documentation</a>
*/
ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest listEntityRecognizersRequest);
/**
* <p>
* Get a list of key phrase detection jobs that you have submitted.
* </p>
*
* @param listKeyPhrasesDetectionJobsRequest
* @return Result of the ListKeyPhrasesDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListKeyPhrasesDetectionJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs"
* target="_top">AWS API Documentation</a>
*/
ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest listKeyPhrasesDetectionJobsRequest);
/**
* <p>
* Gets a list of sentiment detection jobs that you have submitted.
* </p>
*
* @param listSentimentDetectionJobsRequest
* @return Result of the ListSentimentDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListSentimentDetectionJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs"
* target="_top">AWS API Documentation</a>
*/
ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest listSentimentDetectionJobsRequest);
/**
* <p>
* Lists all tags associated with a given Amazon Comprehend resource.
* </p>
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListTagsForResource
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource" target="_top">AWS
* API Documentation</a>
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
* <p>
* Gets a list of the topic detection jobs that you have submitted.
* </p>
*
* @param listTopicsDetectionJobsRequest
* @return Result of the ListTopicsDetectionJobs operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws InvalidFilterException
* The filter specified for the <code>ListDocumentClassificationJobs</code> operation is invalid. Specify a
* different filter.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.ListTopicsDetectionJobs
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs"
* target="_top">AWS API Documentation</a>
*/
ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest listTopicsDetectionJobsRequest);
/**
* <p>
* Starts an asynchronous document classification job. Use the operation to track the progress of the job.
* </p>
*
* @param startDocumentClassificationJobRequest
* @return Result of the StartDocumentClassificationJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check to see if the resource is in the <code>TRAINED</code>
* state and try your request again.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartDocumentClassificationJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob"
* target="_top">AWS API Documentation</a>
*/
StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest startDocumentClassificationJobRequest);
/**
* <p>
* Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track
* the status of a job.
* </p>
*
* @param startDominantLanguageDetectionJobRequest
* @return Result of the StartDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartDominantLanguageDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest startDominantLanguageDetectionJobRequest);
/**
* <p>
* Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status
* of a job.
* </p>
* <p>
* This API can be used for either standard entity detection or custom entity recognition. In order to be used for
* custom entity recognition, the optional <code>EntityRecognizerArn</code> must be used in order to provide access
* to the recognizer being used to detect the custom entity.
* </p>
*
* @param startEntitiesDetectionJobRequest
* @return Result of the StartEntitiesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws ResourceNotFoundException
* The specified resource ARN was not found. Check the ARN and try your request again.
* @throws ResourceUnavailableException
* The specified resource is not available. Check to see if the resource is in the <code>TRAINED</code>
* state and try your request again.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartEntitiesDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest startEntitiesDetectionJobRequest);
/**
* <p>
* Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the
* status of a job.
* </p>
*
* @param startKeyPhrasesDetectionJobRequest
* @return Result of the StartKeyPhrasesDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartKeyPhrasesDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest startKeyPhrasesDetectionJobRequest);
/**
* <p>
* Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the
* status of a job.
* </p>
*
* @param startSentimentDetectionJobRequest
* @return Result of the StartSentimentDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartSentimentDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest startSentimentDetectionJobRequest);
/**
* <p>
* Starts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the
* status of a job.
* </p>
*
* @param startTopicsDetectionJobRequest
* @return Result of the StartTopicsDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws TooManyRequestsException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws KmsKeyValidationException
* The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StartTopicsDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest startTopicsDetectionJobRequest);
/**
* <p>
* Stops a dominant language detection job in progress.
* </p>
* <p>
* If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the
* <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the
* <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state.
* </p>
* <p>
* If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception.
* </p>
* <p>
* When a job is stopped, any documents already processed are written to the output location.
* </p>
*
* @param stopDominantLanguageDetectionJobRequest
* @return Result of the StopDominantLanguageDetectionJob operation returned by the service.
* @throws InvalidRequestException
* The request is invalid.
* @throws JobNotFoundException
* The specified job was not found. Check the job ID and try again.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @sample AmazonComprehend.StopDominantLanguageDetectionJob
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob"
* target="_top">AWS API Documentation</a>
*/
StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest stopDominantLanguageDetectionJobRequest);
/**
* <p>
* Stops an entities detection job in progress.
* </p>
* <p>
* If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the
* <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the
* <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state.
* </p>
* <p>
* If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception.
* </p>
* <p>
* When a job is stopped, any documents already processed are written to the output location.
* </p>
*