aws-sdk-comprehend 1.45.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +164 -1
- data/lib/aws-sdk-comprehend/client_api.rb +38 -0
- data/lib/aws-sdk-comprehend/types.rb +418 -14
- metadata +7 -8
@@ -416,6 +416,7 @@ module Aws::Comprehend
|
|
416
416
|
CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
417
417
|
CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
418
418
|
CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
419
|
+
CreateDocumentClassifierRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
419
420
|
CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
|
420
421
|
|
421
422
|
CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
@@ -426,6 +427,7 @@ module Aws::Comprehend
|
|
426
427
|
CreateEndpointRequest.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, required: true, location_name: "DesiredInferenceUnits"))
|
427
428
|
CreateEndpointRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
428
429
|
CreateEndpointRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
430
|
+
CreateEndpointRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
429
431
|
CreateEndpointRequest.struct_class = Types::CreateEndpointRequest
|
430
432
|
|
431
433
|
CreateEndpointResponse.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: ComprehendEndpointArn, location_name: "EndpointArn"))
|
@@ -439,6 +441,7 @@ module Aws::Comprehend
|
|
439
441
|
CreateEntityRecognizerRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
440
442
|
CreateEntityRecognizerRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
441
443
|
CreateEntityRecognizerRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
444
|
+
CreateEntityRecognizerRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
442
445
|
CreateEntityRecognizerRequest.struct_class = Types::CreateEntityRecognizerRequest
|
443
446
|
|
444
447
|
CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
@@ -581,6 +584,7 @@ module Aws::Comprehend
|
|
581
584
|
DocumentClassificationJobFilter.struct_class = Types::DocumentClassificationJobFilter
|
582
585
|
|
583
586
|
DocumentClassificationJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
587
|
+
DocumentClassificationJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
584
588
|
DocumentClassificationJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
585
589
|
DocumentClassificationJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
586
590
|
DocumentClassificationJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -628,6 +632,7 @@ module Aws::Comprehend
|
|
628
632
|
DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
629
633
|
DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
630
634
|
DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
635
|
+
DocumentClassifierProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
631
636
|
DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
|
632
637
|
|
633
638
|
DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
|
@@ -647,6 +652,7 @@ module Aws::Comprehend
|
|
647
652
|
DominantLanguageDetectionJobFilter.struct_class = Types::DominantLanguageDetectionJobFilter
|
648
653
|
|
649
654
|
DominantLanguageDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
655
|
+
DominantLanguageDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
650
656
|
DominantLanguageDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
651
657
|
DominantLanguageDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
652
658
|
DominantLanguageDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -675,6 +681,7 @@ module Aws::Comprehend
|
|
675
681
|
EndpointProperties.add_member(:current_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "CurrentInferenceUnits"))
|
676
682
|
EndpointProperties.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
677
683
|
EndpointProperties.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
|
684
|
+
EndpointProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
678
685
|
EndpointProperties.struct_class = Types::EndpointProperties
|
679
686
|
|
680
687
|
EndpointPropertiesList.member = Shapes::ShapeRef.new(shape: EndpointProperties)
|
@@ -686,6 +693,7 @@ module Aws::Comprehend
|
|
686
693
|
EntitiesDetectionJobFilter.struct_class = Types::EntitiesDetectionJobFilter
|
687
694
|
|
688
695
|
EntitiesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
696
|
+
EntitiesDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
689
697
|
EntitiesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
690
698
|
EntitiesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
691
699
|
EntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -768,6 +776,7 @@ module Aws::Comprehend
|
|
768
776
|
EntityRecognizerProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
769
777
|
EntityRecognizerProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
770
778
|
EntityRecognizerProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
779
|
+
EntityRecognizerProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
771
780
|
EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
|
772
781
|
|
773
782
|
EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
|
@@ -789,6 +798,7 @@ module Aws::Comprehend
|
|
789
798
|
EventsDetectionJobFilter.struct_class = Types::EventsDetectionJobFilter
|
790
799
|
|
791
800
|
EventsDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
801
|
+
EventsDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
792
802
|
EventsDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
793
803
|
EventsDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
794
804
|
EventsDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -832,6 +842,7 @@ module Aws::Comprehend
|
|
832
842
|
KeyPhrasesDetectionJobFilter.struct_class = Types::KeyPhrasesDetectionJobFilter
|
833
843
|
|
834
844
|
KeyPhrasesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
845
|
+
KeyPhrasesDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
835
846
|
KeyPhrasesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
836
847
|
KeyPhrasesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
837
848
|
KeyPhrasesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -999,6 +1010,7 @@ module Aws::Comprehend
|
|
999
1010
|
PiiEntitiesDetectionJobFilter.struct_class = Types::PiiEntitiesDetectionJobFilter
|
1000
1011
|
|
1001
1012
|
PiiEntitiesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1013
|
+
PiiEntitiesDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1002
1014
|
PiiEntitiesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1003
1015
|
PiiEntitiesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1004
1016
|
PiiEntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -1050,6 +1062,7 @@ module Aws::Comprehend
|
|
1050
1062
|
SentimentDetectionJobFilter.struct_class = Types::SentimentDetectionJobFilter
|
1051
1063
|
|
1052
1064
|
SentimentDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1065
|
+
SentimentDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1053
1066
|
SentimentDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1054
1067
|
SentimentDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1055
1068
|
SentimentDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -1079,9 +1092,11 @@ module Aws::Comprehend
|
|
1079
1092
|
StartDocumentClassificationJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1080
1093
|
StartDocumentClassificationJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1081
1094
|
StartDocumentClassificationJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1095
|
+
StartDocumentClassificationJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1082
1096
|
StartDocumentClassificationJobRequest.struct_class = Types::StartDocumentClassificationJobRequest
|
1083
1097
|
|
1084
1098
|
StartDocumentClassificationJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1099
|
+
StartDocumentClassificationJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1085
1100
|
StartDocumentClassificationJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1086
1101
|
StartDocumentClassificationJobResponse.struct_class = Types::StartDocumentClassificationJobResponse
|
1087
1102
|
|
@@ -1092,9 +1107,11 @@ module Aws::Comprehend
|
|
1092
1107
|
StartDominantLanguageDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1093
1108
|
StartDominantLanguageDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1094
1109
|
StartDominantLanguageDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1110
|
+
StartDominantLanguageDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1095
1111
|
StartDominantLanguageDetectionJobRequest.struct_class = Types::StartDominantLanguageDetectionJobRequest
|
1096
1112
|
|
1097
1113
|
StartDominantLanguageDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1114
|
+
StartDominantLanguageDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1098
1115
|
StartDominantLanguageDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1099
1116
|
StartDominantLanguageDetectionJobResponse.struct_class = Types::StartDominantLanguageDetectionJobResponse
|
1100
1117
|
|
@@ -1107,9 +1124,11 @@ module Aws::Comprehend
|
|
1107
1124
|
StartEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1108
1125
|
StartEntitiesDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1109
1126
|
StartEntitiesDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1127
|
+
StartEntitiesDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1110
1128
|
StartEntitiesDetectionJobRequest.struct_class = Types::StartEntitiesDetectionJobRequest
|
1111
1129
|
|
1112
1130
|
StartEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1131
|
+
StartEntitiesDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1113
1132
|
StartEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1114
1133
|
StartEntitiesDetectionJobResponse.struct_class = Types::StartEntitiesDetectionJobResponse
|
1115
1134
|
|
@@ -1120,9 +1139,11 @@ module Aws::Comprehend
|
|
1120
1139
|
StartEventsDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1121
1140
|
StartEventsDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1122
1141
|
StartEventsDetectionJobRequest.add_member(:target_event_types, Shapes::ShapeRef.new(shape: TargetEventTypes, required: true, location_name: "TargetEventTypes"))
|
1142
|
+
StartEventsDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1123
1143
|
StartEventsDetectionJobRequest.struct_class = Types::StartEventsDetectionJobRequest
|
1124
1144
|
|
1125
1145
|
StartEventsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1146
|
+
StartEventsDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1126
1147
|
StartEventsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1127
1148
|
StartEventsDetectionJobResponse.struct_class = Types::StartEventsDetectionJobResponse
|
1128
1149
|
|
@@ -1134,9 +1155,11 @@ module Aws::Comprehend
|
|
1134
1155
|
StartKeyPhrasesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1135
1156
|
StartKeyPhrasesDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1136
1157
|
StartKeyPhrasesDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1158
|
+
StartKeyPhrasesDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1137
1159
|
StartKeyPhrasesDetectionJobRequest.struct_class = Types::StartKeyPhrasesDetectionJobRequest
|
1138
1160
|
|
1139
1161
|
StartKeyPhrasesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1162
|
+
StartKeyPhrasesDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1140
1163
|
StartKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1141
1164
|
StartKeyPhrasesDetectionJobResponse.struct_class = Types::StartKeyPhrasesDetectionJobResponse
|
1142
1165
|
|
@@ -1148,9 +1171,11 @@ module Aws::Comprehend
|
|
1148
1171
|
StartPiiEntitiesDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1149
1172
|
StartPiiEntitiesDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1150
1173
|
StartPiiEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1174
|
+
StartPiiEntitiesDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1151
1175
|
StartPiiEntitiesDetectionJobRequest.struct_class = Types::StartPiiEntitiesDetectionJobRequest
|
1152
1176
|
|
1153
1177
|
StartPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1178
|
+
StartPiiEntitiesDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1154
1179
|
StartPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1155
1180
|
StartPiiEntitiesDetectionJobResponse.struct_class = Types::StartPiiEntitiesDetectionJobResponse
|
1156
1181
|
|
@@ -1162,9 +1187,11 @@ module Aws::Comprehend
|
|
1162
1187
|
StartSentimentDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1163
1188
|
StartSentimentDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1164
1189
|
StartSentimentDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1190
|
+
StartSentimentDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1165
1191
|
StartSentimentDetectionJobRequest.struct_class = Types::StartSentimentDetectionJobRequest
|
1166
1192
|
|
1167
1193
|
StartSentimentDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1194
|
+
StartSentimentDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1168
1195
|
StartSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1169
1196
|
StartSentimentDetectionJobResponse.struct_class = Types::StartSentimentDetectionJobResponse
|
1170
1197
|
|
@@ -1176,9 +1203,11 @@ module Aws::Comprehend
|
|
1176
1203
|
StartTopicsDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1177
1204
|
StartTopicsDetectionJobRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
1178
1205
|
StartTopicsDetectionJobRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
1206
|
+
StartTopicsDetectionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
1179
1207
|
StartTopicsDetectionJobRequest.struct_class = Types::StartTopicsDetectionJobRequest
|
1180
1208
|
|
1181
1209
|
StartTopicsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1210
|
+
StartTopicsDetectionJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1182
1211
|
StartTopicsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1183
1212
|
StartTopicsDetectionJobResponse.struct_class = Types::StartTopicsDetectionJobResponse
|
1184
1213
|
|
@@ -1278,6 +1307,7 @@ module Aws::Comprehend
|
|
1278
1307
|
TopicsDetectionJobFilter.struct_class = Types::TopicsDetectionJobFilter
|
1279
1308
|
|
1280
1309
|
TopicsDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1310
|
+
TopicsDetectionJobProperties.add_member(:job_arn, Shapes::ShapeRef.new(shape: ComprehendArn, location_name: "JobArn"))
|
1281
1311
|
TopicsDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1282
1312
|
TopicsDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1283
1313
|
TopicsDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
@@ -1919,6 +1949,7 @@ module Aws::Comprehend
|
|
1919
1949
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1920
1950
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1921
1951
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1952
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1922
1953
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1923
1954
|
end)
|
1924
1955
|
|
@@ -1931,6 +1962,7 @@ module Aws::Comprehend
|
|
1931
1962
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1932
1963
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1933
1964
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1965
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1934
1966
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1935
1967
|
end)
|
1936
1968
|
|
@@ -1945,6 +1977,7 @@ module Aws::Comprehend
|
|
1945
1977
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1946
1978
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1947
1979
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1980
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1948
1981
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1949
1982
|
end)
|
1950
1983
|
|
@@ -1957,6 +1990,7 @@ module Aws::Comprehend
|
|
1957
1990
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1958
1991
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1959
1992
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1993
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1960
1994
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1961
1995
|
end)
|
1962
1996
|
|
@@ -1969,6 +2003,7 @@ module Aws::Comprehend
|
|
1969
2003
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1970
2004
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1971
2005
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
2006
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1972
2007
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1973
2008
|
end)
|
1974
2009
|
|
@@ -1981,6 +2016,7 @@ module Aws::Comprehend
|
|
1981
2016
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1982
2017
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1983
2018
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
2019
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1984
2020
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1985
2021
|
end)
|
1986
2022
|
|
@@ -1993,6 +2029,7 @@ module Aws::Comprehend
|
|
1993
2029
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1994
2030
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1995
2031
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
2032
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
1996
2033
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1997
2034
|
end)
|
1998
2035
|
|
@@ -2005,6 +2042,7 @@ module Aws::Comprehend
|
|
2005
2042
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2006
2043
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2007
2044
|
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
2045
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyTagsException)
|
2008
2046
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2009
2047
|
end)
|
2010
2048
|
|
@@ -707,6 +707,7 @@ module Aws::Comprehend
|
|
707
707
|
# subnets: ["SubnetId"], # required
|
708
708
|
# },
|
709
709
|
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
710
|
+
# model_kms_key_id: "KmsKeyId",
|
710
711
|
# }
|
711
712
|
#
|
712
713
|
# @!attribute [rw] document_classifier_name
|
@@ -783,6 +784,17 @@ module Aws::Comprehend
|
|
783
784
|
# delimiter. The default delimiter between labels is a pipe (\|).
|
784
785
|
# @return [String]
|
785
786
|
#
|
787
|
+
# @!attribute [rw] model_kms_key_id
|
788
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
789
|
+
# Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
|
790
|
+
# can be either of the following formats:
|
791
|
+
#
|
792
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
793
|
+
#
|
794
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
795
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
796
|
+
# @return [String]
|
797
|
+
#
|
786
798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
|
787
799
|
#
|
788
800
|
class CreateDocumentClassifierRequest < Struct.new(
|
@@ -795,7 +807,8 @@ module Aws::Comprehend
|
|
795
807
|
:language_code,
|
796
808
|
:volume_kms_key_id,
|
797
809
|
:vpc_config,
|
798
|
-
:mode
|
810
|
+
:mode,
|
811
|
+
:model_kms_key_id)
|
799
812
|
SENSITIVE = []
|
800
813
|
include Aws::Structure
|
801
814
|
end
|
@@ -827,6 +840,7 @@ module Aws::Comprehend
|
|
827
840
|
# value: "TagValue",
|
828
841
|
# },
|
829
842
|
# ],
|
843
|
+
# data_access_role_arn: "IamRoleArn",
|
830
844
|
# }
|
831
845
|
#
|
832
846
|
# @!attribute [rw] endpoint_name
|
@@ -861,6 +875,13 @@ module Aws::Comprehend
|
|
861
875
|
# indicate its use by the sales department.
|
862
876
|
# @return [Array<Types::Tag>]
|
863
877
|
#
|
878
|
+
# @!attribute [rw] data_access_role_arn
|
879
|
+
# The Amazon Resource Name (ARN) of the AWS identity and Access
|
880
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
881
|
+
# trained custom models encrypted with a customer managed key
|
882
|
+
# (ModelKmsKeyId).
|
883
|
+
# @return [String]
|
884
|
+
#
|
864
885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
|
865
886
|
#
|
866
887
|
class CreateEndpointRequest < Struct.new(
|
@@ -868,7 +889,8 @@ module Aws::Comprehend
|
|
868
889
|
:model_arn,
|
869
890
|
:desired_inference_units,
|
870
891
|
:client_request_token,
|
871
|
-
:tags
|
892
|
+
:tags,
|
893
|
+
:data_access_role_arn)
|
872
894
|
SENSITIVE = []
|
873
895
|
include Aws::Structure
|
874
896
|
end
|
@@ -927,6 +949,7 @@ module Aws::Comprehend
|
|
927
949
|
# security_group_ids: ["SecurityGroupId"], # required
|
928
950
|
# subnets: ["SubnetId"], # required
|
929
951
|
# },
|
952
|
+
# model_kms_key_id: "KmsKeyId",
|
930
953
|
# }
|
931
954
|
#
|
932
955
|
# @!attribute [rw] recognizer_name
|
@@ -993,6 +1016,17 @@ module Aws::Comprehend
|
|
993
1016
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
994
1017
|
# @return [Types::VpcConfig]
|
995
1018
|
#
|
1019
|
+
# @!attribute [rw] model_kms_key_id
|
1020
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
1021
|
+
# Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
|
1022
|
+
# can be either of the following formats
|
1023
|
+
#
|
1024
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1025
|
+
#
|
1026
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
1027
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
996
1030
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
|
997
1031
|
#
|
998
1032
|
class CreateEntityRecognizerRequest < Struct.new(
|
@@ -1003,7 +1037,8 @@ module Aws::Comprehend
|
|
1003
1037
|
:client_request_token,
|
1004
1038
|
:language_code,
|
1005
1039
|
:volume_kms_key_id,
|
1006
|
-
:vpc_config
|
1040
|
+
:vpc_config,
|
1041
|
+
:model_kms_key_id)
|
1007
1042
|
SENSITIVE = []
|
1008
1043
|
include Aws::Structure
|
1009
1044
|
end
|
@@ -1806,6 +1841,19 @@ module Aws::Comprehend
|
|
1806
1841
|
# The identifier assigned to the document classification job.
|
1807
1842
|
# @return [String]
|
1808
1843
|
#
|
1844
|
+
# @!attribute [rw] job_arn
|
1845
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
1846
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
1847
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
1848
|
+
# follows:
|
1849
|
+
#
|
1850
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
1851
|
+
#
|
1852
|
+
# The following is an example job ARN:
|
1853
|
+
#
|
1854
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
1855
|
+
# @return [String]
|
1856
|
+
#
|
1809
1857
|
# @!attribute [rw] job_name
|
1810
1858
|
# The name that you assigned to the document classification job.
|
1811
1859
|
# @return [String]
|
@@ -1875,6 +1923,7 @@ module Aws::Comprehend
|
|
1875
1923
|
#
|
1876
1924
|
class DocumentClassificationJobProperties < Struct.new(
|
1877
1925
|
:job_id,
|
1926
|
+
:job_arn,
|
1878
1927
|
:job_name,
|
1879
1928
|
:job_status,
|
1880
1929
|
:message,
|
@@ -2160,6 +2209,17 @@ module Aws::Comprehend
|
|
2160
2209
|
# mode and this cannot be changed once the classifier is trained.
|
2161
2210
|
# @return [String]
|
2162
2211
|
#
|
2212
|
+
# @!attribute [rw] model_kms_key_id
|
2213
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
2214
|
+
# Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
|
2215
|
+
# can be either of the following formats:
|
2216
|
+
#
|
2217
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2218
|
+
#
|
2219
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
2220
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2221
|
+
# @return [String]
|
2222
|
+
#
|
2163
2223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
2164
2224
|
#
|
2165
2225
|
class DocumentClassifierProperties < Struct.new(
|
@@ -2177,7 +2237,8 @@ module Aws::Comprehend
|
|
2177
2237
|
:data_access_role_arn,
|
2178
2238
|
:volume_kms_key_id,
|
2179
2239
|
:vpc_config,
|
2180
|
-
:mode
|
2240
|
+
:mode,
|
2241
|
+
:model_kms_key_id)
|
2181
2242
|
SENSITIVE = [:classifier_metadata]
|
2182
2243
|
include Aws::Structure
|
2183
2244
|
end
|
@@ -2284,6 +2345,19 @@ module Aws::Comprehend
|
|
2284
2345
|
# The identifier assigned to the dominant language detection job.
|
2285
2346
|
# @return [String]
|
2286
2347
|
#
|
2348
|
+
# @!attribute [rw] job_arn
|
2349
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
2350
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
2351
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
2352
|
+
# ARN is as follows:
|
2353
|
+
#
|
2354
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
2355
|
+
#
|
2356
|
+
# The following is an example job ARN:
|
2357
|
+
#
|
2358
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2359
|
+
# @return [String]
|
2360
|
+
#
|
2287
2361
|
# @!attribute [rw] job_name
|
2288
2362
|
# The name that you assigned to the dominant language detection job.
|
2289
2363
|
# @return [String]
|
@@ -2348,6 +2422,7 @@ module Aws::Comprehend
|
|
2348
2422
|
#
|
2349
2423
|
class DominantLanguageDetectionJobProperties < Struct.new(
|
2350
2424
|
:job_id,
|
2425
|
+
:job_arn,
|
2351
2426
|
:job_name,
|
2352
2427
|
:job_status,
|
2353
2428
|
:message,
|
@@ -2447,6 +2522,13 @@ module Aws::Comprehend
|
|
2447
2522
|
# The date and time that the endpoint was last modified.
|
2448
2523
|
# @return [Time]
|
2449
2524
|
#
|
2525
|
+
# @!attribute [rw] data_access_role_arn
|
2526
|
+
# The Amazon Resource Name (ARN) of the AWS identity and Access
|
2527
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
2528
|
+
# trained custom models encrypted with a customer managed key
|
2529
|
+
# (ModelKmsKeyId).
|
2530
|
+
# @return [String]
|
2531
|
+
#
|
2450
2532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
|
2451
2533
|
#
|
2452
2534
|
class EndpointProperties < Struct.new(
|
@@ -2457,7 +2539,8 @@ module Aws::Comprehend
|
|
2457
2539
|
:desired_inference_units,
|
2458
2540
|
:current_inference_units,
|
2459
2541
|
:creation_time,
|
2460
|
-
:last_modified_time
|
2542
|
+
:last_modified_time,
|
2543
|
+
:data_access_role_arn)
|
2461
2544
|
SENSITIVE = []
|
2462
2545
|
include Aws::Structure
|
2463
2546
|
end
|
@@ -2515,6 +2598,19 @@ module Aws::Comprehend
|
|
2515
2598
|
# The identifier assigned to the entities detection job.
|
2516
2599
|
# @return [String]
|
2517
2600
|
#
|
2601
|
+
# @!attribute [rw] job_arn
|
2602
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
2603
|
+
# a unique, fully qualified identifier for the job. It includes the
|
2604
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
2605
|
+
# follows:
|
2606
|
+
#
|
2607
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
2608
|
+
#
|
2609
|
+
# The following is an example job ARN:
|
2610
|
+
#
|
2611
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2612
|
+
# @return [String]
|
2613
|
+
#
|
2518
2614
|
# @!attribute [rw] job_name
|
2519
2615
|
# The name that you assigned the entities detection job.
|
2520
2616
|
# @return [String]
|
@@ -2587,6 +2683,7 @@ module Aws::Comprehend
|
|
2587
2683
|
#
|
2588
2684
|
class EntitiesDetectionJobProperties < Struct.new(
|
2589
2685
|
:job_id,
|
2686
|
+
:job_arn,
|
2590
2687
|
:job_name,
|
2591
2688
|
:job_status,
|
2592
2689
|
:message,
|
@@ -3050,6 +3147,17 @@ module Aws::Comprehend
|
|
3050
3147
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3051
3148
|
# @return [Types::VpcConfig]
|
3052
3149
|
#
|
3150
|
+
# @!attribute [rw] model_kms_key_id
|
3151
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
3152
|
+
# Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
|
3153
|
+
# can be either of the following formats:
|
3154
|
+
#
|
3155
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3156
|
+
#
|
3157
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
3158
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3159
|
+
# @return [String]
|
3160
|
+
#
|
3053
3161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
|
3054
3162
|
#
|
3055
3163
|
class EntityRecognizerProperties < Struct.new(
|
@@ -3065,7 +3173,8 @@ module Aws::Comprehend
|
|
3065
3173
|
:recognizer_metadata,
|
3066
3174
|
:data_access_role_arn,
|
3067
3175
|
:volume_kms_key_id,
|
3068
|
-
:vpc_config
|
3176
|
+
:vpc_config,
|
3177
|
+
:model_kms_key_id)
|
3069
3178
|
SENSITIVE = [:recognizer_metadata]
|
3070
3179
|
include Aws::Structure
|
3071
3180
|
end
|
@@ -3183,6 +3292,19 @@ module Aws::Comprehend
|
|
3183
3292
|
# The identifier assigned to the events detection job.
|
3184
3293
|
# @return [String]
|
3185
3294
|
#
|
3295
|
+
# @!attribute [rw] job_arn
|
3296
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
3297
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
3298
|
+
# account, Region, and the job ID. The format of the ARN is as
|
3299
|
+
# follows:
|
3300
|
+
#
|
3301
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
3302
|
+
#
|
3303
|
+
# The following is an example job ARN:
|
3304
|
+
#
|
3305
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3306
|
+
# @return [String]
|
3307
|
+
#
|
3186
3308
|
# @!attribute [rw] job_name
|
3187
3309
|
# The name you assigned the events detection job.
|
3188
3310
|
# @return [String]
|
@@ -3231,6 +3353,7 @@ module Aws::Comprehend
|
|
3231
3353
|
#
|
3232
3354
|
class EventsDetectionJobProperties < Struct.new(
|
3233
3355
|
:job_id,
|
3356
|
+
:job_arn,
|
3234
3357
|
:job_name,
|
3235
3358
|
:job_status,
|
3236
3359
|
:message,
|
@@ -3433,6 +3556,19 @@ module Aws::Comprehend
|
|
3433
3556
|
# The identifier assigned to the key phrases detection job.
|
3434
3557
|
# @return [String]
|
3435
3558
|
#
|
3559
|
+
# @!attribute [rw] job_arn
|
3560
|
+
# The Amazon Resource Name (ARN) of the key phrases detection job. It
|
3561
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
3562
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
3563
|
+
# follows:
|
3564
|
+
#
|
3565
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
3566
|
+
#
|
3567
|
+
# The following is an example job ARN:
|
3568
|
+
#
|
3569
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3570
|
+
# @return [String]
|
3571
|
+
#
|
3436
3572
|
# @!attribute [rw] job_name
|
3437
3573
|
# The name that you assigned the key phrases detection job.
|
3438
3574
|
# @return [String]
|
@@ -3500,6 +3636,7 @@ module Aws::Comprehend
|
|
3500
3636
|
#
|
3501
3637
|
class KeyPhrasesDetectionJobProperties < Struct.new(
|
3502
3638
|
:job_id,
|
3639
|
+
:job_arn,
|
3503
3640
|
:job_name,
|
3504
3641
|
:job_status,
|
3505
3642
|
:message,
|
@@ -4309,6 +4446,19 @@ module Aws::Comprehend
|
|
4309
4446
|
# The identifier assigned to the PII entities detection job.
|
4310
4447
|
# @return [String]
|
4311
4448
|
#
|
4449
|
+
# @!attribute [rw] job_arn
|
4450
|
+
# The Amazon Resource Name (ARN) of the PII entities detection job. It
|
4451
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
4452
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
4453
|
+
# follows:
|
4454
|
+
#
|
4455
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
4456
|
+
#
|
4457
|
+
# The following is an example job ARN:
|
4458
|
+
#
|
4459
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
4460
|
+
# @return [String]
|
4461
|
+
#
|
4312
4462
|
# @!attribute [rw] job_name
|
4313
4463
|
# The name that you assigned the PII entities detection job.
|
4314
4464
|
# @return [String]
|
@@ -4366,6 +4516,7 @@ module Aws::Comprehend
|
|
4366
4516
|
#
|
4367
4517
|
class PiiEntitiesDetectionJobProperties < Struct.new(
|
4368
4518
|
:job_id,
|
4519
|
+
:job_arn,
|
4369
4520
|
:job_name,
|
4370
4521
|
:job_status,
|
4371
4522
|
:message,
|
@@ -4587,6 +4738,19 @@ module Aws::Comprehend
|
|
4587
4738
|
# The identifier assigned to the sentiment detection job.
|
4588
4739
|
# @return [String]
|
4589
4740
|
#
|
4741
|
+
# @!attribute [rw] job_arn
|
4742
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
4743
|
+
# a unique, fully qualified identifier for the job. It includes the
|
4744
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
4745
|
+
# follows:
|
4746
|
+
#
|
4747
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
4748
|
+
#
|
4749
|
+
# The following is an example job ARN:
|
4750
|
+
#
|
4751
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
4752
|
+
# @return [String]
|
4753
|
+
#
|
4590
4754
|
# @!attribute [rw] job_name
|
4591
4755
|
# The name that you assigned to the sentiment detection job
|
4592
4756
|
# @return [String]
|
@@ -4654,6 +4818,7 @@ module Aws::Comprehend
|
|
4654
4818
|
#
|
4655
4819
|
class SentimentDetectionJobProperties < Struct.new(
|
4656
4820
|
:job_id,
|
4821
|
+
:job_arn,
|
4657
4822
|
:job_name,
|
4658
4823
|
:job_status,
|
4659
4824
|
:message,
|
@@ -4724,6 +4889,12 @@ module Aws::Comprehend
|
|
4724
4889
|
# security_group_ids: ["SecurityGroupId"], # required
|
4725
4890
|
# subnets: ["SubnetId"], # required
|
4726
4891
|
# },
|
4892
|
+
# tags: [
|
4893
|
+
# {
|
4894
|
+
# key: "TagKey", # required
|
4895
|
+
# value: "TagValue",
|
4896
|
+
# },
|
4897
|
+
# ],
|
4727
4898
|
# }
|
4728
4899
|
#
|
4729
4900
|
# @!attribute [rw] job_name
|
@@ -4779,6 +4950,13 @@ module Aws::Comprehend
|
|
4779
4950
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4780
4951
|
# @return [Types::VpcConfig]
|
4781
4952
|
#
|
4953
|
+
# @!attribute [rw] tags
|
4954
|
+
# Tags to be associated with the document classification job. A tag is
|
4955
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
4956
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
4957
|
+
# added to a resource to indicate its use by the sales department.
|
4958
|
+
# @return [Array<Types::Tag>]
|
4959
|
+
#
|
4782
4960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
|
4783
4961
|
#
|
4784
4962
|
class StartDocumentClassificationJobRequest < Struct.new(
|
@@ -4789,7 +4967,8 @@ module Aws::Comprehend
|
|
4789
4967
|
:data_access_role_arn,
|
4790
4968
|
:client_request_token,
|
4791
4969
|
:volume_kms_key_id,
|
4792
|
-
:vpc_config
|
4970
|
+
:vpc_config,
|
4971
|
+
:tags)
|
4793
4972
|
SENSITIVE = []
|
4794
4973
|
include Aws::Structure
|
4795
4974
|
end
|
@@ -4799,6 +4978,19 @@ module Aws::Comprehend
|
|
4799
4978
|
# use this identifier with the operation.
|
4800
4979
|
# @return [String]
|
4801
4980
|
#
|
4981
|
+
# @!attribute [rw] job_arn
|
4982
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
4983
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
4984
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
4985
|
+
# follows:
|
4986
|
+
#
|
4987
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
4988
|
+
#
|
4989
|
+
# The following is an example job ARN:
|
4990
|
+
#
|
4991
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
4992
|
+
# @return [String]
|
4993
|
+
#
|
4802
4994
|
# @!attribute [rw] job_status
|
4803
4995
|
# The status of the job:
|
4804
4996
|
#
|
@@ -4821,6 +5013,7 @@ module Aws::Comprehend
|
|
4821
5013
|
#
|
4822
5014
|
class StartDocumentClassificationJobResponse < Struct.new(
|
4823
5015
|
:job_id,
|
5016
|
+
:job_arn,
|
4824
5017
|
:job_status)
|
4825
5018
|
SENSITIVE = []
|
4826
5019
|
include Aws::Structure
|
@@ -4846,6 +5039,12 @@ module Aws::Comprehend
|
|
4846
5039
|
# security_group_ids: ["SecurityGroupId"], # required
|
4847
5040
|
# subnets: ["SubnetId"], # required
|
4848
5041
|
# },
|
5042
|
+
# tags: [
|
5043
|
+
# {
|
5044
|
+
# key: "TagKey", # required
|
5045
|
+
# value: "TagValue",
|
5046
|
+
# },
|
5047
|
+
# ],
|
4849
5048
|
# }
|
4850
5049
|
#
|
4851
5050
|
# @!attribute [rw] input_data_config
|
@@ -4901,6 +5100,14 @@ module Aws::Comprehend
|
|
4901
5100
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4902
5101
|
# @return [Types::VpcConfig]
|
4903
5102
|
#
|
5103
|
+
# @!attribute [rw] tags
|
5104
|
+
# Tags to be associated with the dominant language detection job. A
|
5105
|
+
# tag is a key-value pair that adds metadata to a resource used by
|
5106
|
+
# Amazon Comprehend. For example, a tag with "Sales" as the key
|
5107
|
+
# might be added to a resource to indicate its use by the sales
|
5108
|
+
# department.
|
5109
|
+
# @return [Array<Types::Tag>]
|
5110
|
+
#
|
4904
5111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
|
4905
5112
|
#
|
4906
5113
|
class StartDominantLanguageDetectionJobRequest < Struct.new(
|
@@ -4910,7 +5117,8 @@ module Aws::Comprehend
|
|
4910
5117
|
:job_name,
|
4911
5118
|
:client_request_token,
|
4912
5119
|
:volume_kms_key_id,
|
4913
|
-
:vpc_config
|
5120
|
+
:vpc_config,
|
5121
|
+
:tags)
|
4914
5122
|
SENSITIVE = []
|
4915
5123
|
include Aws::Structure
|
4916
5124
|
end
|
@@ -4920,6 +5128,19 @@ module Aws::Comprehend
|
|
4920
5128
|
# use this identifier with the operation.
|
4921
5129
|
# @return [String]
|
4922
5130
|
#
|
5131
|
+
# @!attribute [rw] job_arn
|
5132
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
5133
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
5134
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
5135
|
+
# ARN is as follows:
|
5136
|
+
#
|
5137
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
5138
|
+
#
|
5139
|
+
# The following is an example job ARN:
|
5140
|
+
#
|
5141
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5142
|
+
# @return [String]
|
5143
|
+
#
|
4923
5144
|
# @!attribute [rw] job_status
|
4924
5145
|
# The status of the job.
|
4925
5146
|
#
|
@@ -4939,6 +5160,7 @@ module Aws::Comprehend
|
|
4939
5160
|
#
|
4940
5161
|
class StartDominantLanguageDetectionJobResponse < Struct.new(
|
4941
5162
|
:job_id,
|
5163
|
+
:job_arn,
|
4942
5164
|
:job_status)
|
4943
5165
|
SENSITIVE = []
|
4944
5166
|
include Aws::Structure
|
@@ -4966,6 +5188,12 @@ module Aws::Comprehend
|
|
4966
5188
|
# security_group_ids: ["SecurityGroupId"], # required
|
4967
5189
|
# subnets: ["SubnetId"], # required
|
4968
5190
|
# },
|
5191
|
+
# tags: [
|
5192
|
+
# {
|
5193
|
+
# key: "TagKey", # required
|
5194
|
+
# value: "TagValue",
|
5195
|
+
# },
|
5196
|
+
# ],
|
4969
5197
|
# }
|
4970
5198
|
#
|
4971
5199
|
# @!attribute [rw] input_data_config
|
@@ -5035,6 +5263,13 @@ module Aws::Comprehend
|
|
5035
5263
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5036
5264
|
# @return [Types::VpcConfig]
|
5037
5265
|
#
|
5266
|
+
# @!attribute [rw] tags
|
5267
|
+
# Tags to be associated with the entities detection job. A tag is a
|
5268
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5269
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5270
|
+
# added to a resource to indicate its use by the sales department.
|
5271
|
+
# @return [Array<Types::Tag>]
|
5272
|
+
#
|
5038
5273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
|
5039
5274
|
#
|
5040
5275
|
class StartEntitiesDetectionJobRequest < Struct.new(
|
@@ -5046,7 +5281,8 @@ module Aws::Comprehend
|
|
5046
5281
|
:language_code,
|
5047
5282
|
:client_request_token,
|
5048
5283
|
:volume_kms_key_id,
|
5049
|
-
:vpc_config
|
5284
|
+
:vpc_config,
|
5285
|
+
:tags)
|
5050
5286
|
SENSITIVE = []
|
5051
5287
|
include Aws::Structure
|
5052
5288
|
end
|
@@ -5056,6 +5292,19 @@ module Aws::Comprehend
|
|
5056
5292
|
# this identifier with the operation.
|
5057
5293
|
# @return [String]
|
5058
5294
|
#
|
5295
|
+
# @!attribute [rw] job_arn
|
5296
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
5297
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5298
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5299
|
+
# follows:
|
5300
|
+
#
|
5301
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
5302
|
+
#
|
5303
|
+
# The following is an example job ARN:
|
5304
|
+
#
|
5305
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5306
|
+
# @return [String]
|
5307
|
+
#
|
5059
5308
|
# @!attribute [rw] job_status
|
5060
5309
|
# The status of the job.
|
5061
5310
|
#
|
@@ -5080,6 +5329,7 @@ module Aws::Comprehend
|
|
5080
5329
|
#
|
5081
5330
|
class StartEntitiesDetectionJobResponse < Struct.new(
|
5082
5331
|
:job_id,
|
5332
|
+
:job_arn,
|
5083
5333
|
:job_status)
|
5084
5334
|
SENSITIVE = []
|
5085
5335
|
include Aws::Structure
|
@@ -5102,6 +5352,12 @@ module Aws::Comprehend
|
|
5102
5352
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5103
5353
|
# client_request_token: "ClientRequestTokenString",
|
5104
5354
|
# target_event_types: ["EventTypeString"], # required
|
5355
|
+
# tags: [
|
5356
|
+
# {
|
5357
|
+
# key: "TagKey", # required
|
5358
|
+
# value: "TagValue",
|
5359
|
+
# },
|
5360
|
+
# ],
|
5105
5361
|
# }
|
5106
5362
|
#
|
5107
5363
|
# @!attribute [rw] input_data_config
|
@@ -5138,6 +5394,13 @@ module Aws::Comprehend
|
|
5138
5394
|
# The types of events to detect in the input documents.
|
5139
5395
|
# @return [Array<String>]
|
5140
5396
|
#
|
5397
|
+
# @!attribute [rw] tags
|
5398
|
+
# Tags to be associated with the events detection job. A tag is a
|
5399
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5400
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5401
|
+
# added to a resource to indicate its use by the sales department.
|
5402
|
+
# @return [Array<Types::Tag>]
|
5403
|
+
#
|
5141
5404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5142
5405
|
#
|
5143
5406
|
class StartEventsDetectionJobRequest < Struct.new(
|
@@ -5147,7 +5410,8 @@ module Aws::Comprehend
|
|
5147
5410
|
:job_name,
|
5148
5411
|
:language_code,
|
5149
5412
|
:client_request_token,
|
5150
|
-
:target_event_types
|
5413
|
+
:target_event_types,
|
5414
|
+
:tags)
|
5151
5415
|
SENSITIVE = []
|
5152
5416
|
include Aws::Structure
|
5153
5417
|
end
|
@@ -5157,6 +5421,19 @@ module Aws::Comprehend
|
|
5157
5421
|
# request token, Amazon Comprehend generates one.
|
5158
5422
|
# @return [String]
|
5159
5423
|
#
|
5424
|
+
# @!attribute [rw] job_arn
|
5425
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
5426
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
5427
|
+
# account, Region, and the job ID. The format of the ARN is as
|
5428
|
+
# follows:
|
5429
|
+
#
|
5430
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
5431
|
+
#
|
5432
|
+
# The following is an example job ARN:
|
5433
|
+
#
|
5434
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5435
|
+
# @return [String]
|
5436
|
+
#
|
5160
5437
|
# @!attribute [rw] job_status
|
5161
5438
|
# The status of the events detection job.
|
5162
5439
|
# @return [String]
|
@@ -5165,6 +5442,7 @@ module Aws::Comprehend
|
|
5165
5442
|
#
|
5166
5443
|
class StartEventsDetectionJobResponse < Struct.new(
|
5167
5444
|
:job_id,
|
5445
|
+
:job_arn,
|
5168
5446
|
:job_status)
|
5169
5447
|
SENSITIVE = []
|
5170
5448
|
include Aws::Structure
|
@@ -5191,6 +5469,12 @@ module Aws::Comprehend
|
|
5191
5469
|
# security_group_ids: ["SecurityGroupId"], # required
|
5192
5470
|
# subnets: ["SubnetId"], # required
|
5193
5471
|
# },
|
5472
|
+
# tags: [
|
5473
|
+
# {
|
5474
|
+
# key: "TagKey", # required
|
5475
|
+
# value: "TagValue",
|
5476
|
+
# },
|
5477
|
+
# ],
|
5194
5478
|
# }
|
5195
5479
|
#
|
5196
5480
|
# @!attribute [rw] input_data_config
|
@@ -5252,6 +5536,13 @@ module Aws::Comprehend
|
|
5252
5536
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5253
5537
|
# @return [Types::VpcConfig]
|
5254
5538
|
#
|
5539
|
+
# @!attribute [rw] tags
|
5540
|
+
# Tags to be associated with the key phrases detection job. A tag is a
|
5541
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5542
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5543
|
+
# added to a resource to indicate its use by the sales department.
|
5544
|
+
# @return [Array<Types::Tag>]
|
5545
|
+
#
|
5255
5546
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJobRequest AWS API Documentation
|
5256
5547
|
#
|
5257
5548
|
class StartKeyPhrasesDetectionJobRequest < Struct.new(
|
@@ -5262,7 +5553,8 @@ module Aws::Comprehend
|
|
5262
5553
|
:language_code,
|
5263
5554
|
:client_request_token,
|
5264
5555
|
:volume_kms_key_id,
|
5265
|
-
:vpc_config
|
5556
|
+
:vpc_config,
|
5557
|
+
:tags)
|
5266
5558
|
SENSITIVE = []
|
5267
5559
|
include Aws::Structure
|
5268
5560
|
end
|
@@ -5272,6 +5564,19 @@ module Aws::Comprehend
|
|
5272
5564
|
# use this identifier with the operation.
|
5273
5565
|
# @return [String]
|
5274
5566
|
#
|
5567
|
+
# @!attribute [rw] job_arn
|
5568
|
+
# The Amazon Resource Name (ARN) of the key phrase detection job. It
|
5569
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
5570
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5571
|
+
# follows:
|
5572
|
+
#
|
5573
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
5574
|
+
#
|
5575
|
+
# The following is an example job ARN:
|
5576
|
+
#
|
5577
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5578
|
+
# @return [String]
|
5579
|
+
#
|
5275
5580
|
# @!attribute [rw] job_status
|
5276
5581
|
# The status of the job.
|
5277
5582
|
#
|
@@ -5291,6 +5596,7 @@ module Aws::Comprehend
|
|
5291
5596
|
#
|
5292
5597
|
class StartKeyPhrasesDetectionJobResponse < Struct.new(
|
5293
5598
|
:job_id,
|
5599
|
+
:job_arn,
|
5294
5600
|
:job_status)
|
5295
5601
|
SENSITIVE = []
|
5296
5602
|
include Aws::Structure
|
@@ -5318,6 +5624,12 @@ module Aws::Comprehend
|
|
5318
5624
|
# job_name: "JobName",
|
5319
5625
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5320
5626
|
# client_request_token: "ClientRequestTokenString",
|
5627
|
+
# tags: [
|
5628
|
+
# {
|
5629
|
+
# key: "TagKey", # required
|
5630
|
+
# value: "TagValue",
|
5631
|
+
# },
|
5632
|
+
# ],
|
5321
5633
|
# }
|
5322
5634
|
#
|
5323
5635
|
# @!attribute [rw] input_data_config
|
@@ -5364,6 +5676,13 @@ module Aws::Comprehend
|
|
5364
5676
|
# not need to pass this option.
|
5365
5677
|
# @return [String]
|
5366
5678
|
#
|
5679
|
+
# @!attribute [rw] tags
|
5680
|
+
# Tags to be associated with the PII entities detection job. A tag is
|
5681
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
5682
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5683
|
+
# added to a resource to indicate its use by the sales department.
|
5684
|
+
# @return [Array<Types::Tag>]
|
5685
|
+
#
|
5367
5686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
5368
5687
|
#
|
5369
5688
|
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
@@ -5374,7 +5693,8 @@ module Aws::Comprehend
|
|
5374
5693
|
:data_access_role_arn,
|
5375
5694
|
:job_name,
|
5376
5695
|
:language_code,
|
5377
|
-
:client_request_token
|
5696
|
+
:client_request_token,
|
5697
|
+
:tags)
|
5378
5698
|
SENSITIVE = []
|
5379
5699
|
include Aws::Structure
|
5380
5700
|
end
|
@@ -5383,6 +5703,19 @@ module Aws::Comprehend
|
|
5383
5703
|
# The identifier generated for the job.
|
5384
5704
|
# @return [String]
|
5385
5705
|
#
|
5706
|
+
# @!attribute [rw] job_arn
|
5707
|
+
# The Amazon Resource Name (ARN) of the PII entity detection job. It
|
5708
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
5709
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5710
|
+
# follows:
|
5711
|
+
#
|
5712
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
5713
|
+
#
|
5714
|
+
# The following is an example job ARN:
|
5715
|
+
#
|
5716
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5717
|
+
# @return [String]
|
5718
|
+
#
|
5386
5719
|
# @!attribute [rw] job_status
|
5387
5720
|
# The status of the job.
|
5388
5721
|
# @return [String]
|
@@ -5391,6 +5724,7 @@ module Aws::Comprehend
|
|
5391
5724
|
#
|
5392
5725
|
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
5393
5726
|
:job_id,
|
5727
|
+
:job_arn,
|
5394
5728
|
:job_status)
|
5395
5729
|
SENSITIVE = []
|
5396
5730
|
include Aws::Structure
|
@@ -5417,6 +5751,12 @@ module Aws::Comprehend
|
|
5417
5751
|
# security_group_ids: ["SecurityGroupId"], # required
|
5418
5752
|
# subnets: ["SubnetId"], # required
|
5419
5753
|
# },
|
5754
|
+
# tags: [
|
5755
|
+
# {
|
5756
|
+
# key: "TagKey", # required
|
5757
|
+
# value: "TagValue",
|
5758
|
+
# },
|
5759
|
+
# ],
|
5420
5760
|
# }
|
5421
5761
|
#
|
5422
5762
|
# @!attribute [rw] input_data_config
|
@@ -5478,6 +5818,13 @@ module Aws::Comprehend
|
|
5478
5818
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5479
5819
|
# @return [Types::VpcConfig]
|
5480
5820
|
#
|
5821
|
+
# @!attribute [rw] tags
|
5822
|
+
# Tags to be associated with the sentiment detection job. A tag is a
|
5823
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5824
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5825
|
+
# added to a resource to indicate its use by the sales department.
|
5826
|
+
# @return [Array<Types::Tag>]
|
5827
|
+
#
|
5481
5828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJobRequest AWS API Documentation
|
5482
5829
|
#
|
5483
5830
|
class StartSentimentDetectionJobRequest < Struct.new(
|
@@ -5488,7 +5835,8 @@ module Aws::Comprehend
|
|
5488
5835
|
:language_code,
|
5489
5836
|
:client_request_token,
|
5490
5837
|
:volume_kms_key_id,
|
5491
|
-
:vpc_config
|
5838
|
+
:vpc_config,
|
5839
|
+
:tags)
|
5492
5840
|
SENSITIVE = []
|
5493
5841
|
include Aws::Structure
|
5494
5842
|
end
|
@@ -5498,6 +5846,19 @@ module Aws::Comprehend
|
|
5498
5846
|
# use this identifier with the operation.
|
5499
5847
|
# @return [String]
|
5500
5848
|
#
|
5849
|
+
# @!attribute [rw] job_arn
|
5850
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
5851
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5852
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5853
|
+
# follows:
|
5854
|
+
#
|
5855
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
5856
|
+
#
|
5857
|
+
# The following is an example job ARN:
|
5858
|
+
#
|
5859
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5860
|
+
# @return [String]
|
5861
|
+
#
|
5501
5862
|
# @!attribute [rw] job_status
|
5502
5863
|
# The status of the job.
|
5503
5864
|
#
|
@@ -5517,6 +5878,7 @@ module Aws::Comprehend
|
|
5517
5878
|
#
|
5518
5879
|
class StartSentimentDetectionJobResponse < Struct.new(
|
5519
5880
|
:job_id,
|
5881
|
+
:job_arn,
|
5520
5882
|
:job_status)
|
5521
5883
|
SENSITIVE = []
|
5522
5884
|
include Aws::Structure
|
@@ -5543,6 +5905,12 @@ module Aws::Comprehend
|
|
5543
5905
|
# security_group_ids: ["SecurityGroupId"], # required
|
5544
5906
|
# subnets: ["SubnetId"], # required
|
5545
5907
|
# },
|
5908
|
+
# tags: [
|
5909
|
+
# {
|
5910
|
+
# key: "TagKey", # required
|
5911
|
+
# value: "TagValue",
|
5912
|
+
# },
|
5913
|
+
# ],
|
5546
5914
|
# }
|
5547
5915
|
#
|
5548
5916
|
# @!attribute [rw] input_data_config
|
@@ -5605,6 +5973,13 @@ module Aws::Comprehend
|
|
5605
5973
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5606
5974
|
# @return [Types::VpcConfig]
|
5607
5975
|
#
|
5976
|
+
# @!attribute [rw] tags
|
5977
|
+
# Tags to be associated with the topics detection job. A tag is a
|
5978
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5979
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5980
|
+
# added to a resource to indicate its use by the sales department.
|
5981
|
+
# @return [Array<Types::Tag>]
|
5982
|
+
#
|
5608
5983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJobRequest AWS API Documentation
|
5609
5984
|
#
|
5610
5985
|
class StartTopicsDetectionJobRequest < Struct.new(
|
@@ -5615,7 +5990,8 @@ module Aws::Comprehend
|
|
5615
5990
|
:number_of_topics,
|
5616
5991
|
:client_request_token,
|
5617
5992
|
:volume_kms_key_id,
|
5618
|
-
:vpc_config
|
5993
|
+
:vpc_config,
|
5994
|
+
:tags)
|
5619
5995
|
SENSITIVE = []
|
5620
5996
|
include Aws::Structure
|
5621
5997
|
end
|
@@ -5625,6 +6001,19 @@ module Aws::Comprehend
|
|
5625
6001
|
# use this identifier with the `DescribeTopicDetectionJob` operation.
|
5626
6002
|
# @return [String]
|
5627
6003
|
#
|
6004
|
+
# @!attribute [rw] job_arn
|
6005
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6006
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6007
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6008
|
+
# follows:
|
6009
|
+
#
|
6010
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6011
|
+
#
|
6012
|
+
# The following is an example job ARN:
|
6013
|
+
#
|
6014
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
6015
|
+
# @return [String]
|
6016
|
+
#
|
5628
6017
|
# @!attribute [rw] job_status
|
5629
6018
|
# The status of the job:
|
5630
6019
|
#
|
@@ -5644,6 +6033,7 @@ module Aws::Comprehend
|
|
5644
6033
|
#
|
5645
6034
|
class StartTopicsDetectionJobResponse < Struct.new(
|
5646
6035
|
:job_id,
|
6036
|
+
:job_arn,
|
5647
6037
|
:job_status)
|
5648
6038
|
SENSITIVE = []
|
5649
6039
|
include Aws::Structure
|
@@ -6143,6 +6533,19 @@ module Aws::Comprehend
|
|
6143
6533
|
# The identifier assigned to the topic detection job.
|
6144
6534
|
# @return [String]
|
6145
6535
|
#
|
6536
|
+
# @!attribute [rw] job_arn
|
6537
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6538
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6539
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6540
|
+
# follows:
|
6541
|
+
#
|
6542
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6543
|
+
#
|
6544
|
+
# The following is an example job ARN:
|
6545
|
+
#
|
6546
|
+
# `arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
6547
|
+
# @return [String]
|
6548
|
+
#
|
6146
6549
|
# @!attribute [rw] job_name
|
6147
6550
|
# The name of the topic detection job.
|
6148
6551
|
# @return [String]
|
@@ -6212,6 +6615,7 @@ module Aws::Comprehend
|
|
6212
6615
|
#
|
6213
6616
|
class TopicsDetectionJobProperties < Struct.new(
|
6214
6617
|
:job_id,
|
6618
|
+
:job_arn,
|
6215
6619
|
:job_name,
|
6216
6620
|
:job_status,
|
6217
6621
|
:message,
|