aws-sdk-comprehend 1.35.0 → 1.40.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 +320 -12
- data/lib/aws-sdk-comprehend/client_api.rb +188 -2
- data/lib/aws-sdk-comprehend/types.rb +667 -18
- metadata +2 -2
@@ -14,6 +14,9 @@ module Aws::Comprehend
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
16
|
AnyLengthString = Shapes::StringShape.new(name: 'AnyLengthString')
|
17
|
+
AttributeNamesList = Shapes::ListShape.new(name: 'AttributeNamesList')
|
18
|
+
AttributeNamesListItem = Shapes::StringShape.new(name: 'AttributeNamesListItem')
|
19
|
+
AugmentedManifestsListItem = Shapes::StructureShape.new(name: 'AugmentedManifestsListItem')
|
17
20
|
BatchDetectDominantLanguageItemResult = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageItemResult')
|
18
21
|
BatchDetectDominantLanguageRequest = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageRequest')
|
19
22
|
BatchDetectDominantLanguageResponse = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageResponse')
|
@@ -71,6 +74,8 @@ module Aws::Comprehend
|
|
71
74
|
DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
|
72
75
|
DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
|
73
76
|
DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
|
77
|
+
DescribePiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobRequest')
|
78
|
+
DescribePiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobResponse')
|
74
79
|
DescribeSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobRequest')
|
75
80
|
DescribeSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobResponse')
|
76
81
|
DescribeTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeTopicsDetectionJobRequest')
|
@@ -81,6 +86,8 @@ module Aws::Comprehend
|
|
81
86
|
DetectEntitiesResponse = Shapes::StructureShape.new(name: 'DetectEntitiesResponse')
|
82
87
|
DetectKeyPhrasesRequest = Shapes::StructureShape.new(name: 'DetectKeyPhrasesRequest')
|
83
88
|
DetectKeyPhrasesResponse = Shapes::StructureShape.new(name: 'DetectKeyPhrasesResponse')
|
89
|
+
DetectPiiEntitiesRequest = Shapes::StructureShape.new(name: 'DetectPiiEntitiesRequest')
|
90
|
+
DetectPiiEntitiesResponse = Shapes::StructureShape.new(name: 'DetectPiiEntitiesResponse')
|
84
91
|
DetectSentimentRequest = Shapes::StructureShape.new(name: 'DetectSentimentRequest')
|
85
92
|
DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
|
86
93
|
DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
|
@@ -90,6 +97,8 @@ module Aws::Comprehend
|
|
90
97
|
DocumentClassificationJobProperties = Shapes::StructureShape.new(name: 'DocumentClassificationJobProperties')
|
91
98
|
DocumentClassificationJobPropertiesList = Shapes::ListShape.new(name: 'DocumentClassificationJobPropertiesList')
|
92
99
|
DocumentClassifierArn = Shapes::StringShape.new(name: 'DocumentClassifierArn')
|
100
|
+
DocumentClassifierAugmentedManifestsList = Shapes::ListShape.new(name: 'DocumentClassifierAugmentedManifestsList')
|
101
|
+
DocumentClassifierDataFormat = Shapes::StringShape.new(name: 'DocumentClassifierDataFormat')
|
93
102
|
DocumentClassifierEndpointArn = Shapes::StringShape.new(name: 'DocumentClassifierEndpointArn')
|
94
103
|
DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
|
95
104
|
DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
|
@@ -113,6 +122,8 @@ module Aws::Comprehend
|
|
113
122
|
Entity = Shapes::StructureShape.new(name: 'Entity')
|
114
123
|
EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
|
115
124
|
EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
|
125
|
+
EntityRecognizerAugmentedManifestsList = Shapes::ListShape.new(name: 'EntityRecognizerAugmentedManifestsList')
|
126
|
+
EntityRecognizerDataFormat = Shapes::StringShape.new(name: 'EntityRecognizerDataFormat')
|
116
127
|
EntityRecognizerDocuments = Shapes::StructureShape.new(name: 'EntityRecognizerDocuments')
|
117
128
|
EntityRecognizerEndpointArn = Shapes::StringShape.new(name: 'EntityRecognizerEndpointArn')
|
118
129
|
EntityRecognizerEntityList = Shapes::StructureShape.new(name: 'EntityRecognizerEntityList')
|
@@ -174,19 +185,33 @@ module Aws::Comprehend
|
|
174
185
|
ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
|
175
186
|
ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
|
176
187
|
ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
|
188
|
+
ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
|
189
|
+
ListOfPiiEntityTypes = Shapes::ListShape.new(name: 'ListOfPiiEntityTypes')
|
177
190
|
ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
|
191
|
+
ListPiiEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsRequest')
|
192
|
+
ListPiiEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsResponse')
|
178
193
|
ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
|
179
194
|
ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
|
180
195
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
181
196
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
182
197
|
ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
|
183
198
|
ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
|
199
|
+
MaskCharacter = Shapes::StringShape.new(name: 'MaskCharacter')
|
184
200
|
MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
|
185
201
|
ModelStatus = Shapes::StringShape.new(name: 'ModelStatus')
|
186
202
|
NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
|
187
203
|
OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
|
188
204
|
PartOfSpeechTag = Shapes::StructureShape.new(name: 'PartOfSpeechTag')
|
189
205
|
PartOfSpeechTagType = Shapes::StringShape.new(name: 'PartOfSpeechTagType')
|
206
|
+
PiiEntitiesDetectionJobFilter = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobFilter')
|
207
|
+
PiiEntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobProperties')
|
208
|
+
PiiEntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'PiiEntitiesDetectionJobPropertiesList')
|
209
|
+
PiiEntitiesDetectionMaskMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMaskMode')
|
210
|
+
PiiEntitiesDetectionMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMode')
|
211
|
+
PiiEntity = Shapes::StructureShape.new(name: 'PiiEntity')
|
212
|
+
PiiEntityType = Shapes::StringShape.new(name: 'PiiEntityType')
|
213
|
+
PiiOutputDataConfig = Shapes::StructureShape.new(name: 'PiiOutputDataConfig')
|
214
|
+
RedactionConfig = Shapes::StructureShape.new(name: 'RedactionConfig')
|
190
215
|
ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
|
191
216
|
ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
|
192
217
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
@@ -207,6 +232,8 @@ module Aws::Comprehend
|
|
207
232
|
StartEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobResponse')
|
208
233
|
StartKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobRequest')
|
209
234
|
StartKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobResponse')
|
235
|
+
StartPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobRequest')
|
236
|
+
StartPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobResponse')
|
210
237
|
StartSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobRequest')
|
211
238
|
StartSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobResponse')
|
212
239
|
StartTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartTopicsDetectionJobRequest')
|
@@ -217,6 +244,8 @@ module Aws::Comprehend
|
|
217
244
|
StopEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobResponse')
|
218
245
|
StopKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobRequest')
|
219
246
|
StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
|
247
|
+
StopPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobRequest')
|
248
|
+
StopPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobResponse')
|
220
249
|
StopSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobRequest')
|
221
250
|
StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
|
222
251
|
StopTrainingDocumentClassifierRequest = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierRequest')
|
@@ -250,6 +279,12 @@ module Aws::Comprehend
|
|
250
279
|
UpdateEndpointResponse = Shapes::StructureShape.new(name: 'UpdateEndpointResponse')
|
251
280
|
VpcConfig = Shapes::StructureShape.new(name: 'VpcConfig')
|
252
281
|
|
282
|
+
AttributeNamesList.member = Shapes::ShapeRef.new(shape: AttributeNamesListItem)
|
283
|
+
|
284
|
+
AugmentedManifestsListItem.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
285
|
+
AugmentedManifestsListItem.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNamesList, required: true, location_name: "AttributeNames"))
|
286
|
+
AugmentedManifestsListItem.struct_class = Types::AugmentedManifestsListItem
|
287
|
+
|
253
288
|
BatchDetectDominantLanguageItemResult.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
|
254
289
|
BatchDetectDominantLanguageItemResult.add_member(:languages, Shapes::ShapeRef.new(shape: ListOfDominantLanguages, location_name: "Languages"))
|
255
290
|
BatchDetectDominantLanguageItemResult.struct_class = Types::BatchDetectDominantLanguageItemResult
|
@@ -444,6 +479,12 @@ module Aws::Comprehend
|
|
444
479
|
DescribeKeyPhrasesDetectionJobResponse.add_member(:key_phrases_detection_job_properties, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobProperties, location_name: "KeyPhrasesDetectionJobProperties"))
|
445
480
|
DescribeKeyPhrasesDetectionJobResponse.struct_class = Types::DescribeKeyPhrasesDetectionJobResponse
|
446
481
|
|
482
|
+
DescribePiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
483
|
+
DescribePiiEntitiesDetectionJobRequest.struct_class = Types::DescribePiiEntitiesDetectionJobRequest
|
484
|
+
|
485
|
+
DescribePiiEntitiesDetectionJobResponse.add_member(:pii_entities_detection_job_properties, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties, location_name: "PiiEntitiesDetectionJobProperties"))
|
486
|
+
DescribePiiEntitiesDetectionJobResponse.struct_class = Types::DescribePiiEntitiesDetectionJobResponse
|
487
|
+
|
447
488
|
DescribeSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
448
489
|
DescribeSentimentDetectionJobRequest.struct_class = Types::DescribeSentimentDetectionJobRequest
|
449
490
|
|
@@ -477,6 +518,13 @@ module Aws::Comprehend
|
|
477
518
|
DetectKeyPhrasesResponse.add_member(:key_phrases, Shapes::ShapeRef.new(shape: ListOfKeyPhrases, location_name: "KeyPhrases"))
|
478
519
|
DetectKeyPhrasesResponse.struct_class = Types::DetectKeyPhrasesResponse
|
479
520
|
|
521
|
+
DetectPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
522
|
+
DetectPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
523
|
+
DetectPiiEntitiesRequest.struct_class = Types::DetectPiiEntitiesRequest
|
524
|
+
|
525
|
+
DetectPiiEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfPiiEntities, location_name: "Entities"))
|
526
|
+
DetectPiiEntitiesResponse.struct_class = Types::DetectPiiEntitiesResponse
|
527
|
+
|
480
528
|
DetectSentimentRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
|
481
529
|
DetectSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
482
530
|
DetectSentimentRequest.struct_class = Types::DetectSentimentRequest
|
@@ -518,13 +566,17 @@ module Aws::Comprehend
|
|
518
566
|
|
519
567
|
DocumentClassificationJobPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassificationJobProperties)
|
520
568
|
|
569
|
+
DocumentClassifierAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
|
570
|
+
|
521
571
|
DocumentClassifierFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
522
572
|
DocumentClassifierFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
523
573
|
DocumentClassifierFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
524
574
|
DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
|
525
575
|
|
526
|
-
DocumentClassifierInputDataConfig.add_member(:
|
576
|
+
DocumentClassifierInputDataConfig.add_member(:data_format, Shapes::ShapeRef.new(shape: DocumentClassifierDataFormat, location_name: "DataFormat"))
|
577
|
+
DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
|
527
578
|
DocumentClassifierInputDataConfig.add_member(:label_delimiter, Shapes::ShapeRef.new(shape: LabelDelimiter, location_name: "LabelDelimiter"))
|
579
|
+
DocumentClassifierInputDataConfig.add_member(:augmented_manifests, Shapes::ShapeRef.new(shape: DocumentClassifierAugmentedManifestsList, location_name: "AugmentedManifests"))
|
528
580
|
DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
|
529
581
|
|
530
582
|
DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
|
@@ -630,6 +682,8 @@ module Aws::Comprehend
|
|
630
682
|
EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
631
683
|
EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
|
632
684
|
|
685
|
+
EntityRecognizerAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
|
686
|
+
|
633
687
|
EntityRecognizerDocuments.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
634
688
|
EntityRecognizerDocuments.struct_class = Types::EntityRecognizerDocuments
|
635
689
|
|
@@ -646,10 +700,12 @@ module Aws::Comprehend
|
|
646
700
|
EntityRecognizerFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
647
701
|
EntityRecognizerFilter.struct_class = Types::EntityRecognizerFilter
|
648
702
|
|
703
|
+
EntityRecognizerInputDataConfig.add_member(:data_format, Shapes::ShapeRef.new(shape: EntityRecognizerDataFormat, location_name: "DataFormat"))
|
649
704
|
EntityRecognizerInputDataConfig.add_member(:entity_types, Shapes::ShapeRef.new(shape: EntityTypesList, required: true, location_name: "EntityTypes"))
|
650
|
-
EntityRecognizerInputDataConfig.add_member(:documents, Shapes::ShapeRef.new(shape: EntityRecognizerDocuments,
|
705
|
+
EntityRecognizerInputDataConfig.add_member(:documents, Shapes::ShapeRef.new(shape: EntityRecognizerDocuments, location_name: "Documents"))
|
651
706
|
EntityRecognizerInputDataConfig.add_member(:annotations, Shapes::ShapeRef.new(shape: EntityRecognizerAnnotations, location_name: "Annotations"))
|
652
707
|
EntityRecognizerInputDataConfig.add_member(:entity_list, Shapes::ShapeRef.new(shape: EntityRecognizerEntityList, location_name: "EntityList"))
|
708
|
+
EntityRecognizerInputDataConfig.add_member(:augmented_manifests, Shapes::ShapeRef.new(shape: EntityRecognizerAugmentedManifestsList, location_name: "AugmentedManifests"))
|
653
709
|
EntityRecognizerInputDataConfig.struct_class = Types::EntityRecognizerInputDataConfig
|
654
710
|
|
655
711
|
EntityRecognizerMetadata.add_member(:number_of_trained_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTrainedDocuments"))
|
@@ -822,8 +878,21 @@ module Aws::Comprehend
|
|
822
878
|
|
823
879
|
ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
|
824
880
|
|
881
|
+
ListOfPiiEntities.member = Shapes::ShapeRef.new(shape: PiiEntity)
|
882
|
+
|
883
|
+
ListOfPiiEntityTypes.member = Shapes::ShapeRef.new(shape: PiiEntityType)
|
884
|
+
|
825
885
|
ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
|
826
886
|
|
887
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobFilter, location_name: "Filter"))
|
888
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
889
|
+
ListPiiEntitiesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
890
|
+
ListPiiEntitiesDetectionJobsRequest.struct_class = Types::ListPiiEntitiesDetectionJobsRequest
|
891
|
+
|
892
|
+
ListPiiEntitiesDetectionJobsResponse.add_member(:pii_entities_detection_job_properties_list, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobPropertiesList, location_name: "PiiEntitiesDetectionJobPropertiesList"))
|
893
|
+
ListPiiEntitiesDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
894
|
+
ListPiiEntitiesDetectionJobsResponse.struct_class = Types::ListPiiEntitiesDetectionJobsResponse
|
895
|
+
|
827
896
|
ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))
|
828
897
|
ListSentimentDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
829
898
|
ListSentimentDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -857,6 +926,43 @@ module Aws::Comprehend
|
|
857
926
|
PartOfSpeechTag.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
858
927
|
PartOfSpeechTag.struct_class = Types::PartOfSpeechTag
|
859
928
|
|
929
|
+
PiiEntitiesDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
930
|
+
PiiEntitiesDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
931
|
+
PiiEntitiesDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
932
|
+
PiiEntitiesDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
933
|
+
PiiEntitiesDetectionJobFilter.struct_class = Types::PiiEntitiesDetectionJobFilter
|
934
|
+
|
935
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
936
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
937
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
938
|
+
PiiEntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
939
|
+
PiiEntitiesDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
940
|
+
PiiEntitiesDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
941
|
+
PiiEntitiesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
942
|
+
PiiEntitiesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: PiiOutputDataConfig, location_name: "OutputDataConfig"))
|
943
|
+
PiiEntitiesDetectionJobProperties.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
|
944
|
+
PiiEntitiesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
945
|
+
PiiEntitiesDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
946
|
+
PiiEntitiesDetectionJobProperties.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, location_name: "Mode"))
|
947
|
+
PiiEntitiesDetectionJobProperties.struct_class = Types::PiiEntitiesDetectionJobProperties
|
948
|
+
|
949
|
+
PiiEntitiesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties)
|
950
|
+
|
951
|
+
PiiEntity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
952
|
+
PiiEntity.add_member(:type, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Type"))
|
953
|
+
PiiEntity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
|
954
|
+
PiiEntity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
|
955
|
+
PiiEntity.struct_class = Types::PiiEntity
|
956
|
+
|
957
|
+
PiiOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
958
|
+
PiiOutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
|
959
|
+
PiiOutputDataConfig.struct_class = Types::PiiOutputDataConfig
|
960
|
+
|
961
|
+
RedactionConfig.add_member(:pii_entity_types, Shapes::ShapeRef.new(shape: ListOfPiiEntityTypes, location_name: "PiiEntityTypes"))
|
962
|
+
RedactionConfig.add_member(:mask_mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMaskMode, location_name: "MaskMode"))
|
963
|
+
RedactionConfig.add_member(:mask_character, Shapes::ShapeRef.new(shape: MaskCharacter, location_name: "MaskCharacter"))
|
964
|
+
RedactionConfig.struct_class = Types::RedactionConfig
|
965
|
+
|
860
966
|
ResourceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
861
967
|
ResourceInUseException.struct_class = Types::ResourceInUseException
|
862
968
|
|
@@ -955,6 +1061,20 @@ module Aws::Comprehend
|
|
955
1061
|
StartKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
956
1062
|
StartKeyPhrasesDetectionJobResponse.struct_class = Types::StartKeyPhrasesDetectionJobResponse
|
957
1063
|
|
1064
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1065
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1066
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, required: true, location_name: "Mode"))
|
1067
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
|
1068
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
1069
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1070
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1071
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1072
|
+
StartPiiEntitiesDetectionJobRequest.struct_class = Types::StartPiiEntitiesDetectionJobRequest
|
1073
|
+
|
1074
|
+
StartPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1075
|
+
StartPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1076
|
+
StartPiiEntitiesDetectionJobResponse.struct_class = Types::StartPiiEntitiesDetectionJobResponse
|
1077
|
+
|
958
1078
|
StartSentimentDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
959
1079
|
StartSentimentDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
960
1080
|
StartSentimentDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
@@ -1004,6 +1124,13 @@ module Aws::Comprehend
|
|
1004
1124
|
StopKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1005
1125
|
StopKeyPhrasesDetectionJobResponse.struct_class = Types::StopKeyPhrasesDetectionJobResponse
|
1006
1126
|
|
1127
|
+
StopPiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1128
|
+
StopPiiEntitiesDetectionJobRequest.struct_class = Types::StopPiiEntitiesDetectionJobRequest
|
1129
|
+
|
1130
|
+
StopPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1131
|
+
StopPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1132
|
+
StopPiiEntitiesDetectionJobResponse.struct_class = Types::StopPiiEntitiesDetectionJobResponse
|
1133
|
+
|
1007
1134
|
StopSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1008
1135
|
StopSentimentDetectionJobRequest.struct_class = Types::StopSentimentDetectionJobRequest
|
1009
1136
|
|
@@ -1365,6 +1492,18 @@ module Aws::Comprehend
|
|
1365
1492
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1366
1493
|
end)
|
1367
1494
|
|
1495
|
+
api.add_operation(:describe_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1496
|
+
o.name = "DescribePiiEntitiesDetectionJob"
|
1497
|
+
o.http_method = "POST"
|
1498
|
+
o.http_request_uri = "/"
|
1499
|
+
o.input = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobRequest)
|
1500
|
+
o.output = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobResponse)
|
1501
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1502
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1503
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1504
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1505
|
+
end)
|
1506
|
+
|
1368
1507
|
api.add_operation(:describe_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1369
1508
|
o.name = "DescribeSentimentDetectionJob"
|
1370
1509
|
o.http_method = "POST"
|
@@ -1425,6 +1564,18 @@ module Aws::Comprehend
|
|
1425
1564
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1426
1565
|
end)
|
1427
1566
|
|
1567
|
+
api.add_operation(:detect_pii_entities, Seahorse::Model::Operation.new.tap do |o|
|
1568
|
+
o.name = "DetectPiiEntities"
|
1569
|
+
o.http_method = "POST"
|
1570
|
+
o.http_request_uri = "/"
|
1571
|
+
o.input = Shapes::ShapeRef.new(shape: DetectPiiEntitiesRequest)
|
1572
|
+
o.output = Shapes::ShapeRef.new(shape: DetectPiiEntitiesResponse)
|
1573
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1574
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
1575
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
1576
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1577
|
+
end)
|
1578
|
+
|
1428
1579
|
api.add_operation(:detect_sentiment, Seahorse::Model::Operation.new.tap do |o|
|
1429
1580
|
o.name = "DetectSentiment"
|
1430
1581
|
o.http_method = "POST"
|
@@ -1568,6 +1719,18 @@ module Aws::Comprehend
|
|
1568
1719
|
)
|
1569
1720
|
end)
|
1570
1721
|
|
1722
|
+
api.add_operation(:list_pii_entities_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1723
|
+
o.name = "ListPiiEntitiesDetectionJobs"
|
1724
|
+
o.http_method = "POST"
|
1725
|
+
o.http_request_uri = "/"
|
1726
|
+
o.input = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsRequest)
|
1727
|
+
o.output = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsResponse)
|
1728
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1729
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1730
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
1731
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1732
|
+
end)
|
1733
|
+
|
1571
1734
|
api.add_operation(:list_sentiment_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1572
1735
|
o.name = "ListSentimentDetectionJobs"
|
1573
1736
|
o.http_method = "POST"
|
@@ -1667,6 +1830,18 @@ module Aws::Comprehend
|
|
1667
1830
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1668
1831
|
end)
|
1669
1832
|
|
1833
|
+
api.add_operation(:start_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1834
|
+
o.name = "StartPiiEntitiesDetectionJob"
|
1835
|
+
o.http_method = "POST"
|
1836
|
+
o.http_request_uri = "/"
|
1837
|
+
o.input = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobRequest)
|
1838
|
+
o.output = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobResponse)
|
1839
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1840
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1841
|
+
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1842
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1843
|
+
end)
|
1844
|
+
|
1670
1845
|
api.add_operation(:start_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1671
1846
|
o.name = "StartSentimentDetectionJob"
|
1672
1847
|
o.http_method = "POST"
|
@@ -1724,6 +1899,17 @@ module Aws::Comprehend
|
|
1724
1899
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1725
1900
|
end)
|
1726
1901
|
|
1902
|
+
api.add_operation(:stop_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1903
|
+
o.name = "StopPiiEntitiesDetectionJob"
|
1904
|
+
o.http_method = "POST"
|
1905
|
+
o.http_request_uri = "/"
|
1906
|
+
o.input = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobRequest)
|
1907
|
+
o.output = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobResponse)
|
1908
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1909
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1910
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1911
|
+
end)
|
1912
|
+
|
1727
1913
|
api.add_operation(:stop_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1728
1914
|
o.name = "StopSentimentDetectionJob"
|
1729
1915
|
o.http_method = "POST"
|
@@ -10,6 +10,47 @@
|
|
10
10
|
module Aws::Comprehend
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An augmented manifest file that provides training data for your custom
|
14
|
+
# model. An augmented manifest file is a labeled dataset that is
|
15
|
+
# produced by Amazon SageMaker Ground Truth.
|
16
|
+
#
|
17
|
+
# @note When making an API call, you may pass AugmentedManifestsListItem
|
18
|
+
# data as a hash:
|
19
|
+
#
|
20
|
+
# {
|
21
|
+
# s3_uri: "S3Uri", # required
|
22
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] s3_uri
|
26
|
+
# The Amazon S3 location of the augmented manifest file.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] attribute_names
|
30
|
+
# The JSON attribute that contains the annotations for your training
|
31
|
+
# documents. The number of attribute names that you specify depends on
|
32
|
+
# whether your augmented manifest file is the output of a single
|
33
|
+
# labeling job or a chained labeling job.
|
34
|
+
#
|
35
|
+
# If your file is the output of a single labeling job, specify the
|
36
|
+
# LabelAttributeName key that was used when the job was created in
|
37
|
+
# Ground Truth.
|
38
|
+
#
|
39
|
+
# If your file is the output of a chained labeling job, specify the
|
40
|
+
# LabelAttributeName key for one or more jobs in the chain. Each
|
41
|
+
# LabelAttributeName key provides the annotations from an individual
|
42
|
+
# job.
|
43
|
+
# @return [Array<String>]
|
44
|
+
#
|
45
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/AugmentedManifestsListItem AWS API Documentation
|
46
|
+
#
|
47
|
+
class AugmentedManifestsListItem < Struct.new(
|
48
|
+
:s3_uri,
|
49
|
+
:attribute_names)
|
50
|
+
SENSITIVE = []
|
51
|
+
include Aws::Structure
|
52
|
+
end
|
53
|
+
|
13
54
|
# The result of calling the operation. The operation returns one object
|
14
55
|
# for each document that is successfully processed by the operation.
|
15
56
|
#
|
@@ -604,8 +645,15 @@ module Aws::Comprehend
|
|
604
645
|
# },
|
605
646
|
# ],
|
606
647
|
# input_data_config: { # required
|
607
|
-
#
|
648
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
649
|
+
# s3_uri: "S3Uri",
|
608
650
|
# label_delimiter: "LabelDelimiter",
|
651
|
+
# augmented_manifests: [
|
652
|
+
# {
|
653
|
+
# s3_uri: "S3Uri", # required
|
654
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
655
|
+
# },
|
656
|
+
# ],
|
609
657
|
# },
|
610
658
|
# output_data_config: {
|
611
659
|
# s3_uri: "S3Uri",
|
@@ -810,12 +858,13 @@ module Aws::Comprehend
|
|
810
858
|
# },
|
811
859
|
# ],
|
812
860
|
# input_data_config: { # required
|
861
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
813
862
|
# entity_types: [ # required
|
814
863
|
# {
|
815
864
|
# type: "EntityTypeName", # required
|
816
865
|
# },
|
817
866
|
# ],
|
818
|
-
# documents: {
|
867
|
+
# documents: {
|
819
868
|
# s3_uri: "S3Uri", # required
|
820
869
|
# },
|
821
870
|
# annotations: {
|
@@ -824,6 +873,12 @@ module Aws::Comprehend
|
|
824
873
|
# entity_list: {
|
825
874
|
# s3_uri: "S3Uri", # required
|
826
875
|
# },
|
876
|
+
# augmented_manifests: [
|
877
|
+
# {
|
878
|
+
# s3_uri: "S3Uri", # required
|
879
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
880
|
+
# },
|
881
|
+
# ],
|
827
882
|
# },
|
828
883
|
# client_request_token: "ClientRequestTokenString",
|
829
884
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
@@ -870,8 +925,10 @@ module Aws::Comprehend
|
|
870
925
|
# @return [String]
|
871
926
|
#
|
872
927
|
# @!attribute [rw] language_code
|
873
|
-
#
|
874
|
-
#
|
928
|
+
# You can specify any of the following languages supported by Amazon
|
929
|
+
# Comprehend: English ("en"), Spanish ("es"), French ("fr"),
|
930
|
+
# Italian ("it"), German ("de"), or Portuguese ("pt"). All
|
931
|
+
# documents must be in the same language.
|
875
932
|
# @return [String]
|
876
933
|
#
|
877
934
|
# @!attribute [rw] volume_kms_key_id
|
@@ -1223,6 +1280,38 @@ module Aws::Comprehend
|
|
1223
1280
|
include Aws::Structure
|
1224
1281
|
end
|
1225
1282
|
|
1283
|
+
# @note When making an API call, you may pass DescribePiiEntitiesDetectionJobRequest
|
1284
|
+
# data as a hash:
|
1285
|
+
#
|
1286
|
+
# {
|
1287
|
+
# job_id: "JobId", # required
|
1288
|
+
# }
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] job_id
|
1291
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
1292
|
+
# operation returns this identifier in its response.
|
1293
|
+
# @return [String]
|
1294
|
+
#
|
1295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobRequest AWS API Documentation
|
1296
|
+
#
|
1297
|
+
class DescribePiiEntitiesDetectionJobRequest < Struct.new(
|
1298
|
+
:job_id)
|
1299
|
+
SENSITIVE = []
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# @!attribute [rw] pii_entities_detection_job_properties
|
1304
|
+
# Provides information about a PII entities detection job.
|
1305
|
+
# @return [Types::PiiEntitiesDetectionJobProperties]
|
1306
|
+
#
|
1307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobResponse AWS API Documentation
|
1308
|
+
#
|
1309
|
+
class DescribePiiEntitiesDetectionJobResponse < Struct.new(
|
1310
|
+
:pii_entities_detection_job_properties)
|
1311
|
+
SENSITIVE = []
|
1312
|
+
include Aws::Structure
|
1313
|
+
end
|
1314
|
+
|
1226
1315
|
# @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
|
1227
1316
|
# data as a hash:
|
1228
1317
|
#
|
@@ -1438,6 +1527,47 @@ module Aws::Comprehend
|
|
1438
1527
|
include Aws::Structure
|
1439
1528
|
end
|
1440
1529
|
|
1530
|
+
# @note When making an API call, you may pass DetectPiiEntitiesRequest
|
1531
|
+
# data as a hash:
|
1532
|
+
#
|
1533
|
+
# {
|
1534
|
+
# text: "String", # required
|
1535
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1536
|
+
# }
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] text
|
1539
|
+
# A UTF-8 text string. Each string must contain fewer that 5,000 bytes
|
1540
|
+
# of UTF-8 encoded characters.
|
1541
|
+
# @return [String]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] language_code
|
1544
|
+
# The language of the input documents.
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
|
1548
|
+
#
|
1549
|
+
class DetectPiiEntitiesRequest < Struct.new(
|
1550
|
+
:text,
|
1551
|
+
:language_code)
|
1552
|
+
SENSITIVE = []
|
1553
|
+
include Aws::Structure
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
# @!attribute [rw] entities
|
1557
|
+
# A collection of PII entities identified in the input text. For each
|
1558
|
+
# entity, the response provides the entity type, where the entity text
|
1559
|
+
# begins and ends, and the level of confidence that Amazon Comprehend
|
1560
|
+
# has in the detection.
|
1561
|
+
# @return [Array<Types::PiiEntity>]
|
1562
|
+
#
|
1563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesResponse AWS API Documentation
|
1564
|
+
#
|
1565
|
+
class DetectPiiEntitiesResponse < Struct.new(
|
1566
|
+
:entities)
|
1567
|
+
SENSITIVE = []
|
1568
|
+
include Aws::Structure
|
1569
|
+
end
|
1570
|
+
|
1441
1571
|
# @note When making an API call, you may pass DetectSentimentRequest
|
1442
1572
|
# data as a hash:
|
1443
1573
|
#
|
@@ -1738,10 +1868,37 @@ module Aws::Comprehend
|
|
1738
1868
|
# data as a hash:
|
1739
1869
|
#
|
1740
1870
|
# {
|
1741
|
-
#
|
1871
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
1872
|
+
# s3_uri: "S3Uri",
|
1742
1873
|
# label_delimiter: "LabelDelimiter",
|
1874
|
+
# augmented_manifests: [
|
1875
|
+
# {
|
1876
|
+
# s3_uri: "S3Uri", # required
|
1877
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
1878
|
+
# },
|
1879
|
+
# ],
|
1743
1880
|
# }
|
1744
1881
|
#
|
1882
|
+
# @!attribute [rw] data_format
|
1883
|
+
# The format of your training data:
|
1884
|
+
#
|
1885
|
+
# * `COMPREHEND_CSV`\: A two-column CSV file, where labels are
|
1886
|
+
# provided in the first column, and documents are provided in the
|
1887
|
+
# second. If you use this value, you must provide the `S3Uri`
|
1888
|
+
# parameter in your request.
|
1889
|
+
#
|
1890
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
1891
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
1892
|
+
# Each line is a complete JSON object that contains a training
|
1893
|
+
# document and its associated labels.
|
1894
|
+
#
|
1895
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
1896
|
+
# parameter in your request.
|
1897
|
+
#
|
1898
|
+
# If you don't specify a value, Amazon Comprehend uses
|
1899
|
+
# `COMPREHEND_CSV` as the default.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1745
1902
|
# @!attribute [rw] s3_uri
|
1746
1903
|
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
1747
1904
|
# same region as the API endpoint that you are calling. The URI can
|
@@ -1752,6 +1909,9 @@ module Aws::Comprehend
|
|
1752
1909
|
# prefix is a single file, Amazon Comprehend uses that file as input.
|
1753
1910
|
# If more than one file begins with the prefix, Amazon Comprehend uses
|
1754
1911
|
# all of them as input.
|
1912
|
+
#
|
1913
|
+
# This parameter is required if you set `DataFormat` to
|
1914
|
+
# `COMPREHEND_CSV`.
|
1755
1915
|
# @return [String]
|
1756
1916
|
#
|
1757
1917
|
# @!attribute [rw] label_delimiter
|
@@ -1764,11 +1924,22 @@ module Aws::Comprehend
|
|
1764
1924
|
# be combined to make a single unique label, such as LABELLABELLABEL.
|
1765
1925
|
# @return [String]
|
1766
1926
|
#
|
1927
|
+
# @!attribute [rw] augmented_manifests
|
1928
|
+
# A list of augmented manifest files that provide training data for
|
1929
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
1930
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
1931
|
+
#
|
1932
|
+
# This parameter is required if you set `DataFormat` to
|
1933
|
+
# `AUGMENTED_MANIFEST`.
|
1934
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
1935
|
+
#
|
1767
1936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1768
1937
|
#
|
1769
1938
|
class DocumentClassifierInputDataConfig < Struct.new(
|
1939
|
+
:data_format,
|
1770
1940
|
:s3_uri,
|
1771
|
-
:label_delimiter
|
1941
|
+
:label_delimiter,
|
1942
|
+
:augmented_manifests)
|
1772
1943
|
SENSITIVE = []
|
1773
1944
|
include Aws::Structure
|
1774
1945
|
end
|
@@ -2551,12 +2722,13 @@ module Aws::Comprehend
|
|
2551
2722
|
# data as a hash:
|
2552
2723
|
#
|
2553
2724
|
# {
|
2725
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
2554
2726
|
# entity_types: [ # required
|
2555
2727
|
# {
|
2556
2728
|
# type: "EntityTypeName", # required
|
2557
2729
|
# },
|
2558
2730
|
# ],
|
2559
|
-
# documents: {
|
2731
|
+
# documents: {
|
2560
2732
|
# s3_uri: "S3Uri", # required
|
2561
2733
|
# },
|
2562
2734
|
# annotations: {
|
@@ -2565,33 +2737,89 @@ module Aws::Comprehend
|
|
2565
2737
|
# entity_list: {
|
2566
2738
|
# s3_uri: "S3Uri", # required
|
2567
2739
|
# },
|
2740
|
+
# augmented_manifests: [
|
2741
|
+
# {
|
2742
|
+
# s3_uri: "S3Uri", # required
|
2743
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
2744
|
+
# },
|
2745
|
+
# ],
|
2568
2746
|
# }
|
2569
2747
|
#
|
2748
|
+
# @!attribute [rw] data_format
|
2749
|
+
# The format of your training data:
|
2750
|
+
#
|
2751
|
+
# * `COMPREHEND_CSV`\: A CSV file that supplements your training
|
2752
|
+
# documents. The CSV file contains information about the custom
|
2753
|
+
# entities that your trained model will detect. The required format
|
2754
|
+
# of the file depends on whether you are providing annotations or an
|
2755
|
+
# entity list.
|
2756
|
+
#
|
2757
|
+
# If you use this value, you must provide your CSV file by using
|
2758
|
+
# either the `Annotations` or `EntityList` parameters. You must
|
2759
|
+
# provide your training documents by using the `Documents`
|
2760
|
+
# parameter.
|
2761
|
+
#
|
2762
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
2763
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
2764
|
+
# Each line is a complete JSON object that contains a training
|
2765
|
+
# document and its labels. Each label annotates a named entity in
|
2766
|
+
# the training document.
|
2767
|
+
#
|
2768
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
2769
|
+
# parameter in your request.
|
2770
|
+
#
|
2771
|
+
# If you don't specify a value, Amazon Comprehend uses
|
2772
|
+
# `COMPREHEND_CSV` as the default.
|
2773
|
+
# @return [String]
|
2774
|
+
#
|
2570
2775
|
# @!attribute [rw] entity_types
|
2571
|
-
# The entity types in the
|
2572
|
-
#
|
2573
|
-
#
|
2776
|
+
# The entity types in the labeled training data that Amazon Comprehend
|
2777
|
+
# uses to train the custom entity recognizer. Any entity types that
|
2778
|
+
# you don't specify are ignored.
|
2779
|
+
#
|
2780
|
+
# A maximum of 25 entity types can be used at one time to train an
|
2781
|
+
# entity recognizer. Entity types must not contain the following
|
2782
|
+
# invalid characters: \\n (line break), \\\\n (escaped line break),
|
2783
|
+
# \\r (carriage return), \\\\r (escaped carriage return), \\t (tab),
|
2784
|
+
# \\\\t (escaped tab), space, and , (comma).
|
2574
2785
|
# @return [Array<Types::EntityTypesListItem>]
|
2575
2786
|
#
|
2576
2787
|
# @!attribute [rw] documents
|
2577
|
-
# S3 location of the
|
2788
|
+
# The S3 location of the folder that contains the training documents
|
2789
|
+
# for your custom entity recognizer.
|
2790
|
+
#
|
2791
|
+
# This parameter is required if you set `DataFormat` to
|
2792
|
+
# `COMPREHEND_CSV`.
|
2578
2793
|
# @return [Types::EntityRecognizerDocuments]
|
2579
2794
|
#
|
2580
2795
|
# @!attribute [rw] annotations
|
2581
|
-
# S3 location of the
|
2796
|
+
# The S3 location of the CSV file that annotates your training
|
2797
|
+
# documents.
|
2582
2798
|
# @return [Types::EntityRecognizerAnnotations]
|
2583
2799
|
#
|
2584
2800
|
# @!attribute [rw] entity_list
|
2585
|
-
# S3 location of the entity list for
|
2801
|
+
# The S3 location of the CSV file that has the entity list for your
|
2802
|
+
# custom entity recognizer.
|
2586
2803
|
# @return [Types::EntityRecognizerEntityList]
|
2587
2804
|
#
|
2805
|
+
# @!attribute [rw] augmented_manifests
|
2806
|
+
# A list of augmented manifest files that provide training data for
|
2807
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
2808
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
2809
|
+
#
|
2810
|
+
# This parameter is required if you set `DataFormat` to
|
2811
|
+
# `AUGMENTED_MANIFEST`.
|
2812
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
2813
|
+
#
|
2588
2814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig AWS API Documentation
|
2589
2815
|
#
|
2590
2816
|
class EntityRecognizerInputDataConfig < Struct.new(
|
2817
|
+
:data_format,
|
2591
2818
|
:entity_types,
|
2592
2819
|
:documents,
|
2593
2820
|
:annotations,
|
2594
|
-
:entity_list
|
2821
|
+
:entity_list,
|
2822
|
+
:augmented_manifests)
|
2595
2823
|
SENSITIVE = []
|
2596
2824
|
include Aws::Structure
|
2597
2825
|
end
|
@@ -2783,7 +3011,8 @@ module Aws::Comprehend
|
|
2783
3011
|
include Aws::Structure
|
2784
3012
|
end
|
2785
3013
|
|
2786
|
-
#
|
3014
|
+
# An entity type within a labeled training dataset that Amazon
|
3015
|
+
# Comprehend uses to train a custom entity recognizer.
|
2787
3016
|
#
|
2788
3017
|
# @note When making an API call, you may pass EntityTypesListItem
|
2789
3018
|
# data as a hash:
|
@@ -2793,7 +3022,13 @@ module Aws::Comprehend
|
|
2793
3022
|
# }
|
2794
3023
|
#
|
2795
3024
|
# @!attribute [rw] type
|
2796
|
-
#
|
3025
|
+
# An entity type within a labeled training dataset that Amazon
|
3026
|
+
# Comprehend uses to train a custom entity recognizer.
|
3027
|
+
#
|
3028
|
+
# Entity types must not contain the following invalid characters: \\n
|
3029
|
+
# (line break), \\\\n (escaped line break, \\r (carriage return),
|
3030
|
+
# \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),
|
3031
|
+
# space, and , (comma).
|
2797
3032
|
# @return [String]
|
2798
3033
|
#
|
2799
3034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
|
@@ -3479,6 +3714,61 @@ module Aws::Comprehend
|
|
3479
3714
|
include Aws::Structure
|
3480
3715
|
end
|
3481
3716
|
|
3717
|
+
# @note When making an API call, you may pass ListPiiEntitiesDetectionJobsRequest
|
3718
|
+
# data as a hash:
|
3719
|
+
#
|
3720
|
+
# {
|
3721
|
+
# filter: {
|
3722
|
+
# job_name: "JobName",
|
3723
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3724
|
+
# submit_time_before: Time.now,
|
3725
|
+
# submit_time_after: Time.now,
|
3726
|
+
# },
|
3727
|
+
# next_token: "String",
|
3728
|
+
# max_results: 1,
|
3729
|
+
# }
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] filter
|
3732
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3733
|
+
# name, status, or the date and time that they were submitted. You can
|
3734
|
+
# only set one filter at a time.
|
3735
|
+
# @return [Types::PiiEntitiesDetectionJobFilter]
|
3736
|
+
#
|
3737
|
+
# @!attribute [rw] next_token
|
3738
|
+
# Identifies the next page of results to return.
|
3739
|
+
# @return [String]
|
3740
|
+
#
|
3741
|
+
# @!attribute [rw] max_results
|
3742
|
+
# The maximum number of results to return in each page.
|
3743
|
+
# @return [Integer]
|
3744
|
+
#
|
3745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsRequest AWS API Documentation
|
3746
|
+
#
|
3747
|
+
class ListPiiEntitiesDetectionJobsRequest < Struct.new(
|
3748
|
+
:filter,
|
3749
|
+
:next_token,
|
3750
|
+
:max_results)
|
3751
|
+
SENSITIVE = []
|
3752
|
+
include Aws::Structure
|
3753
|
+
end
|
3754
|
+
|
3755
|
+
# @!attribute [rw] pii_entities_detection_job_properties_list
|
3756
|
+
# A list containing the properties of each job that is returned.
|
3757
|
+
# @return [Array<Types::PiiEntitiesDetectionJobProperties>]
|
3758
|
+
#
|
3759
|
+
# @!attribute [rw] next_token
|
3760
|
+
# Identifies the next page of results to return.
|
3761
|
+
# @return [String]
|
3762
|
+
#
|
3763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsResponse AWS API Documentation
|
3764
|
+
#
|
3765
|
+
class ListPiiEntitiesDetectionJobsResponse < Struct.new(
|
3766
|
+
:pii_entities_detection_job_properties_list,
|
3767
|
+
:next_token)
|
3768
|
+
SENSITIVE = []
|
3769
|
+
include Aws::Structure
|
3770
|
+
end
|
3771
|
+
|
3482
3772
|
# @note When making an API call, you may pass ListSentimentDetectionJobsRequest
|
3483
3773
|
# data as a hash:
|
3484
3774
|
#
|
@@ -3705,6 +3995,228 @@ module Aws::Comprehend
|
|
3705
3995
|
include Aws::Structure
|
3706
3996
|
end
|
3707
3997
|
|
3998
|
+
# Provides information for filtering a list of PII entity detection
|
3999
|
+
# jobs.
|
4000
|
+
#
|
4001
|
+
# @note When making an API call, you may pass PiiEntitiesDetectionJobFilter
|
4002
|
+
# data as a hash:
|
4003
|
+
#
|
4004
|
+
# {
|
4005
|
+
# job_name: "JobName",
|
4006
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
4007
|
+
# submit_time_before: Time.now,
|
4008
|
+
# submit_time_after: Time.now,
|
4009
|
+
# }
|
4010
|
+
#
|
4011
|
+
# @!attribute [rw] job_name
|
4012
|
+
# Filters on the name of the job.
|
4013
|
+
# @return [String]
|
4014
|
+
#
|
4015
|
+
# @!attribute [rw] job_status
|
4016
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
4017
|
+
# the specified status.
|
4018
|
+
# @return [String]
|
4019
|
+
#
|
4020
|
+
# @!attribute [rw] submit_time_before
|
4021
|
+
# Filters the list of jobs based on the time that the job was
|
4022
|
+
# submitted for processing. Returns only jobs submitted before the
|
4023
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
4024
|
+
# newest.
|
4025
|
+
# @return [Time]
|
4026
|
+
#
|
4027
|
+
# @!attribute [rw] submit_time_after
|
4028
|
+
# Filters the list of jobs based on the time that the job was
|
4029
|
+
# submitted for processing. Returns only jobs submitted after the
|
4030
|
+
# specified time. Jobs are returned in descending order, newest to
|
4031
|
+
# oldest.
|
4032
|
+
# @return [Time]
|
4033
|
+
#
|
4034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobFilter AWS API Documentation
|
4035
|
+
#
|
4036
|
+
class PiiEntitiesDetectionJobFilter < Struct.new(
|
4037
|
+
:job_name,
|
4038
|
+
:job_status,
|
4039
|
+
:submit_time_before,
|
4040
|
+
:submit_time_after)
|
4041
|
+
SENSITIVE = []
|
4042
|
+
include Aws::Structure
|
4043
|
+
end
|
4044
|
+
|
4045
|
+
# Provides information about a PII entities detection job.
|
4046
|
+
#
|
4047
|
+
# @!attribute [rw] job_id
|
4048
|
+
# The identifier assigned to the PII entities detection job.
|
4049
|
+
# @return [String]
|
4050
|
+
#
|
4051
|
+
# @!attribute [rw] job_name
|
4052
|
+
# The name that you assigned the PII entities detection job.
|
4053
|
+
# @return [String]
|
4054
|
+
#
|
4055
|
+
# @!attribute [rw] job_status
|
4056
|
+
# The current status of the PII entities detection job. If the status
|
4057
|
+
# is `FAILED`, the `Message` field shows the reason for the failure.
|
4058
|
+
# @return [String]
|
4059
|
+
#
|
4060
|
+
# @!attribute [rw] message
|
4061
|
+
# A description of the status of a job.
|
4062
|
+
# @return [String]
|
4063
|
+
#
|
4064
|
+
# @!attribute [rw] submit_time
|
4065
|
+
# The time that the PII entities detection job was submitted for
|
4066
|
+
# processing.
|
4067
|
+
# @return [Time]
|
4068
|
+
#
|
4069
|
+
# @!attribute [rw] end_time
|
4070
|
+
# The time that the PII entities detection job completed.
|
4071
|
+
# @return [Time]
|
4072
|
+
#
|
4073
|
+
# @!attribute [rw] input_data_config
|
4074
|
+
# The input properties for a PII entities detection job.
|
4075
|
+
# @return [Types::InputDataConfig]
|
4076
|
+
#
|
4077
|
+
# @!attribute [rw] output_data_config
|
4078
|
+
# The output data configuration that you supplied when you created the
|
4079
|
+
# PII entities detection job.
|
4080
|
+
# @return [Types::PiiOutputDataConfig]
|
4081
|
+
#
|
4082
|
+
# @!attribute [rw] redaction_config
|
4083
|
+
# Provides configuration parameters for PII entity redaction.
|
4084
|
+
#
|
4085
|
+
# This parameter is required if you set the `Mode` parameter to
|
4086
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
4087
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
4088
|
+
# @return [Types::RedactionConfig]
|
4089
|
+
#
|
4090
|
+
# @!attribute [rw] language_code
|
4091
|
+
# The language code of the input documents
|
4092
|
+
# @return [String]
|
4093
|
+
#
|
4094
|
+
# @!attribute [rw] data_access_role_arn
|
4095
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
4096
|
+
# access to your input data.
|
4097
|
+
# @return [String]
|
4098
|
+
#
|
4099
|
+
# @!attribute [rw] mode
|
4100
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
4101
|
+
# entities or a file in which PII entities are redacted.
|
4102
|
+
# @return [String]
|
4103
|
+
#
|
4104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobProperties AWS API Documentation
|
4105
|
+
#
|
4106
|
+
class PiiEntitiesDetectionJobProperties < Struct.new(
|
4107
|
+
:job_id,
|
4108
|
+
:job_name,
|
4109
|
+
:job_status,
|
4110
|
+
:message,
|
4111
|
+
:submit_time,
|
4112
|
+
:end_time,
|
4113
|
+
:input_data_config,
|
4114
|
+
:output_data_config,
|
4115
|
+
:redaction_config,
|
4116
|
+
:language_code,
|
4117
|
+
:data_access_role_arn,
|
4118
|
+
:mode)
|
4119
|
+
SENSITIVE = []
|
4120
|
+
include Aws::Structure
|
4121
|
+
end
|
4122
|
+
|
4123
|
+
# Provides information about a PII entity.
|
4124
|
+
#
|
4125
|
+
# @!attribute [rw] score
|
4126
|
+
# The level of confidence that Amazon Comprehend has in the accuracy
|
4127
|
+
# of the detection.
|
4128
|
+
# @return [Float]
|
4129
|
+
#
|
4130
|
+
# @!attribute [rw] type
|
4131
|
+
# The entity's type.
|
4132
|
+
# @return [String]
|
4133
|
+
#
|
4134
|
+
# @!attribute [rw] begin_offset
|
4135
|
+
# A character offset in the input text that shows where the PII entity
|
4136
|
+
# begins (the first character is at position 0). The offset returns
|
4137
|
+
# the position of each UTF-8 code point in the string. A *code point*
|
4138
|
+
# is the abstract character from a particular graphical
|
4139
|
+
# representation. For example, a multi-byte UTF-8 character maps to a
|
4140
|
+
# single code point.
|
4141
|
+
# @return [Integer]
|
4142
|
+
#
|
4143
|
+
# @!attribute [rw] end_offset
|
4144
|
+
# A character offset in the input text that shows where the PII entity
|
4145
|
+
# ends. The offset returns the position of each UTF-8 code point in
|
4146
|
+
# the string. A *code point* is the abstract character from a
|
4147
|
+
# particular graphical representation. For example, a multi-byte UTF-8
|
4148
|
+
# character maps to a single code point.
|
4149
|
+
# @return [Integer]
|
4150
|
+
#
|
4151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
|
4152
|
+
#
|
4153
|
+
class PiiEntity < Struct.new(
|
4154
|
+
:score,
|
4155
|
+
:type,
|
4156
|
+
:begin_offset,
|
4157
|
+
:end_offset)
|
4158
|
+
SENSITIVE = []
|
4159
|
+
include Aws::Structure
|
4160
|
+
end
|
4161
|
+
|
4162
|
+
# Provides configuration parameters for the output of PII entity
|
4163
|
+
# detection jobs.
|
4164
|
+
#
|
4165
|
+
# @!attribute [rw] s3_uri
|
4166
|
+
# When you use the `PiiOutputDataConfig` object with asynchronous
|
4167
|
+
# operations, you specify the Amazon S3 location where you want to
|
4168
|
+
# write the output data.
|
4169
|
+
# @return [String]
|
4170
|
+
#
|
4171
|
+
# @!attribute [rw] kms_key_id
|
4172
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
4173
|
+
# Comprehend uses to encrypt the output results from an analysis job.
|
4174
|
+
# @return [String]
|
4175
|
+
#
|
4176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
|
4177
|
+
#
|
4178
|
+
class PiiOutputDataConfig < Struct.new(
|
4179
|
+
:s3_uri,
|
4180
|
+
:kms_key_id)
|
4181
|
+
SENSITIVE = []
|
4182
|
+
include Aws::Structure
|
4183
|
+
end
|
4184
|
+
|
4185
|
+
# Provides configuration parameters for PII entity redaction.
|
4186
|
+
#
|
4187
|
+
# @note When making an API call, you may pass RedactionConfig
|
4188
|
+
# data as a hash:
|
4189
|
+
#
|
4190
|
+
# {
|
4191
|
+
# 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
|
4192
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
4193
|
+
# mask_character: "MaskCharacter",
|
4194
|
+
# }
|
4195
|
+
#
|
4196
|
+
# @!attribute [rw] pii_entity_types
|
4197
|
+
# An array of the types of PII entities that Amazon Comprehend detects
|
4198
|
+
# in the input text for your request.
|
4199
|
+
# @return [Array<String>]
|
4200
|
+
#
|
4201
|
+
# @!attribute [rw] mask_mode
|
4202
|
+
# Specifies whether the PII entity is redacted with the mask character
|
4203
|
+
# or the entity type.
|
4204
|
+
# @return [String]
|
4205
|
+
#
|
4206
|
+
# @!attribute [rw] mask_character
|
4207
|
+
# A character that replaces each character in the redacted PII entity.
|
4208
|
+
# @return [String]
|
4209
|
+
#
|
4210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RedactionConfig AWS API Documentation
|
4211
|
+
#
|
4212
|
+
class RedactionConfig < Struct.new(
|
4213
|
+
:pii_entity_types,
|
4214
|
+
:mask_mode,
|
4215
|
+
:mask_character)
|
4216
|
+
SENSITIVE = []
|
4217
|
+
include Aws::Structure
|
4218
|
+
end
|
4219
|
+
|
3708
4220
|
# The specified resource name is already in use. Use a different name
|
3709
4221
|
# and try your request again.
|
3710
4222
|
#
|
@@ -4438,6 +4950,106 @@ module Aws::Comprehend
|
|
4438
4950
|
include Aws::Structure
|
4439
4951
|
end
|
4440
4952
|
|
4953
|
+
# @note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
|
4954
|
+
# data as a hash:
|
4955
|
+
#
|
4956
|
+
# {
|
4957
|
+
# input_data_config: { # required
|
4958
|
+
# s3_uri: "S3Uri", # required
|
4959
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
4960
|
+
# },
|
4961
|
+
# output_data_config: { # required
|
4962
|
+
# s3_uri: "S3Uri", # required
|
4963
|
+
# kms_key_id: "KmsKeyId",
|
4964
|
+
# },
|
4965
|
+
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
4966
|
+
# redaction_config: {
|
4967
|
+
# 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
|
4968
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
4969
|
+
# mask_character: "MaskCharacter",
|
4970
|
+
# },
|
4971
|
+
# data_access_role_arn: "IamRoleArn", # required
|
4972
|
+
# job_name: "JobName",
|
4973
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
4974
|
+
# client_request_token: "ClientRequestTokenString",
|
4975
|
+
# }
|
4976
|
+
#
|
4977
|
+
# @!attribute [rw] input_data_config
|
4978
|
+
# The input properties for a PII entities detection job.
|
4979
|
+
# @return [Types::InputDataConfig]
|
4980
|
+
#
|
4981
|
+
# @!attribute [rw] output_data_config
|
4982
|
+
# Provides configuration parameters for the output of PII entity
|
4983
|
+
# detection jobs.
|
4984
|
+
# @return [Types::OutputDataConfig]
|
4985
|
+
#
|
4986
|
+
# @!attribute [rw] mode
|
4987
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
4988
|
+
# entities or a file in which PII entities are redacted.
|
4989
|
+
# @return [String]
|
4990
|
+
#
|
4991
|
+
# @!attribute [rw] redaction_config
|
4992
|
+
# Provides configuration parameters for PII entity redaction.
|
4993
|
+
#
|
4994
|
+
# This parameter is required if you set the `Mode` parameter to
|
4995
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
4996
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
4997
|
+
# @return [Types::RedactionConfig]
|
4998
|
+
#
|
4999
|
+
# @!attribute [rw] data_access_role_arn
|
5000
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
5001
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
5002
|
+
# your input data.
|
5003
|
+
# @return [String]
|
5004
|
+
#
|
5005
|
+
# @!attribute [rw] job_name
|
5006
|
+
# The identifier of the job.
|
5007
|
+
# @return [String]
|
5008
|
+
#
|
5009
|
+
# @!attribute [rw] language_code
|
5010
|
+
# The language of the input documents.
|
5011
|
+
# @return [String]
|
5012
|
+
#
|
5013
|
+
# @!attribute [rw] client_request_token
|
5014
|
+
# A unique identifier for the request. If you don't set the client
|
5015
|
+
# request token, Amazon Comprehend generates one.
|
5016
|
+
#
|
5017
|
+
# **A suitable default value is auto-generated.** You should normally
|
5018
|
+
# not need to pass this option.
|
5019
|
+
# @return [String]
|
5020
|
+
#
|
5021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
5022
|
+
#
|
5023
|
+
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
5024
|
+
:input_data_config,
|
5025
|
+
:output_data_config,
|
5026
|
+
:mode,
|
5027
|
+
:redaction_config,
|
5028
|
+
:data_access_role_arn,
|
5029
|
+
:job_name,
|
5030
|
+
:language_code,
|
5031
|
+
:client_request_token)
|
5032
|
+
SENSITIVE = []
|
5033
|
+
include Aws::Structure
|
5034
|
+
end
|
5035
|
+
|
5036
|
+
# @!attribute [rw] job_id
|
5037
|
+
# The identifier generated for the job.
|
5038
|
+
# @return [String]
|
5039
|
+
#
|
5040
|
+
# @!attribute [rw] job_status
|
5041
|
+
# The status of the job.
|
5042
|
+
# @return [String]
|
5043
|
+
#
|
5044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobResponse AWS API Documentation
|
5045
|
+
#
|
5046
|
+
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
5047
|
+
:job_id,
|
5048
|
+
:job_status)
|
5049
|
+
SENSITIVE = []
|
5050
|
+
include Aws::Structure
|
5051
|
+
end
|
5052
|
+
|
4441
5053
|
# @note When making an API call, you may pass StartSentimentDetectionJobRequest
|
4442
5054
|
# data as a hash:
|
4443
5055
|
#
|
@@ -4805,6 +5417,42 @@ module Aws::Comprehend
|
|
4805
5417
|
include Aws::Structure
|
4806
5418
|
end
|
4807
5419
|
|
5420
|
+
# @note When making an API call, you may pass StopPiiEntitiesDetectionJobRequest
|
5421
|
+
# data as a hash:
|
5422
|
+
#
|
5423
|
+
# {
|
5424
|
+
# job_id: "JobId", # required
|
5425
|
+
# }
|
5426
|
+
#
|
5427
|
+
# @!attribute [rw] job_id
|
5428
|
+
# The identifier of the PII entities detection job to stop.
|
5429
|
+
# @return [String]
|
5430
|
+
#
|
5431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobRequest AWS API Documentation
|
5432
|
+
#
|
5433
|
+
class StopPiiEntitiesDetectionJobRequest < Struct.new(
|
5434
|
+
:job_id)
|
5435
|
+
SENSITIVE = []
|
5436
|
+
include Aws::Structure
|
5437
|
+
end
|
5438
|
+
|
5439
|
+
# @!attribute [rw] job_id
|
5440
|
+
# The identifier of the PII entities detection job to stop.
|
5441
|
+
# @return [String]
|
5442
|
+
#
|
5443
|
+
# @!attribute [rw] job_status
|
5444
|
+
# The status of the PII entities detection job.
|
5445
|
+
# @return [String]
|
5446
|
+
#
|
5447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobResponse AWS API Documentation
|
5448
|
+
#
|
5449
|
+
class StopPiiEntitiesDetectionJobResponse < Struct.new(
|
5450
|
+
:job_id,
|
5451
|
+
:job_status)
|
5452
|
+
SENSITIVE = []
|
5453
|
+
include Aws::Structure
|
5454
|
+
end
|
5455
|
+
|
4808
5456
|
# @note When making an API call, you may pass StopSentimentDetectionJobRequest
|
4809
5457
|
# data as a hash:
|
4810
5458
|
#
|
@@ -5199,8 +5847,9 @@ module Aws::Comprehend
|
|
5199
5847
|
|
5200
5848
|
# Amazon Comprehend can't process the language of the input text. For
|
5201
5849
|
# all custom entity recognition APIs (such as `CreateEntityRecognizer`),
|
5202
|
-
# only English
|
5203
|
-
#
|
5850
|
+
# only English, Spanish, French, Italian, German, or Portuguese are
|
5851
|
+
# accepted. For most other APIs, such as those for Custom
|
5852
|
+
# Classification, Amazon Comprehend accepts text in all supported
|
5204
5853
|
# languages. For a list of supported languages, see supported-languages.
|
5205
5854
|
#
|
5206
5855
|
# @!attribute [rw] message
|