aws-sdk-comprehend 1.34.0 → 1.39.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +3 -2
- data/lib/aws-sdk-comprehend/client.rb +313 -24
- data/lib/aws-sdk-comprehend/client_api.rb +184 -15
- data/lib/aws-sdk-comprehend/types.rb +553 -43
- metadata +2 -2
@@ -49,6 +49,8 @@ module Aws::Comprehend
|
|
49
49
|
CreateEndpointResponse = Shapes::StructureShape.new(name: 'CreateEndpointResponse')
|
50
50
|
CreateEntityRecognizerRequest = Shapes::StructureShape.new(name: 'CreateEntityRecognizerRequest')
|
51
51
|
CreateEntityRecognizerResponse = Shapes::StructureShape.new(name: 'CreateEntityRecognizerResponse')
|
52
|
+
CustomerInputString = Shapes::StringShape.new(name: 'CustomerInputString')
|
53
|
+
CustomerInputStringList = Shapes::ListShape.new(name: 'CustomerInputStringList')
|
52
54
|
DeleteDocumentClassifierRequest = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierRequest')
|
53
55
|
DeleteDocumentClassifierResponse = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierResponse')
|
54
56
|
DeleteEndpointRequest = Shapes::StructureShape.new(name: 'DeleteEndpointRequest')
|
@@ -69,6 +71,8 @@ module Aws::Comprehend
|
|
69
71
|
DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
|
70
72
|
DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
|
71
73
|
DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
|
74
|
+
DescribePiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobRequest')
|
75
|
+
DescribePiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobResponse')
|
72
76
|
DescribeSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobRequest')
|
73
77
|
DescribeSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobResponse')
|
74
78
|
DescribeTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeTopicsDetectionJobRequest')
|
@@ -79,6 +83,8 @@ module Aws::Comprehend
|
|
79
83
|
DetectEntitiesResponse = Shapes::StructureShape.new(name: 'DetectEntitiesResponse')
|
80
84
|
DetectKeyPhrasesRequest = Shapes::StructureShape.new(name: 'DetectKeyPhrasesRequest')
|
81
85
|
DetectKeyPhrasesResponse = Shapes::StructureShape.new(name: 'DetectKeyPhrasesResponse')
|
86
|
+
DetectPiiEntitiesRequest = Shapes::StructureShape.new(name: 'DetectPiiEntitiesRequest')
|
87
|
+
DetectPiiEntitiesResponse = Shapes::StructureShape.new(name: 'DetectPiiEntitiesResponse')
|
82
88
|
DetectSentimentRequest = Shapes::StructureShape.new(name: 'DetectSentimentRequest')
|
83
89
|
DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
|
84
90
|
DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
|
@@ -112,6 +118,7 @@ module Aws::Comprehend
|
|
112
118
|
EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
|
113
119
|
EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
|
114
120
|
EntityRecognizerDocuments = Shapes::StructureShape.new(name: 'EntityRecognizerDocuments')
|
121
|
+
EntityRecognizerEndpointArn = Shapes::StringShape.new(name: 'EntityRecognizerEndpointArn')
|
115
122
|
EntityRecognizerEntityList = Shapes::StructureShape.new(name: 'EntityRecognizerEntityList')
|
116
123
|
EntityRecognizerEvaluationMetrics = Shapes::StructureShape.new(name: 'EntityRecognizerEvaluationMetrics')
|
117
124
|
EntityRecognizerFilter = Shapes::StructureShape.new(name: 'EntityRecognizerFilter')
|
@@ -171,19 +178,33 @@ module Aws::Comprehend
|
|
171
178
|
ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
|
172
179
|
ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
|
173
180
|
ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
|
181
|
+
ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
|
182
|
+
ListOfPiiEntityTypes = Shapes::ListShape.new(name: 'ListOfPiiEntityTypes')
|
174
183
|
ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
|
184
|
+
ListPiiEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsRequest')
|
185
|
+
ListPiiEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsResponse')
|
175
186
|
ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
|
176
187
|
ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
|
177
188
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
178
189
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
179
190
|
ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
|
180
191
|
ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
|
192
|
+
MaskCharacter = Shapes::StringShape.new(name: 'MaskCharacter')
|
181
193
|
MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
|
182
194
|
ModelStatus = Shapes::StringShape.new(name: 'ModelStatus')
|
183
195
|
NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
|
184
196
|
OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
|
185
197
|
PartOfSpeechTag = Shapes::StructureShape.new(name: 'PartOfSpeechTag')
|
186
198
|
PartOfSpeechTagType = Shapes::StringShape.new(name: 'PartOfSpeechTagType')
|
199
|
+
PiiEntitiesDetectionJobFilter = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobFilter')
|
200
|
+
PiiEntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobProperties')
|
201
|
+
PiiEntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'PiiEntitiesDetectionJobPropertiesList')
|
202
|
+
PiiEntitiesDetectionMaskMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMaskMode')
|
203
|
+
PiiEntitiesDetectionMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMode')
|
204
|
+
PiiEntity = Shapes::StructureShape.new(name: 'PiiEntity')
|
205
|
+
PiiEntityType = Shapes::StringShape.new(name: 'PiiEntityType')
|
206
|
+
PiiOutputDataConfig = Shapes::StructureShape.new(name: 'PiiOutputDataConfig')
|
207
|
+
RedactionConfig = Shapes::StructureShape.new(name: 'RedactionConfig')
|
187
208
|
ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
|
188
209
|
ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
|
189
210
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
@@ -204,6 +225,8 @@ module Aws::Comprehend
|
|
204
225
|
StartEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobResponse')
|
205
226
|
StartKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobRequest')
|
206
227
|
StartKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobResponse')
|
228
|
+
StartPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobRequest')
|
229
|
+
StartPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobResponse')
|
207
230
|
StartSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobRequest')
|
208
231
|
StartSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobResponse')
|
209
232
|
StartTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartTopicsDetectionJobRequest')
|
@@ -214,6 +237,8 @@ module Aws::Comprehend
|
|
214
237
|
StopEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobResponse')
|
215
238
|
StopKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobRequest')
|
216
239
|
StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
|
240
|
+
StopPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobRequest')
|
241
|
+
StopPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobResponse')
|
217
242
|
StopSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobRequest')
|
218
243
|
StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
|
219
244
|
StopTrainingDocumentClassifierRequest = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierRequest')
|
@@ -221,7 +246,6 @@ module Aws::Comprehend
|
|
221
246
|
StopTrainingEntityRecognizerRequest = Shapes::StructureShape.new(name: 'StopTrainingEntityRecognizerRequest')
|
222
247
|
StopTrainingEntityRecognizerResponse = Shapes::StructureShape.new(name: 'StopTrainingEntityRecognizerResponse')
|
223
248
|
String = Shapes::StringShape.new(name: 'String')
|
224
|
-
StringList = Shapes::ListShape.new(name: 'StringList')
|
225
249
|
SubnetId = Shapes::StringShape.new(name: 'SubnetId')
|
226
250
|
Subnets = Shapes::ListShape.new(name: 'Subnets')
|
227
251
|
SyntaxLanguageCode = Shapes::StringShape.new(name: 'SyntaxLanguageCode')
|
@@ -252,7 +276,7 @@ module Aws::Comprehend
|
|
252
276
|
BatchDetectDominantLanguageItemResult.add_member(:languages, Shapes::ShapeRef.new(shape: ListOfDominantLanguages, location_name: "Languages"))
|
253
277
|
BatchDetectDominantLanguageItemResult.struct_class = Types::BatchDetectDominantLanguageItemResult
|
254
278
|
|
255
|
-
BatchDetectDominantLanguageRequest.add_member(:text_list, Shapes::ShapeRef.new(shape:
|
279
|
+
BatchDetectDominantLanguageRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
|
256
280
|
BatchDetectDominantLanguageRequest.struct_class = Types::BatchDetectDominantLanguageRequest
|
257
281
|
|
258
282
|
BatchDetectDominantLanguageResponse.add_member(:result_list, Shapes::ShapeRef.new(shape: ListOfDetectDominantLanguageResult, required: true, location_name: "ResultList"))
|
@@ -263,7 +287,7 @@ module Aws::Comprehend
|
|
263
287
|
BatchDetectEntitiesItemResult.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfEntities, location_name: "Entities"))
|
264
288
|
BatchDetectEntitiesItemResult.struct_class = Types::BatchDetectEntitiesItemResult
|
265
289
|
|
266
|
-
BatchDetectEntitiesRequest.add_member(:text_list, Shapes::ShapeRef.new(shape:
|
290
|
+
BatchDetectEntitiesRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
|
267
291
|
BatchDetectEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
268
292
|
BatchDetectEntitiesRequest.struct_class = Types::BatchDetectEntitiesRequest
|
269
293
|
|
@@ -275,7 +299,7 @@ module Aws::Comprehend
|
|
275
299
|
BatchDetectKeyPhrasesItemResult.add_member(:key_phrases, Shapes::ShapeRef.new(shape: ListOfKeyPhrases, location_name: "KeyPhrases"))
|
276
300
|
BatchDetectKeyPhrasesItemResult.struct_class = Types::BatchDetectKeyPhrasesItemResult
|
277
301
|
|
278
|
-
BatchDetectKeyPhrasesRequest.add_member(:text_list, Shapes::ShapeRef.new(shape:
|
302
|
+
BatchDetectKeyPhrasesRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
|
279
303
|
BatchDetectKeyPhrasesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
280
304
|
BatchDetectKeyPhrasesRequest.struct_class = Types::BatchDetectKeyPhrasesRequest
|
281
305
|
|
@@ -288,7 +312,7 @@ module Aws::Comprehend
|
|
288
312
|
BatchDetectSentimentItemResult.add_member(:sentiment_score, Shapes::ShapeRef.new(shape: SentimentScore, location_name: "SentimentScore"))
|
289
313
|
BatchDetectSentimentItemResult.struct_class = Types::BatchDetectSentimentItemResult
|
290
314
|
|
291
|
-
BatchDetectSentimentRequest.add_member(:text_list, Shapes::ShapeRef.new(shape:
|
315
|
+
BatchDetectSentimentRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
|
292
316
|
BatchDetectSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
293
317
|
BatchDetectSentimentRequest.struct_class = Types::BatchDetectSentimentRequest
|
294
318
|
|
@@ -300,7 +324,7 @@ module Aws::Comprehend
|
|
300
324
|
BatchDetectSyntaxItemResult.add_member(:syntax_tokens, Shapes::ShapeRef.new(shape: ListOfSyntaxTokens, location_name: "SyntaxTokens"))
|
301
325
|
BatchDetectSyntaxItemResult.struct_class = Types::BatchDetectSyntaxItemResult
|
302
326
|
|
303
|
-
BatchDetectSyntaxRequest.add_member(:text_list, Shapes::ShapeRef.new(shape:
|
327
|
+
BatchDetectSyntaxRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
|
304
328
|
BatchDetectSyntaxRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: SyntaxLanguageCode, required: true, location_name: "LanguageCode"))
|
305
329
|
BatchDetectSyntaxRequest.struct_class = Types::BatchDetectSyntaxRequest
|
306
330
|
|
@@ -334,7 +358,7 @@ module Aws::Comprehend
|
|
334
358
|
ClassifierMetadata.add_member(:evaluation_metrics, Shapes::ShapeRef.new(shape: ClassifierEvaluationMetrics, location_name: "EvaluationMetrics"))
|
335
359
|
ClassifierMetadata.struct_class = Types::ClassifierMetadata
|
336
360
|
|
337
|
-
ClassifyDocumentRequest.add_member(:text, Shapes::ShapeRef.new(shape:
|
361
|
+
ClassifyDocumentRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
338
362
|
ClassifyDocumentRequest.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: DocumentClassifierEndpointArn, required: true, location_name: "EndpointArn"))
|
339
363
|
ClassifyDocumentRequest.struct_class = Types::ClassifyDocumentRequest
|
340
364
|
|
@@ -383,6 +407,8 @@ module Aws::Comprehend
|
|
383
407
|
CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
384
408
|
CreateEntityRecognizerResponse.struct_class = Types::CreateEntityRecognizerResponse
|
385
409
|
|
410
|
+
CustomerInputStringList.member = Shapes::ShapeRef.new(shape: CustomerInputString)
|
411
|
+
|
386
412
|
DeleteDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
|
387
413
|
DeleteDocumentClassifierRequest.struct_class = Types::DeleteDocumentClassifierRequest
|
388
414
|
|
@@ -440,6 +466,12 @@ module Aws::Comprehend
|
|
440
466
|
DescribeKeyPhrasesDetectionJobResponse.add_member(:key_phrases_detection_job_properties, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobProperties, location_name: "KeyPhrasesDetectionJobProperties"))
|
441
467
|
DescribeKeyPhrasesDetectionJobResponse.struct_class = Types::DescribeKeyPhrasesDetectionJobResponse
|
442
468
|
|
469
|
+
DescribePiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
470
|
+
DescribePiiEntitiesDetectionJobRequest.struct_class = Types::DescribePiiEntitiesDetectionJobRequest
|
471
|
+
|
472
|
+
DescribePiiEntitiesDetectionJobResponse.add_member(:pii_entities_detection_job_properties, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties, location_name: "PiiEntitiesDetectionJobProperties"))
|
473
|
+
DescribePiiEntitiesDetectionJobResponse.struct_class = Types::DescribePiiEntitiesDetectionJobResponse
|
474
|
+
|
443
475
|
DescribeSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
444
476
|
DescribeSentimentDetectionJobRequest.struct_class = Types::DescribeSentimentDetectionJobRequest
|
445
477
|
|
@@ -452,27 +484,35 @@ module Aws::Comprehend
|
|
452
484
|
DescribeTopicsDetectionJobResponse.add_member(:topics_detection_job_properties, Shapes::ShapeRef.new(shape: TopicsDetectionJobProperties, location_name: "TopicsDetectionJobProperties"))
|
453
485
|
DescribeTopicsDetectionJobResponse.struct_class = Types::DescribeTopicsDetectionJobResponse
|
454
486
|
|
455
|
-
DetectDominantLanguageRequest.add_member(:text, Shapes::ShapeRef.new(shape:
|
487
|
+
DetectDominantLanguageRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
456
488
|
DetectDominantLanguageRequest.struct_class = Types::DetectDominantLanguageRequest
|
457
489
|
|
458
490
|
DetectDominantLanguageResponse.add_member(:languages, Shapes::ShapeRef.new(shape: ListOfDominantLanguages, location_name: "Languages"))
|
459
491
|
DetectDominantLanguageResponse.struct_class = Types::DetectDominantLanguageResponse
|
460
492
|
|
461
|
-
DetectEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape:
|
462
|
-
DetectEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode,
|
493
|
+
DetectEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
494
|
+
DetectEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
495
|
+
DetectEntitiesRequest.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: EntityRecognizerEndpointArn, location_name: "EndpointArn"))
|
463
496
|
DetectEntitiesRequest.struct_class = Types::DetectEntitiesRequest
|
464
497
|
|
465
498
|
DetectEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfEntities, location_name: "Entities"))
|
466
499
|
DetectEntitiesResponse.struct_class = Types::DetectEntitiesResponse
|
467
500
|
|
468
|
-
DetectKeyPhrasesRequest.add_member(:text, Shapes::ShapeRef.new(shape:
|
501
|
+
DetectKeyPhrasesRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
469
502
|
DetectKeyPhrasesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
470
503
|
DetectKeyPhrasesRequest.struct_class = Types::DetectKeyPhrasesRequest
|
471
504
|
|
472
505
|
DetectKeyPhrasesResponse.add_member(:key_phrases, Shapes::ShapeRef.new(shape: ListOfKeyPhrases, location_name: "KeyPhrases"))
|
473
506
|
DetectKeyPhrasesResponse.struct_class = Types::DetectKeyPhrasesResponse
|
474
507
|
|
475
|
-
|
508
|
+
DetectPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
509
|
+
DetectPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
510
|
+
DetectPiiEntitiesRequest.struct_class = Types::DetectPiiEntitiesRequest
|
511
|
+
|
512
|
+
DetectPiiEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfPiiEntities, location_name: "Entities"))
|
513
|
+
DetectPiiEntitiesResponse.struct_class = Types::DetectPiiEntitiesResponse
|
514
|
+
|
515
|
+
DetectSentimentRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
476
516
|
DetectSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
477
517
|
DetectSentimentRequest.struct_class = Types::DetectSentimentRequest
|
478
518
|
|
@@ -480,7 +520,7 @@ module Aws::Comprehend
|
|
480
520
|
DetectSentimentResponse.add_member(:sentiment_score, Shapes::ShapeRef.new(shape: SentimentScore, location_name: "SentimentScore"))
|
481
521
|
DetectSentimentResponse.struct_class = Types::DetectSentimentResponse
|
482
522
|
|
483
|
-
DetectSyntaxRequest.add_member(:text, Shapes::ShapeRef.new(shape:
|
523
|
+
DetectSyntaxRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
484
524
|
DetectSyntaxRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: SyntaxLanguageCode, required: true, location_name: "LanguageCode"))
|
485
525
|
DetectSyntaxRequest.struct_class = Types::DetectSyntaxRequest
|
486
526
|
|
@@ -817,8 +857,21 @@ module Aws::Comprehend
|
|
817
857
|
|
818
858
|
ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
|
819
859
|
|
860
|
+
ListOfPiiEntities.member = Shapes::ShapeRef.new(shape: PiiEntity)
|
861
|
+
|
862
|
+
ListOfPiiEntityTypes.member = Shapes::ShapeRef.new(shape: PiiEntityType)
|
863
|
+
|
820
864
|
ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
|
821
865
|
|
866
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobFilter, location_name: "Filter"))
|
867
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
868
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
869
|
+
ListPiiEntitiesDetectionJobsRequest.struct_class = Types::ListPiiEntitiesDetectionJobsRequest
|
870
|
+
|
871
|
+
ListPiiEntitiesDetectionJobsResponse.add_member(:pii_entities_detection_job_properties_list, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobPropertiesList, location_name: "PiiEntitiesDetectionJobPropertiesList"))
|
872
|
+
ListPiiEntitiesDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
873
|
+
ListPiiEntitiesDetectionJobsResponse.struct_class = Types::ListPiiEntitiesDetectionJobsResponse
|
874
|
+
|
822
875
|
ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))
|
823
876
|
ListSentimentDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
824
877
|
ListSentimentDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -852,6 +905,43 @@ module Aws::Comprehend
|
|
852
905
|
PartOfSpeechTag.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
853
906
|
PartOfSpeechTag.struct_class = Types::PartOfSpeechTag
|
854
907
|
|
908
|
+
PiiEntitiesDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
909
|
+
PiiEntitiesDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
910
|
+
PiiEntitiesDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
911
|
+
PiiEntitiesDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
912
|
+
PiiEntitiesDetectionJobFilter.struct_class = Types::PiiEntitiesDetectionJobFilter
|
913
|
+
|
914
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
915
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
916
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
917
|
+
PiiEntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
918
|
+
PiiEntitiesDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
919
|
+
PiiEntitiesDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
920
|
+
PiiEntitiesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
921
|
+
PiiEntitiesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: PiiOutputDataConfig, location_name: "OutputDataConfig"))
|
922
|
+
PiiEntitiesDetectionJobProperties.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
|
923
|
+
PiiEntitiesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
924
|
+
PiiEntitiesDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
925
|
+
PiiEntitiesDetectionJobProperties.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, location_name: "Mode"))
|
926
|
+
PiiEntitiesDetectionJobProperties.struct_class = Types::PiiEntitiesDetectionJobProperties
|
927
|
+
|
928
|
+
PiiEntitiesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties)
|
929
|
+
|
930
|
+
PiiEntity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
931
|
+
PiiEntity.add_member(:type, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Type"))
|
932
|
+
PiiEntity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
|
933
|
+
PiiEntity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
|
934
|
+
PiiEntity.struct_class = Types::PiiEntity
|
935
|
+
|
936
|
+
PiiOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
937
|
+
PiiOutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
|
938
|
+
PiiOutputDataConfig.struct_class = Types::PiiOutputDataConfig
|
939
|
+
|
940
|
+
RedactionConfig.add_member(:pii_entity_types, Shapes::ShapeRef.new(shape: ListOfPiiEntityTypes, location_name: "PiiEntityTypes"))
|
941
|
+
RedactionConfig.add_member(:mask_mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMaskMode, location_name: "MaskMode"))
|
942
|
+
RedactionConfig.add_member(:mask_character, Shapes::ShapeRef.new(shape: MaskCharacter, location_name: "MaskCharacter"))
|
943
|
+
RedactionConfig.struct_class = Types::RedactionConfig
|
944
|
+
|
855
945
|
ResourceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
856
946
|
ResourceInUseException.struct_class = Types::ResourceInUseException
|
857
947
|
|
@@ -950,6 +1040,20 @@ module Aws::Comprehend
|
|
950
1040
|
StartKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
951
1041
|
StartKeyPhrasesDetectionJobResponse.struct_class = Types::StartKeyPhrasesDetectionJobResponse
|
952
1042
|
|
1043
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1044
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1045
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, required: true, location_name: "Mode"))
|
1046
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
|
1047
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
1048
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1049
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1050
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1051
|
+
StartPiiEntitiesDetectionJobRequest.struct_class = Types::StartPiiEntitiesDetectionJobRequest
|
1052
|
+
|
1053
|
+
StartPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1054
|
+
StartPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1055
|
+
StartPiiEntitiesDetectionJobResponse.struct_class = Types::StartPiiEntitiesDetectionJobResponse
|
1056
|
+
|
953
1057
|
StartSentimentDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
954
1058
|
StartSentimentDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
955
1059
|
StartSentimentDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
@@ -999,6 +1103,13 @@ module Aws::Comprehend
|
|
999
1103
|
StopKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1000
1104
|
StopKeyPhrasesDetectionJobResponse.struct_class = Types::StopKeyPhrasesDetectionJobResponse
|
1001
1105
|
|
1106
|
+
StopPiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1107
|
+
StopPiiEntitiesDetectionJobRequest.struct_class = Types::StopPiiEntitiesDetectionJobRequest
|
1108
|
+
|
1109
|
+
StopPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1110
|
+
StopPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1111
|
+
StopPiiEntitiesDetectionJobResponse.struct_class = Types::StopPiiEntitiesDetectionJobResponse
|
1112
|
+
|
1002
1113
|
StopSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1003
1114
|
StopSentimentDetectionJobRequest.struct_class = Types::StopSentimentDetectionJobRequest
|
1004
1115
|
|
@@ -1016,8 +1127,6 @@ module Aws::Comprehend
|
|
1016
1127
|
|
1017
1128
|
StopTrainingEntityRecognizerResponse.struct_class = Types::StopTrainingEntityRecognizerResponse
|
1018
1129
|
|
1019
|
-
StringList.member = Shapes::ShapeRef.new(shape: String)
|
1020
|
-
|
1021
1130
|
Subnets.member = Shapes::ShapeRef.new(shape: SubnetId)
|
1022
1131
|
|
1023
1132
|
SyntaxToken.add_member(:token_id, Shapes::ShapeRef.new(shape: Integer, location_name: "TokenId"))
|
@@ -1362,6 +1471,18 @@ module Aws::Comprehend
|
|
1362
1471
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1363
1472
|
end)
|
1364
1473
|
|
1474
|
+
api.add_operation(:describe_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1475
|
+
o.name = "DescribePiiEntitiesDetectionJob"
|
1476
|
+
o.http_method = "POST"
|
1477
|
+
o.http_request_uri = "/"
|
1478
|
+
o.input = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobRequest)
|
1479
|
+
o.output = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobResponse)
|
1480
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1481
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1482
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1483
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1484
|
+
end)
|
1485
|
+
|
1365
1486
|
api.add_operation(:describe_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1366
1487
|
o.name = "DescribeSentimentDetectionJob"
|
1367
1488
|
o.http_method = "POST"
|
@@ -1404,6 +1525,7 @@ module Aws::Comprehend
|
|
1404
1525
|
o.input = Shapes::ShapeRef.new(shape: DetectEntitiesRequest)
|
1405
1526
|
o.output = Shapes::ShapeRef.new(shape: DetectEntitiesResponse)
|
1406
1527
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1528
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1407
1529
|
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
1408
1530
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
1409
1531
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
@@ -1421,6 +1543,18 @@ module Aws::Comprehend
|
|
1421
1543
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1422
1544
|
end)
|
1423
1545
|
|
1546
|
+
api.add_operation(:detect_pii_entities, Seahorse::Model::Operation.new.tap do |o|
|
1547
|
+
o.name = "DetectPiiEntities"
|
1548
|
+
o.http_method = "POST"
|
1549
|
+
o.http_request_uri = "/"
|
1550
|
+
o.input = Shapes::ShapeRef.new(shape: DetectPiiEntitiesRequest)
|
1551
|
+
o.output = Shapes::ShapeRef.new(shape: DetectPiiEntitiesResponse)
|
1552
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1553
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
1554
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
1555
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1556
|
+
end)
|
1557
|
+
|
1424
1558
|
api.add_operation(:detect_sentiment, Seahorse::Model::Operation.new.tap do |o|
|
1425
1559
|
o.name = "DetectSentiment"
|
1426
1560
|
o.http_method = "POST"
|
@@ -1564,6 +1698,18 @@ module Aws::Comprehend
|
|
1564
1698
|
)
|
1565
1699
|
end)
|
1566
1700
|
|
1701
|
+
api.add_operation(:list_pii_entities_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1702
|
+
o.name = "ListPiiEntitiesDetectionJobs"
|
1703
|
+
o.http_method = "POST"
|
1704
|
+
o.http_request_uri = "/"
|
1705
|
+
o.input = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsRequest)
|
1706
|
+
o.output = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsResponse)
|
1707
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1708
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1709
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
1710
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1711
|
+
end)
|
1712
|
+
|
1567
1713
|
api.add_operation(:list_sentiment_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1568
1714
|
o.name = "ListSentimentDetectionJobs"
|
1569
1715
|
o.http_method = "POST"
|
@@ -1663,6 +1809,18 @@ module Aws::Comprehend
|
|
1663
1809
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1664
1810
|
end)
|
1665
1811
|
|
1812
|
+
api.add_operation(:start_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1813
|
+
o.name = "StartPiiEntitiesDetectionJob"
|
1814
|
+
o.http_method = "POST"
|
1815
|
+
o.http_request_uri = "/"
|
1816
|
+
o.input = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobRequest)
|
1817
|
+
o.output = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobResponse)
|
1818
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1819
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1820
|
+
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1821
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1822
|
+
end)
|
1823
|
+
|
1666
1824
|
api.add_operation(:start_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1667
1825
|
o.name = "StartSentimentDetectionJob"
|
1668
1826
|
o.http_method = "POST"
|
@@ -1720,6 +1878,17 @@ module Aws::Comprehend
|
|
1720
1878
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1721
1879
|
end)
|
1722
1880
|
|
1881
|
+
api.add_operation(:stop_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1882
|
+
o.name = "StopPiiEntitiesDetectionJob"
|
1883
|
+
o.http_method = "POST"
|
1884
|
+
o.http_request_uri = "/"
|
1885
|
+
o.input = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobRequest)
|
1886
|
+
o.output = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobResponse)
|
1887
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1888
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1889
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1890
|
+
end)
|
1891
|
+
|
1723
1892
|
api.add_operation(:stop_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1724
1893
|
o.name = "StopSentimentDetectionJob"
|
1725
1894
|
o.http_method = "POST"
|
@@ -35,7 +35,7 @@ module Aws::Comprehend
|
|
35
35
|
# data as a hash:
|
36
36
|
#
|
37
37
|
# {
|
38
|
-
# text_list: ["
|
38
|
+
# text_list: ["CustomerInputString"], # required
|
39
39
|
# }
|
40
40
|
#
|
41
41
|
# @!attribute [rw] text_list
|
@@ -49,7 +49,7 @@ module Aws::Comprehend
|
|
49
49
|
#
|
50
50
|
class BatchDetectDominantLanguageRequest < Struct.new(
|
51
51
|
:text_list)
|
52
|
-
SENSITIVE = []
|
52
|
+
SENSITIVE = [:text_list]
|
53
53
|
include Aws::Structure
|
54
54
|
end
|
55
55
|
|
@@ -101,7 +101,7 @@ module Aws::Comprehend
|
|
101
101
|
# data as a hash:
|
102
102
|
#
|
103
103
|
# {
|
104
|
-
# text_list: ["
|
104
|
+
# text_list: ["CustomerInputString"], # required
|
105
105
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
106
106
|
# }
|
107
107
|
#
|
@@ -122,7 +122,7 @@ module Aws::Comprehend
|
|
122
122
|
class BatchDetectEntitiesRequest < Struct.new(
|
123
123
|
:text_list,
|
124
124
|
:language_code)
|
125
|
-
SENSITIVE = []
|
125
|
+
SENSITIVE = [:text_list]
|
126
126
|
include Aws::Structure
|
127
127
|
end
|
128
128
|
|
@@ -174,7 +174,7 @@ module Aws::Comprehend
|
|
174
174
|
# data as a hash:
|
175
175
|
#
|
176
176
|
# {
|
177
|
-
# text_list: ["
|
177
|
+
# text_list: ["CustomerInputString"], # required
|
178
178
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
179
179
|
# }
|
180
180
|
#
|
@@ -195,7 +195,7 @@ module Aws::Comprehend
|
|
195
195
|
class BatchDetectKeyPhrasesRequest < Struct.new(
|
196
196
|
:text_list,
|
197
197
|
:language_code)
|
198
|
-
SENSITIVE = []
|
198
|
+
SENSITIVE = [:text_list]
|
199
199
|
include Aws::Structure
|
200
200
|
end
|
201
201
|
|
@@ -252,7 +252,7 @@ module Aws::Comprehend
|
|
252
252
|
# data as a hash:
|
253
253
|
#
|
254
254
|
# {
|
255
|
-
# text_list: ["
|
255
|
+
# text_list: ["CustomerInputString"], # required
|
256
256
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
257
257
|
# }
|
258
258
|
#
|
@@ -273,7 +273,7 @@ module Aws::Comprehend
|
|
273
273
|
class BatchDetectSentimentRequest < Struct.new(
|
274
274
|
:text_list,
|
275
275
|
:language_code)
|
276
|
-
SENSITIVE = []
|
276
|
+
SENSITIVE = [:text_list]
|
277
277
|
include Aws::Structure
|
278
278
|
end
|
279
279
|
|
@@ -325,7 +325,7 @@ module Aws::Comprehend
|
|
325
325
|
# data as a hash:
|
326
326
|
#
|
327
327
|
# {
|
328
|
-
# text_list: ["
|
328
|
+
# text_list: ["CustomerInputString"], # required
|
329
329
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
330
330
|
# }
|
331
331
|
#
|
@@ -348,7 +348,7 @@ module Aws::Comprehend
|
|
348
348
|
class BatchDetectSyntaxRequest < Struct.new(
|
349
349
|
:text_list,
|
350
350
|
:language_code)
|
351
|
-
SENSITIVE = []
|
351
|
+
SENSITIVE = [:text_list]
|
352
352
|
include Aws::Structure
|
353
353
|
end
|
354
354
|
|
@@ -507,7 +507,7 @@ module Aws::Comprehend
|
|
507
507
|
# @!attribute [rw] number_of_test_documents
|
508
508
|
# The number of documents in the input data that were used to test the
|
509
509
|
# classifier. Typically this is 10 to 20 percent of the input
|
510
|
-
# documents.
|
510
|
+
# documents, up to 10,000 documents.
|
511
511
|
# @return [Integer]
|
512
512
|
#
|
513
513
|
# @!attribute [rw] evaluation_metrics
|
@@ -530,7 +530,7 @@ module Aws::Comprehend
|
|
530
530
|
# data as a hash:
|
531
531
|
#
|
532
532
|
# {
|
533
|
-
# text: "
|
533
|
+
# text: "CustomerInputString", # required
|
534
534
|
# endpoint_arn: "DocumentClassifierEndpointArn", # required
|
535
535
|
# }
|
536
536
|
#
|
@@ -547,7 +547,7 @@ module Aws::Comprehend
|
|
547
547
|
class ClassifyDocumentRequest < Struct.new(
|
548
548
|
:text,
|
549
549
|
:endpoint_arn)
|
550
|
-
SENSITIVE = []
|
550
|
+
SENSITIVE = [:text]
|
551
551
|
include Aws::Structure
|
552
552
|
end
|
553
553
|
|
@@ -870,8 +870,10 @@ module Aws::Comprehend
|
|
870
870
|
# @return [String]
|
871
871
|
#
|
872
872
|
# @!attribute [rw] language_code
|
873
|
-
#
|
874
|
-
#
|
873
|
+
# You can specify any of the following languages supported by Amazon
|
874
|
+
# Comprehend: English ("en"), Spanish ("es"), French ("fr"),
|
875
|
+
# Italian ("it"), German ("de"), or Portuguese ("pt"). All
|
876
|
+
# documents must be in the same language.
|
875
877
|
# @return [String]
|
876
878
|
#
|
877
879
|
# @!attribute [rw] volume_kms_key_id
|
@@ -1223,6 +1225,38 @@ module Aws::Comprehend
|
|
1223
1225
|
include Aws::Structure
|
1224
1226
|
end
|
1225
1227
|
|
1228
|
+
# @note When making an API call, you may pass DescribePiiEntitiesDetectionJobRequest
|
1229
|
+
# data as a hash:
|
1230
|
+
#
|
1231
|
+
# {
|
1232
|
+
# job_id: "JobId", # required
|
1233
|
+
# }
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] job_id
|
1236
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
1237
|
+
# operation returns this identifier in its response.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobRequest AWS API Documentation
|
1241
|
+
#
|
1242
|
+
class DescribePiiEntitiesDetectionJobRequest < Struct.new(
|
1243
|
+
:job_id)
|
1244
|
+
SENSITIVE = []
|
1245
|
+
include Aws::Structure
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
# @!attribute [rw] pii_entities_detection_job_properties
|
1249
|
+
# Provides information about a PII entities detection job.
|
1250
|
+
# @return [Types::PiiEntitiesDetectionJobProperties]
|
1251
|
+
#
|
1252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobResponse AWS API Documentation
|
1253
|
+
#
|
1254
|
+
class DescribePiiEntitiesDetectionJobResponse < Struct.new(
|
1255
|
+
:pii_entities_detection_job_properties)
|
1256
|
+
SENSITIVE = []
|
1257
|
+
include Aws::Structure
|
1258
|
+
end
|
1259
|
+
|
1226
1260
|
# @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
|
1227
1261
|
# data as a hash:
|
1228
1262
|
#
|
@@ -1291,7 +1325,7 @@ module Aws::Comprehend
|
|
1291
1325
|
# data as a hash:
|
1292
1326
|
#
|
1293
1327
|
# {
|
1294
|
-
# text: "
|
1328
|
+
# text: "CustomerInputString", # required
|
1295
1329
|
# }
|
1296
1330
|
#
|
1297
1331
|
# @!attribute [rw] text
|
@@ -1304,7 +1338,7 @@ module Aws::Comprehend
|
|
1304
1338
|
#
|
1305
1339
|
class DetectDominantLanguageRequest < Struct.new(
|
1306
1340
|
:text)
|
1307
|
-
SENSITIVE = []
|
1341
|
+
SENSITIVE = [:text]
|
1308
1342
|
include Aws::Structure
|
1309
1343
|
end
|
1310
1344
|
|
@@ -1332,8 +1366,9 @@ module Aws::Comprehend
|
|
1332
1366
|
# data as a hash:
|
1333
1367
|
#
|
1334
1368
|
# {
|
1335
|
-
# text: "
|
1336
|
-
# language_code: "en", #
|
1369
|
+
# text: "CustomerInputString", # required
|
1370
|
+
# language_code: "en", # accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1371
|
+
# endpoint_arn: "EntityRecognizerEndpointArn",
|
1337
1372
|
# }
|
1338
1373
|
#
|
1339
1374
|
# @!attribute [rw] text
|
@@ -1345,14 +1380,31 @@ module Aws::Comprehend
|
|
1345
1380
|
# The language of the input documents. You can specify any of the
|
1346
1381
|
# primary languages supported by Amazon Comprehend. All documents must
|
1347
1382
|
# be in the same language.
|
1383
|
+
#
|
1384
|
+
# If your request includes the endpoint for a custom entity
|
1385
|
+
# recognition model, Amazon Comprehend uses the language of your
|
1386
|
+
# custom model, and it ignores any language code that you specify
|
1387
|
+
# here.
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] endpoint_arn
|
1391
|
+
# The Amazon Resource Name of an endpoint that is associated with a
|
1392
|
+
# custom entity recognition model. Provide an endpoint if you want to
|
1393
|
+
# detect entities by using your own custom model instead of the
|
1394
|
+
# default model that is used by Amazon Comprehend.
|
1395
|
+
#
|
1396
|
+
# If you specify an endpoint, Amazon Comprehend uses the language of
|
1397
|
+
# your custom model, and it ignores any language code that you provide
|
1398
|
+
# in your request.
|
1348
1399
|
# @return [String]
|
1349
1400
|
#
|
1350
1401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
|
1351
1402
|
#
|
1352
1403
|
class DetectEntitiesRequest < Struct.new(
|
1353
1404
|
:text,
|
1354
|
-
:language_code
|
1355
|
-
|
1405
|
+
:language_code,
|
1406
|
+
:endpoint_arn)
|
1407
|
+
SENSITIVE = [:text]
|
1356
1408
|
include Aws::Structure
|
1357
1409
|
end
|
1358
1410
|
|
@@ -1360,8 +1412,12 @@ module Aws::Comprehend
|
|
1360
1412
|
# A collection of entities identified in the input text. For each
|
1361
1413
|
# entity, the response provides the entity text, entity type, where
|
1362
1414
|
# the entity text begins and ends, and the level of confidence that
|
1363
|
-
# Amazon Comprehend has in the detection.
|
1364
|
-
#
|
1415
|
+
# Amazon Comprehend has in the detection.
|
1416
|
+
#
|
1417
|
+
# If your request uses a custom entity recognition model, Amazon
|
1418
|
+
# Comprehend detects the entities that the model is trained to
|
1419
|
+
# recognize. Otherwise, it detects the default entity types. For a
|
1420
|
+
# list of default entity types, see how-entities.
|
1365
1421
|
# @return [Array<Types::Entity>]
|
1366
1422
|
#
|
1367
1423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesResponse AWS API Documentation
|
@@ -1376,7 +1432,7 @@ module Aws::Comprehend
|
|
1376
1432
|
# data as a hash:
|
1377
1433
|
#
|
1378
1434
|
# {
|
1379
|
-
# text: "
|
1435
|
+
# text: "CustomerInputString", # required
|
1380
1436
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1381
1437
|
# }
|
1382
1438
|
#
|
@@ -1396,7 +1452,7 @@ module Aws::Comprehend
|
|
1396
1452
|
class DetectKeyPhrasesRequest < Struct.new(
|
1397
1453
|
:text,
|
1398
1454
|
:language_code)
|
1399
|
-
SENSITIVE = []
|
1455
|
+
SENSITIVE = [:text]
|
1400
1456
|
include Aws::Structure
|
1401
1457
|
end
|
1402
1458
|
|
@@ -1416,7 +1472,7 @@ module Aws::Comprehend
|
|
1416
1472
|
include Aws::Structure
|
1417
1473
|
end
|
1418
1474
|
|
1419
|
-
# @note When making an API call, you may pass
|
1475
|
+
# @note When making an API call, you may pass DetectPiiEntitiesRequest
|
1420
1476
|
# data as a hash:
|
1421
1477
|
#
|
1422
1478
|
# {
|
@@ -1430,6 +1486,47 @@ module Aws::Comprehend
|
|
1430
1486
|
# @return [String]
|
1431
1487
|
#
|
1432
1488
|
# @!attribute [rw] language_code
|
1489
|
+
# The language of the input documents.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
|
1493
|
+
#
|
1494
|
+
class DetectPiiEntitiesRequest < Struct.new(
|
1495
|
+
:text,
|
1496
|
+
:language_code)
|
1497
|
+
SENSITIVE = []
|
1498
|
+
include Aws::Structure
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
# @!attribute [rw] entities
|
1502
|
+
# A collection of PII entities identified in the input text. For each
|
1503
|
+
# entity, the response provides the entity type, where the entity text
|
1504
|
+
# begins and ends, and the level of confidence that Amazon Comprehend
|
1505
|
+
# has in the detection.
|
1506
|
+
# @return [Array<Types::PiiEntity>]
|
1507
|
+
#
|
1508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesResponse AWS API Documentation
|
1509
|
+
#
|
1510
|
+
class DetectPiiEntitiesResponse < Struct.new(
|
1511
|
+
:entities)
|
1512
|
+
SENSITIVE = []
|
1513
|
+
include Aws::Structure
|
1514
|
+
end
|
1515
|
+
|
1516
|
+
# @note When making an API call, you may pass DetectSentimentRequest
|
1517
|
+
# data as a hash:
|
1518
|
+
#
|
1519
|
+
# {
|
1520
|
+
# text: "CustomerInputString", # required
|
1521
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1522
|
+
# }
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] text
|
1525
|
+
# A UTF-8 text string. Each string must contain fewer that 5,000 bytes
|
1526
|
+
# of UTF-8 encoded characters.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] language_code
|
1433
1530
|
# The language of the input documents. You can specify any of the
|
1434
1531
|
# primary languages supported by Amazon Comprehend. All documents must
|
1435
1532
|
# be in the same language.
|
@@ -1440,7 +1537,7 @@ module Aws::Comprehend
|
|
1440
1537
|
class DetectSentimentRequest < Struct.new(
|
1441
1538
|
:text,
|
1442
1539
|
:language_code)
|
1443
|
-
SENSITIVE = []
|
1540
|
+
SENSITIVE = [:text]
|
1444
1541
|
include Aws::Structure
|
1445
1542
|
end
|
1446
1543
|
|
@@ -1467,7 +1564,7 @@ module Aws::Comprehend
|
|
1467
1564
|
# data as a hash:
|
1468
1565
|
#
|
1469
1566
|
# {
|
1470
|
-
# text: "
|
1567
|
+
# text: "CustomerInputString", # required
|
1471
1568
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
1472
1569
|
# }
|
1473
1570
|
#
|
@@ -1488,7 +1585,7 @@ module Aws::Comprehend
|
|
1488
1585
|
class DetectSyntaxRequest < Struct.new(
|
1489
1586
|
:text,
|
1490
1587
|
:language_code)
|
1491
|
-
SENSITIVE = []
|
1588
|
+
SENSITIVE = [:text]
|
1492
1589
|
include Aws::Structure
|
1493
1590
|
end
|
1494
1591
|
|
@@ -1553,14 +1650,14 @@ module Aws::Comprehend
|
|
1553
1650
|
#
|
1554
1651
|
# @!attribute [rw] submit_time_before
|
1555
1652
|
# Filters the list of jobs based on the time that the job was
|
1556
|
-
# submitted for processing. Returns only jobs submitted
|
1653
|
+
# submitted for processing. Returns only jobs submitted before the
|
1557
1654
|
# specified time. Jobs are returned in ascending order, oldest to
|
1558
1655
|
# newest.
|
1559
1656
|
# @return [Time]
|
1560
1657
|
#
|
1561
1658
|
# @!attribute [rw] submit_time_after
|
1562
1659
|
# Filters the list of jobs based on the time that the job was
|
1563
|
-
# submitted for processing. Returns only jobs submitted
|
1660
|
+
# submitted for processing. Returns only jobs submitted after the
|
1564
1661
|
# specified time. Jobs are returned in descending order, newest to
|
1565
1662
|
# oldest.
|
1566
1663
|
# @return [Time]
|
@@ -1913,7 +2010,7 @@ module Aws::Comprehend
|
|
1913
2010
|
:volume_kms_key_id,
|
1914
2011
|
:vpc_config,
|
1915
2012
|
:mode)
|
1916
|
-
SENSITIVE = []
|
2013
|
+
SENSITIVE = [:classifier_metadata]
|
1917
2014
|
include Aws::Structure
|
1918
2015
|
end
|
1919
2016
|
|
@@ -2547,7 +2644,7 @@ module Aws::Comprehend
|
|
2547
2644
|
#
|
2548
2645
|
# @!attribute [rw] entity_types
|
2549
2646
|
# The entity types in the input data for an entity recognizer. A
|
2550
|
-
# maximum of
|
2647
|
+
# maximum of 25 entity types can be used at one time to train an
|
2551
2648
|
# entity recognizer.
|
2552
2649
|
# @return [Array<Types::EntityTypesListItem>]
|
2553
2650
|
#
|
@@ -2723,7 +2820,7 @@ module Aws::Comprehend
|
|
2723
2820
|
:data_access_role_arn,
|
2724
2821
|
:volume_kms_key_id,
|
2725
2822
|
:vpc_config)
|
2726
|
-
SENSITIVE = []
|
2823
|
+
SENSITIVE = [:recognizer_metadata]
|
2727
2824
|
include Aws::Structure
|
2728
2825
|
end
|
2729
2826
|
|
@@ -3457,6 +3554,61 @@ module Aws::Comprehend
|
|
3457
3554
|
include Aws::Structure
|
3458
3555
|
end
|
3459
3556
|
|
3557
|
+
# @note When making an API call, you may pass ListPiiEntitiesDetectionJobsRequest
|
3558
|
+
# data as a hash:
|
3559
|
+
#
|
3560
|
+
# {
|
3561
|
+
# filter: {
|
3562
|
+
# job_name: "JobName",
|
3563
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3564
|
+
# submit_time_before: Time.now,
|
3565
|
+
# submit_time_after: Time.now,
|
3566
|
+
# },
|
3567
|
+
# next_token: "String",
|
3568
|
+
# max_results: 1,
|
3569
|
+
# }
|
3570
|
+
#
|
3571
|
+
# @!attribute [rw] filter
|
3572
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3573
|
+
# name, status, or the date and time that they were submitted. You can
|
3574
|
+
# only set one filter at a time.
|
3575
|
+
# @return [Types::PiiEntitiesDetectionJobFilter]
|
3576
|
+
#
|
3577
|
+
# @!attribute [rw] next_token
|
3578
|
+
# Identifies the next page of results to return.
|
3579
|
+
# @return [String]
|
3580
|
+
#
|
3581
|
+
# @!attribute [rw] max_results
|
3582
|
+
# The maximum number of results to return in each page.
|
3583
|
+
# @return [Integer]
|
3584
|
+
#
|
3585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsRequest AWS API Documentation
|
3586
|
+
#
|
3587
|
+
class ListPiiEntitiesDetectionJobsRequest < Struct.new(
|
3588
|
+
:filter,
|
3589
|
+
:next_token,
|
3590
|
+
:max_results)
|
3591
|
+
SENSITIVE = []
|
3592
|
+
include Aws::Structure
|
3593
|
+
end
|
3594
|
+
|
3595
|
+
# @!attribute [rw] pii_entities_detection_job_properties_list
|
3596
|
+
# A list containing the properties of each job that is returned.
|
3597
|
+
# @return [Array<Types::PiiEntitiesDetectionJobProperties>]
|
3598
|
+
#
|
3599
|
+
# @!attribute [rw] next_token
|
3600
|
+
# Identifies the next page of results to return.
|
3601
|
+
# @return [String]
|
3602
|
+
#
|
3603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsResponse AWS API Documentation
|
3604
|
+
#
|
3605
|
+
class ListPiiEntitiesDetectionJobsResponse < Struct.new(
|
3606
|
+
:pii_entities_detection_job_properties_list,
|
3607
|
+
:next_token)
|
3608
|
+
SENSITIVE = []
|
3609
|
+
include Aws::Structure
|
3610
|
+
end
|
3611
|
+
|
3460
3612
|
# @note When making an API call, you may pass ListSentimentDetectionJobsRequest
|
3461
3613
|
# data as a hash:
|
3462
3614
|
#
|
@@ -3683,8 +3835,230 @@ module Aws::Comprehend
|
|
3683
3835
|
include Aws::Structure
|
3684
3836
|
end
|
3685
3837
|
|
3686
|
-
#
|
3687
|
-
#
|
3838
|
+
# Provides information for filtering a list of PII entity detection
|
3839
|
+
# jobs.
|
3840
|
+
#
|
3841
|
+
# @note When making an API call, you may pass PiiEntitiesDetectionJobFilter
|
3842
|
+
# data as a hash:
|
3843
|
+
#
|
3844
|
+
# {
|
3845
|
+
# job_name: "JobName",
|
3846
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3847
|
+
# submit_time_before: Time.now,
|
3848
|
+
# submit_time_after: Time.now,
|
3849
|
+
# }
|
3850
|
+
#
|
3851
|
+
# @!attribute [rw] job_name
|
3852
|
+
# Filters on the name of the job.
|
3853
|
+
# @return [String]
|
3854
|
+
#
|
3855
|
+
# @!attribute [rw] job_status
|
3856
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
3857
|
+
# the specified status.
|
3858
|
+
# @return [String]
|
3859
|
+
#
|
3860
|
+
# @!attribute [rw] submit_time_before
|
3861
|
+
# Filters the list of jobs based on the time that the job was
|
3862
|
+
# submitted for processing. Returns only jobs submitted before the
|
3863
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
3864
|
+
# newest.
|
3865
|
+
# @return [Time]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] submit_time_after
|
3868
|
+
# Filters the list of jobs based on the time that the job was
|
3869
|
+
# submitted for processing. Returns only jobs submitted after the
|
3870
|
+
# specified time. Jobs are returned in descending order, newest to
|
3871
|
+
# oldest.
|
3872
|
+
# @return [Time]
|
3873
|
+
#
|
3874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobFilter AWS API Documentation
|
3875
|
+
#
|
3876
|
+
class PiiEntitiesDetectionJobFilter < Struct.new(
|
3877
|
+
:job_name,
|
3878
|
+
:job_status,
|
3879
|
+
:submit_time_before,
|
3880
|
+
:submit_time_after)
|
3881
|
+
SENSITIVE = []
|
3882
|
+
include Aws::Structure
|
3883
|
+
end
|
3884
|
+
|
3885
|
+
# Provides information about a PII entities detection job.
|
3886
|
+
#
|
3887
|
+
# @!attribute [rw] job_id
|
3888
|
+
# The identifier assigned to the PII entities detection job.
|
3889
|
+
# @return [String]
|
3890
|
+
#
|
3891
|
+
# @!attribute [rw] job_name
|
3892
|
+
# The name that you assigned the PII entities detection job.
|
3893
|
+
# @return [String]
|
3894
|
+
#
|
3895
|
+
# @!attribute [rw] job_status
|
3896
|
+
# The current status of the PII entities detection job. If the status
|
3897
|
+
# is `FAILED`, the `Message` field shows the reason for the failure.
|
3898
|
+
# @return [String]
|
3899
|
+
#
|
3900
|
+
# @!attribute [rw] message
|
3901
|
+
# A description of the status of a job.
|
3902
|
+
# @return [String]
|
3903
|
+
#
|
3904
|
+
# @!attribute [rw] submit_time
|
3905
|
+
# The time that the PII entities detection job was submitted for
|
3906
|
+
# processing.
|
3907
|
+
# @return [Time]
|
3908
|
+
#
|
3909
|
+
# @!attribute [rw] end_time
|
3910
|
+
# The time that the PII entities detection job completed.
|
3911
|
+
# @return [Time]
|
3912
|
+
#
|
3913
|
+
# @!attribute [rw] input_data_config
|
3914
|
+
# The input properties for a PII entities detection job.
|
3915
|
+
# @return [Types::InputDataConfig]
|
3916
|
+
#
|
3917
|
+
# @!attribute [rw] output_data_config
|
3918
|
+
# The output data configuration that you supplied when you created the
|
3919
|
+
# PII entities detection job.
|
3920
|
+
# @return [Types::PiiOutputDataConfig]
|
3921
|
+
#
|
3922
|
+
# @!attribute [rw] redaction_config
|
3923
|
+
# Provides configuration parameters for PII entity redaction.
|
3924
|
+
#
|
3925
|
+
# This parameter is required if you set the `Mode` parameter to
|
3926
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
3927
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
3928
|
+
# @return [Types::RedactionConfig]
|
3929
|
+
#
|
3930
|
+
# @!attribute [rw] language_code
|
3931
|
+
# The language code of the input documents
|
3932
|
+
# @return [String]
|
3933
|
+
#
|
3934
|
+
# @!attribute [rw] data_access_role_arn
|
3935
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
3936
|
+
# access to your input data.
|
3937
|
+
# @return [String]
|
3938
|
+
#
|
3939
|
+
# @!attribute [rw] mode
|
3940
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
3941
|
+
# entities or a file in which PII entities are redacted.
|
3942
|
+
# @return [String]
|
3943
|
+
#
|
3944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobProperties AWS API Documentation
|
3945
|
+
#
|
3946
|
+
class PiiEntitiesDetectionJobProperties < Struct.new(
|
3947
|
+
:job_id,
|
3948
|
+
:job_name,
|
3949
|
+
:job_status,
|
3950
|
+
:message,
|
3951
|
+
:submit_time,
|
3952
|
+
:end_time,
|
3953
|
+
:input_data_config,
|
3954
|
+
:output_data_config,
|
3955
|
+
:redaction_config,
|
3956
|
+
:language_code,
|
3957
|
+
:data_access_role_arn,
|
3958
|
+
:mode)
|
3959
|
+
SENSITIVE = []
|
3960
|
+
include Aws::Structure
|
3961
|
+
end
|
3962
|
+
|
3963
|
+
# Provides information about a PII entity.
|
3964
|
+
#
|
3965
|
+
# @!attribute [rw] score
|
3966
|
+
# The level of confidence that Amazon Comprehend has in the accuracy
|
3967
|
+
# of the detection.
|
3968
|
+
# @return [Float]
|
3969
|
+
#
|
3970
|
+
# @!attribute [rw] type
|
3971
|
+
# The entity's type.
|
3972
|
+
# @return [String]
|
3973
|
+
#
|
3974
|
+
# @!attribute [rw] begin_offset
|
3975
|
+
# A character offset in the input text that shows where the PII entity
|
3976
|
+
# begins (the first character is at position 0). The offset returns
|
3977
|
+
# the position of each UTF-8 code point in the string. A *code point*
|
3978
|
+
# is the abstract character from a particular graphical
|
3979
|
+
# representation. For example, a multi-byte UTF-8 character maps to a
|
3980
|
+
# single code point.
|
3981
|
+
# @return [Integer]
|
3982
|
+
#
|
3983
|
+
# @!attribute [rw] end_offset
|
3984
|
+
# A character offset in the input text that shows where the PII entity
|
3985
|
+
# ends. The offset returns the position of each UTF-8 code point in
|
3986
|
+
# the string. A *code point* is the abstract character from a
|
3987
|
+
# particular graphical representation. For example, a multi-byte UTF-8
|
3988
|
+
# character maps to a single code point.
|
3989
|
+
# @return [Integer]
|
3990
|
+
#
|
3991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
|
3992
|
+
#
|
3993
|
+
class PiiEntity < Struct.new(
|
3994
|
+
:score,
|
3995
|
+
:type,
|
3996
|
+
:begin_offset,
|
3997
|
+
:end_offset)
|
3998
|
+
SENSITIVE = []
|
3999
|
+
include Aws::Structure
|
4000
|
+
end
|
4001
|
+
|
4002
|
+
# Provides configuration parameters for the output of PII entity
|
4003
|
+
# detection jobs.
|
4004
|
+
#
|
4005
|
+
# @!attribute [rw] s3_uri
|
4006
|
+
# When you use the `PiiOutputDataConfig` object with asynchronous
|
4007
|
+
# operations, you specify the Amazon S3 location where you want to
|
4008
|
+
# write the output data.
|
4009
|
+
# @return [String]
|
4010
|
+
#
|
4011
|
+
# @!attribute [rw] kms_key_id
|
4012
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
4013
|
+
# Comprehend uses to encrypt the output results from an analysis job.
|
4014
|
+
# @return [String]
|
4015
|
+
#
|
4016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
|
4017
|
+
#
|
4018
|
+
class PiiOutputDataConfig < Struct.new(
|
4019
|
+
:s3_uri,
|
4020
|
+
:kms_key_id)
|
4021
|
+
SENSITIVE = []
|
4022
|
+
include Aws::Structure
|
4023
|
+
end
|
4024
|
+
|
4025
|
+
# Provides configuration parameters for PII entity redaction.
|
4026
|
+
#
|
4027
|
+
# @note When making an API call, you may pass RedactionConfig
|
4028
|
+
# data as a hash:
|
4029
|
+
#
|
4030
|
+
# {
|
4031
|
+
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
|
4032
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
4033
|
+
# mask_character: "MaskCharacter",
|
4034
|
+
# }
|
4035
|
+
#
|
4036
|
+
# @!attribute [rw] pii_entity_types
|
4037
|
+
# An array of the types of PII entities that Amazon Comprehend detects
|
4038
|
+
# in the input text for your request.
|
4039
|
+
# @return [Array<String>]
|
4040
|
+
#
|
4041
|
+
# @!attribute [rw] mask_mode
|
4042
|
+
# Specifies whether the PII entity is redacted with the mask character
|
4043
|
+
# or the entity type.
|
4044
|
+
# @return [String]
|
4045
|
+
#
|
4046
|
+
# @!attribute [rw] mask_character
|
4047
|
+
# A character that replaces each character in the redacted PII entity.
|
4048
|
+
# @return [String]
|
4049
|
+
#
|
4050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RedactionConfig AWS API Documentation
|
4051
|
+
#
|
4052
|
+
class RedactionConfig < Struct.new(
|
4053
|
+
:pii_entity_types,
|
4054
|
+
:mask_mode,
|
4055
|
+
:mask_character)
|
4056
|
+
SENSITIVE = []
|
4057
|
+
include Aws::Structure
|
4058
|
+
end
|
4059
|
+
|
4060
|
+
# The specified resource name is already in use. Use a different name
|
4061
|
+
# and try your request again.
|
3688
4062
|
#
|
3689
4063
|
# @!attribute [rw] message
|
3690
4064
|
# @return [String]
|
@@ -3697,9 +4071,8 @@ module Aws::Comprehend
|
|
3697
4071
|
include Aws::Structure
|
3698
4072
|
end
|
3699
4073
|
|
3700
|
-
# The maximum number of
|
3701
|
-
#
|
3702
|
-
# again.
|
4074
|
+
# The maximum number of resources per account has been exceeded. Review
|
4075
|
+
# the resources, and then try your request again.
|
3703
4076
|
#
|
3704
4077
|
# @!attribute [rw] message
|
3705
4078
|
# @return [String]
|
@@ -3726,8 +4099,8 @@ module Aws::Comprehend
|
|
3726
4099
|
include Aws::Structure
|
3727
4100
|
end
|
3728
4101
|
|
3729
|
-
# The specified resource is not available. Check
|
3730
|
-
#
|
4102
|
+
# The specified resource is not available. Check the resource and try
|
4103
|
+
# your request again.
|
3731
4104
|
#
|
3732
4105
|
# @!attribute [rw] message
|
3733
4106
|
# @return [String]
|
@@ -4417,6 +4790,106 @@ module Aws::Comprehend
|
|
4417
4790
|
include Aws::Structure
|
4418
4791
|
end
|
4419
4792
|
|
4793
|
+
# @note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
|
4794
|
+
# data as a hash:
|
4795
|
+
#
|
4796
|
+
# {
|
4797
|
+
# input_data_config: { # required
|
4798
|
+
# s3_uri: "S3Uri", # required
|
4799
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
4800
|
+
# },
|
4801
|
+
# output_data_config: { # required
|
4802
|
+
# s3_uri: "S3Uri", # required
|
4803
|
+
# kms_key_id: "KmsKeyId",
|
4804
|
+
# },
|
4805
|
+
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
4806
|
+
# redaction_config: {
|
4807
|
+
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
|
4808
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
4809
|
+
# mask_character: "MaskCharacter",
|
4810
|
+
# },
|
4811
|
+
# data_access_role_arn: "IamRoleArn", # required
|
4812
|
+
# job_name: "JobName",
|
4813
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
4814
|
+
# client_request_token: "ClientRequestTokenString",
|
4815
|
+
# }
|
4816
|
+
#
|
4817
|
+
# @!attribute [rw] input_data_config
|
4818
|
+
# The input properties for a PII entities detection job.
|
4819
|
+
# @return [Types::InputDataConfig]
|
4820
|
+
#
|
4821
|
+
# @!attribute [rw] output_data_config
|
4822
|
+
# Provides configuration parameters for the output of PII entity
|
4823
|
+
# detection jobs.
|
4824
|
+
# @return [Types::OutputDataConfig]
|
4825
|
+
#
|
4826
|
+
# @!attribute [rw] mode
|
4827
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
4828
|
+
# entities or a file in which PII entities are redacted.
|
4829
|
+
# @return [String]
|
4830
|
+
#
|
4831
|
+
# @!attribute [rw] redaction_config
|
4832
|
+
# Provides configuration parameters for PII entity redaction.
|
4833
|
+
#
|
4834
|
+
# This parameter is required if you set the `Mode` parameter to
|
4835
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
4836
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
4837
|
+
# @return [Types::RedactionConfig]
|
4838
|
+
#
|
4839
|
+
# @!attribute [rw] data_access_role_arn
|
4840
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
4841
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
4842
|
+
# your input data.
|
4843
|
+
# @return [String]
|
4844
|
+
#
|
4845
|
+
# @!attribute [rw] job_name
|
4846
|
+
# The identifier of the job.
|
4847
|
+
# @return [String]
|
4848
|
+
#
|
4849
|
+
# @!attribute [rw] language_code
|
4850
|
+
# The language of the input documents.
|
4851
|
+
# @return [String]
|
4852
|
+
#
|
4853
|
+
# @!attribute [rw] client_request_token
|
4854
|
+
# A unique identifier for the request. If you don't set the client
|
4855
|
+
# request token, Amazon Comprehend generates one.
|
4856
|
+
#
|
4857
|
+
# **A suitable default value is auto-generated.** You should normally
|
4858
|
+
# not need to pass this option.
|
4859
|
+
# @return [String]
|
4860
|
+
#
|
4861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
4862
|
+
#
|
4863
|
+
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
4864
|
+
:input_data_config,
|
4865
|
+
:output_data_config,
|
4866
|
+
:mode,
|
4867
|
+
:redaction_config,
|
4868
|
+
:data_access_role_arn,
|
4869
|
+
:job_name,
|
4870
|
+
:language_code,
|
4871
|
+
:client_request_token)
|
4872
|
+
SENSITIVE = []
|
4873
|
+
include Aws::Structure
|
4874
|
+
end
|
4875
|
+
|
4876
|
+
# @!attribute [rw] job_id
|
4877
|
+
# The identifier generated for the job.
|
4878
|
+
# @return [String]
|
4879
|
+
#
|
4880
|
+
# @!attribute [rw] job_status
|
4881
|
+
# The status of the job.
|
4882
|
+
# @return [String]
|
4883
|
+
#
|
4884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobResponse AWS API Documentation
|
4885
|
+
#
|
4886
|
+
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
4887
|
+
:job_id,
|
4888
|
+
:job_status)
|
4889
|
+
SENSITIVE = []
|
4890
|
+
include Aws::Structure
|
4891
|
+
end
|
4892
|
+
|
4420
4893
|
# @note When making an API call, you may pass StartSentimentDetectionJobRequest
|
4421
4894
|
# data as a hash:
|
4422
4895
|
#
|
@@ -4784,6 +5257,42 @@ module Aws::Comprehend
|
|
4784
5257
|
include Aws::Structure
|
4785
5258
|
end
|
4786
5259
|
|
5260
|
+
# @note When making an API call, you may pass StopPiiEntitiesDetectionJobRequest
|
5261
|
+
# data as a hash:
|
5262
|
+
#
|
5263
|
+
# {
|
5264
|
+
# job_id: "JobId", # required
|
5265
|
+
# }
|
5266
|
+
#
|
5267
|
+
# @!attribute [rw] job_id
|
5268
|
+
# The identifier of the PII entities detection job to stop.
|
5269
|
+
# @return [String]
|
5270
|
+
#
|
5271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobRequest AWS API Documentation
|
5272
|
+
#
|
5273
|
+
class StopPiiEntitiesDetectionJobRequest < Struct.new(
|
5274
|
+
:job_id)
|
5275
|
+
SENSITIVE = []
|
5276
|
+
include Aws::Structure
|
5277
|
+
end
|
5278
|
+
|
5279
|
+
# @!attribute [rw] job_id
|
5280
|
+
# The identifier of the PII entities detection job to stop.
|
5281
|
+
# @return [String]
|
5282
|
+
#
|
5283
|
+
# @!attribute [rw] job_status
|
5284
|
+
# The status of the PII entities detection job.
|
5285
|
+
# @return [String]
|
5286
|
+
#
|
5287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobResponse AWS API Documentation
|
5288
|
+
#
|
5289
|
+
class StopPiiEntitiesDetectionJobResponse < Struct.new(
|
5290
|
+
:job_id,
|
5291
|
+
:job_status)
|
5292
|
+
SENSITIVE = []
|
5293
|
+
include Aws::Structure
|
5294
|
+
end
|
5295
|
+
|
4787
5296
|
# @note When making an API call, you may pass StopSentimentDetectionJobRequest
|
4788
5297
|
# data as a hash:
|
4789
5298
|
#
|
@@ -5178,8 +5687,9 @@ module Aws::Comprehend
|
|
5178
5687
|
|
5179
5688
|
# Amazon Comprehend can't process the language of the input text. For
|
5180
5689
|
# all custom entity recognition APIs (such as `CreateEntityRecognizer`),
|
5181
|
-
# only English
|
5182
|
-
#
|
5690
|
+
# only English, Spanish, French, Italian, German, or Portuguese are
|
5691
|
+
# accepted. For most other APIs, such as those for Custom
|
5692
|
+
# Classification, Amazon Comprehend accepts text in all supported
|
5183
5693
|
# languages. For a list of supported languages, see supported-languages.
|
5184
5694
|
#
|
5185
5695
|
# @!attribute [rw] message
|