aws-sdk-comprehend 1.48.0 → 1.52.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/client.rb +392 -3
- data/lib/aws-sdk-comprehend/client_api.rb +143 -1
- data/lib/aws-sdk-comprehend/types.rb +790 -18
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +5 -5
@@ -669,6 +669,13 @@ module Aws::Comprehend
|
|
669
669
|
# @option params [required, String] :document_classifier_name
|
670
670
|
# The name of the document classifier.
|
671
671
|
#
|
672
|
+
# @option params [String] :version_name
|
673
|
+
# The version name given to the newly created classifier. Version names
|
674
|
+
# can have a maximum of 256 characters. Alphanumeric characters, hyphens
|
675
|
+
# (-) and underscores (\_) are allowed. The version name must be unique
|
676
|
+
# among all models with the same classifier name in the account/AWS
|
677
|
+
# Region.
|
678
|
+
#
|
672
679
|
# @option params [required, String] :data_access_role_arn
|
673
680
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
674
681
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -746,6 +753,7 @@ module Aws::Comprehend
|
|
746
753
|
#
|
747
754
|
# resp = client.create_document_classifier({
|
748
755
|
# document_classifier_name: "ComprehendArnName", # required
|
756
|
+
# version_name: "VersionName",
|
749
757
|
# data_access_role_arn: "IamRoleArn", # required
|
750
758
|
# tags: [
|
751
759
|
# {
|
@@ -756,11 +764,16 @@ module Aws::Comprehend
|
|
756
764
|
# input_data_config: { # required
|
757
765
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
758
766
|
# s3_uri: "S3Uri",
|
767
|
+
# test_s3_uri: "S3Uri",
|
759
768
|
# label_delimiter: "LabelDelimiter",
|
760
769
|
# augmented_manifests: [
|
761
770
|
# {
|
762
771
|
# s3_uri: "S3Uri", # required
|
772
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
763
773
|
# attribute_names: ["AttributeNamesListItem"], # required
|
774
|
+
# annotation_data_s3_uri: "S3Uri",
|
775
|
+
# source_documents_s3_uri: "S3Uri",
|
776
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
764
777
|
# },
|
765
778
|
# ],
|
766
779
|
# },
|
@@ -871,6 +884,13 @@ module Aws::Comprehend
|
|
871
884
|
# and underscores (\_) are allowed. The name must be unique in the
|
872
885
|
# account/region.
|
873
886
|
#
|
887
|
+
# @option params [String] :version_name
|
888
|
+
# The version name given to the newly created recognizer. Version names
|
889
|
+
# can be a maximum of 256 characters. Alphanumeric characters, hyphens
|
890
|
+
# (-) and underscores (\_) are allowed. The version name must be unique
|
891
|
+
# among all models with the same recognizer name in the account/ AWS
|
892
|
+
# Region.
|
893
|
+
#
|
874
894
|
# @option params [required, String] :data_access_role_arn
|
875
895
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
876
896
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -938,6 +958,7 @@ module Aws::Comprehend
|
|
938
958
|
#
|
939
959
|
# resp = client.create_entity_recognizer({
|
940
960
|
# recognizer_name: "ComprehendArnName", # required
|
961
|
+
# version_name: "VersionName",
|
941
962
|
# data_access_role_arn: "IamRoleArn", # required
|
942
963
|
# tags: [
|
943
964
|
# {
|
@@ -954,9 +975,12 @@ module Aws::Comprehend
|
|
954
975
|
# ],
|
955
976
|
# documents: {
|
956
977
|
# s3_uri: "S3Uri", # required
|
978
|
+
# test_s3_uri: "S3Uri",
|
979
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
957
980
|
# },
|
958
981
|
# annotations: {
|
959
982
|
# s3_uri: "S3Uri", # required
|
983
|
+
# test_s3_uri: "S3Uri",
|
960
984
|
# },
|
961
985
|
# entity_list: {
|
962
986
|
# s3_uri: "S3Uri", # required
|
@@ -964,7 +988,11 @@ module Aws::Comprehend
|
|
964
988
|
# augmented_manifests: [
|
965
989
|
# {
|
966
990
|
# s3_uri: "S3Uri", # required
|
991
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
967
992
|
# attribute_names: ["AttributeNamesListItem"], # required
|
993
|
+
# annotation_data_s3_uri: "S3Uri",
|
994
|
+
# source_documents_s3_uri: "S3Uri",
|
995
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
968
996
|
# },
|
969
997
|
# ],
|
970
998
|
# },
|
@@ -1098,6 +1126,7 @@ module Aws::Comprehend
|
|
1098
1126
|
# @example Response structure
|
1099
1127
|
#
|
1100
1128
|
# resp.document_classification_job_properties.job_id #=> String
|
1129
|
+
# resp.document_classification_job_properties.job_arn #=> String
|
1101
1130
|
# resp.document_classification_job_properties.job_name #=> String
|
1102
1131
|
# resp.document_classification_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1103
1132
|
# resp.document_classification_job_properties.message #=> String
|
@@ -1106,6 +1135,10 @@ module Aws::Comprehend
|
|
1106
1135
|
# resp.document_classification_job_properties.document_classifier_arn #=> String
|
1107
1136
|
# resp.document_classification_job_properties.input_data_config.s3_uri #=> String
|
1108
1137
|
# resp.document_classification_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1138
|
+
# resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1139
|
+
# resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1140
|
+
# resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1141
|
+
# resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1109
1142
|
# resp.document_classification_job_properties.output_data_config.s3_uri #=> String
|
1110
1143
|
# resp.document_classification_job_properties.output_data_config.kms_key_id #=> String
|
1111
1144
|
# resp.document_classification_job_properties.data_access_role_arn #=> String
|
@@ -1152,11 +1185,16 @@ module Aws::Comprehend
|
|
1152
1185
|
# resp.document_classifier_properties.training_end_time #=> Time
|
1153
1186
|
# resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1154
1187
|
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
1188
|
+
# resp.document_classifier_properties.input_data_config.test_s3_uri #=> String
|
1155
1189
|
# resp.document_classifier_properties.input_data_config.label_delimiter #=> String
|
1156
1190
|
# resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
|
1157
1191
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1192
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
1158
1193
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1159
1194
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1195
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
1196
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
|
1197
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
1160
1198
|
# resp.document_classifier_properties.output_data_config.s3_uri #=> String
|
1161
1199
|
# resp.document_classifier_properties.output_data_config.kms_key_id #=> String
|
1162
1200
|
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
@@ -1178,6 +1216,7 @@ module Aws::Comprehend
|
|
1178
1216
|
# resp.document_classifier_properties.vpc_config.subnets[0] #=> String
|
1179
1217
|
# resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
1180
1218
|
# resp.document_classifier_properties.model_kms_key_id #=> String
|
1219
|
+
# resp.document_classifier_properties.version_name #=> String
|
1181
1220
|
#
|
1182
1221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1183
1222
|
#
|
@@ -1208,6 +1247,7 @@ module Aws::Comprehend
|
|
1208
1247
|
# @example Response structure
|
1209
1248
|
#
|
1210
1249
|
# resp.dominant_language_detection_job_properties.job_id #=> String
|
1250
|
+
# resp.dominant_language_detection_job_properties.job_arn #=> String
|
1211
1251
|
# resp.dominant_language_detection_job_properties.job_name #=> String
|
1212
1252
|
# resp.dominant_language_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1213
1253
|
# resp.dominant_language_detection_job_properties.message #=> String
|
@@ -1215,6 +1255,10 @@ module Aws::Comprehend
|
|
1215
1255
|
# resp.dominant_language_detection_job_properties.end_time #=> Time
|
1216
1256
|
# resp.dominant_language_detection_job_properties.input_data_config.s3_uri #=> String
|
1217
1257
|
# resp.dominant_language_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1258
|
+
# resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1259
|
+
# resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1260
|
+
# resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1261
|
+
# resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1218
1262
|
# resp.dominant_language_detection_job_properties.output_data_config.s3_uri #=> String
|
1219
1263
|
# resp.dominant_language_detection_job_properties.output_data_config.kms_key_id #=> String
|
1220
1264
|
# resp.dominant_language_detection_job_properties.data_access_role_arn #=> String
|
@@ -1255,11 +1299,13 @@ module Aws::Comprehend
|
|
1255
1299
|
# resp.endpoint_properties.status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
|
1256
1300
|
# resp.endpoint_properties.message #=> String
|
1257
1301
|
# resp.endpoint_properties.model_arn #=> String
|
1302
|
+
# resp.endpoint_properties.desired_model_arn #=> String
|
1258
1303
|
# resp.endpoint_properties.desired_inference_units #=> Integer
|
1259
1304
|
# resp.endpoint_properties.current_inference_units #=> Integer
|
1260
1305
|
# resp.endpoint_properties.creation_time #=> Time
|
1261
1306
|
# resp.endpoint_properties.last_modified_time #=> Time
|
1262
1307
|
# resp.endpoint_properties.data_access_role_arn #=> String
|
1308
|
+
# resp.endpoint_properties.desired_data_access_role_arn #=> String
|
1263
1309
|
#
|
1264
1310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
|
1265
1311
|
#
|
@@ -1290,6 +1336,7 @@ module Aws::Comprehend
|
|
1290
1336
|
# @example Response structure
|
1291
1337
|
#
|
1292
1338
|
# resp.entities_detection_job_properties.job_id #=> String
|
1339
|
+
# resp.entities_detection_job_properties.job_arn #=> String
|
1293
1340
|
# resp.entities_detection_job_properties.job_name #=> String
|
1294
1341
|
# resp.entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1295
1342
|
# resp.entities_detection_job_properties.message #=> String
|
@@ -1298,6 +1345,10 @@ module Aws::Comprehend
|
|
1298
1345
|
# resp.entities_detection_job_properties.entity_recognizer_arn #=> String
|
1299
1346
|
# resp.entities_detection_job_properties.input_data_config.s3_uri #=> String
|
1300
1347
|
# resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1348
|
+
# resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1349
|
+
# resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1350
|
+
# resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1351
|
+
# resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1301
1352
|
# resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
|
1302
1353
|
# resp.entities_detection_job_properties.output_data_config.kms_key_id #=> String
|
1303
1354
|
# resp.entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -1348,12 +1399,19 @@ module Aws::Comprehend
|
|
1348
1399
|
# resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
|
1349
1400
|
# resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
|
1350
1401
|
# resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
|
1402
|
+
# resp.entity_recognizer_properties.input_data_config.documents.test_s3_uri #=> String
|
1403
|
+
# resp.entity_recognizer_properties.input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1351
1404
|
# resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
|
1405
|
+
# resp.entity_recognizer_properties.input_data_config.annotations.test_s3_uri #=> String
|
1352
1406
|
# resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
|
1353
1407
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
|
1354
1408
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1409
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
1355
1410
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1356
1411
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1412
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
1413
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
|
1414
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
1357
1415
|
# resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
|
1358
1416
|
# resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
|
1359
1417
|
# resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
|
@@ -1372,6 +1430,7 @@ module Aws::Comprehend
|
|
1372
1430
|
# resp.entity_recognizer_properties.vpc_config.subnets #=> Array
|
1373
1431
|
# resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
|
1374
1432
|
# resp.entity_recognizer_properties.model_kms_key_id #=> String
|
1433
|
+
# resp.entity_recognizer_properties.version_name #=> String
|
1375
1434
|
#
|
1376
1435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
1377
1436
|
#
|
@@ -1400,6 +1459,7 @@ module Aws::Comprehend
|
|
1400
1459
|
# @example Response structure
|
1401
1460
|
#
|
1402
1461
|
# resp.events_detection_job_properties.job_id #=> String
|
1462
|
+
# resp.events_detection_job_properties.job_arn #=> String
|
1403
1463
|
# resp.events_detection_job_properties.job_name #=> String
|
1404
1464
|
# resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1405
1465
|
# resp.events_detection_job_properties.message #=> String
|
@@ -1407,6 +1467,10 @@ module Aws::Comprehend
|
|
1407
1467
|
# resp.events_detection_job_properties.end_time #=> Time
|
1408
1468
|
# resp.events_detection_job_properties.input_data_config.s3_uri #=> String
|
1409
1469
|
# resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1470
|
+
# resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1471
|
+
# resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1472
|
+
# resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1473
|
+
# resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1410
1474
|
# resp.events_detection_job_properties.output_data_config.s3_uri #=> String
|
1411
1475
|
# resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
|
1412
1476
|
# resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -1443,6 +1507,7 @@ module Aws::Comprehend
|
|
1443
1507
|
# @example Response structure
|
1444
1508
|
#
|
1445
1509
|
# resp.key_phrases_detection_job_properties.job_id #=> String
|
1510
|
+
# resp.key_phrases_detection_job_properties.job_arn #=> String
|
1446
1511
|
# resp.key_phrases_detection_job_properties.job_name #=> String
|
1447
1512
|
# resp.key_phrases_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1448
1513
|
# resp.key_phrases_detection_job_properties.message #=> String
|
@@ -1450,6 +1515,10 @@ module Aws::Comprehend
|
|
1450
1515
|
# resp.key_phrases_detection_job_properties.end_time #=> Time
|
1451
1516
|
# resp.key_phrases_detection_job_properties.input_data_config.s3_uri #=> String
|
1452
1517
|
# resp.key_phrases_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1518
|
+
# resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1519
|
+
# resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1520
|
+
# resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1521
|
+
# resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1453
1522
|
# resp.key_phrases_detection_job_properties.output_data_config.s3_uri #=> String
|
1454
1523
|
# resp.key_phrases_detection_job_properties.output_data_config.kms_key_id #=> String
|
1455
1524
|
# resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -1489,6 +1558,7 @@ module Aws::Comprehend
|
|
1489
1558
|
# @example Response structure
|
1490
1559
|
#
|
1491
1560
|
# resp.pii_entities_detection_job_properties.job_id #=> String
|
1561
|
+
# resp.pii_entities_detection_job_properties.job_arn #=> String
|
1492
1562
|
# resp.pii_entities_detection_job_properties.job_name #=> String
|
1493
1563
|
# resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1494
1564
|
# resp.pii_entities_detection_job_properties.message #=> String
|
@@ -1496,6 +1566,10 @@ module Aws::Comprehend
|
|
1496
1566
|
# resp.pii_entities_detection_job_properties.end_time #=> Time
|
1497
1567
|
# resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
|
1498
1568
|
# resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1569
|
+
# resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1570
|
+
# resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1571
|
+
# resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1572
|
+
# resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1499
1573
|
# resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
|
1500
1574
|
# resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
|
1501
1575
|
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
|
@@ -1535,6 +1609,7 @@ module Aws::Comprehend
|
|
1535
1609
|
# @example Response structure
|
1536
1610
|
#
|
1537
1611
|
# resp.sentiment_detection_job_properties.job_id #=> String
|
1612
|
+
# resp.sentiment_detection_job_properties.job_arn #=> String
|
1538
1613
|
# resp.sentiment_detection_job_properties.job_name #=> String
|
1539
1614
|
# resp.sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1540
1615
|
# resp.sentiment_detection_job_properties.message #=> String
|
@@ -1542,6 +1617,10 @@ module Aws::Comprehend
|
|
1542
1617
|
# resp.sentiment_detection_job_properties.end_time #=> Time
|
1543
1618
|
# resp.sentiment_detection_job_properties.input_data_config.s3_uri #=> String
|
1544
1619
|
# resp.sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1620
|
+
# resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1621
|
+
# resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1622
|
+
# resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1623
|
+
# resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1545
1624
|
# resp.sentiment_detection_job_properties.output_data_config.s3_uri #=> String
|
1546
1625
|
# resp.sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
|
1547
1626
|
# resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -1580,6 +1659,7 @@ module Aws::Comprehend
|
|
1580
1659
|
# @example Response structure
|
1581
1660
|
#
|
1582
1661
|
# resp.topics_detection_job_properties.job_id #=> String
|
1662
|
+
# resp.topics_detection_job_properties.job_arn #=> String
|
1583
1663
|
# resp.topics_detection_job_properties.job_name #=> String
|
1584
1664
|
# resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1585
1665
|
# resp.topics_detection_job_properties.message #=> String
|
@@ -1587,6 +1667,10 @@ module Aws::Comprehend
|
|
1587
1667
|
# resp.topics_detection_job_properties.end_time #=> Time
|
1588
1668
|
# resp.topics_detection_job_properties.input_data_config.s3_uri #=> String
|
1589
1669
|
# resp.topics_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1670
|
+
# resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1671
|
+
# resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1672
|
+
# resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
|
1673
|
+
# resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1590
1674
|
# resp.topics_detection_job_properties.output_data_config.s3_uri #=> String
|
1591
1675
|
# resp.topics_detection_job_properties.output_data_config.kms_key_id #=> String
|
1592
1676
|
# resp.topics_detection_job_properties.number_of_topics #=> Integer
|
@@ -1899,6 +1983,7 @@ module Aws::Comprehend
|
|
1899
1983
|
#
|
1900
1984
|
# resp.document_classification_job_properties_list #=> Array
|
1901
1985
|
# resp.document_classification_job_properties_list[0].job_id #=> String
|
1986
|
+
# resp.document_classification_job_properties_list[0].job_arn #=> String
|
1902
1987
|
# resp.document_classification_job_properties_list[0].job_name #=> String
|
1903
1988
|
# resp.document_classification_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1904
1989
|
# resp.document_classification_job_properties_list[0].message #=> String
|
@@ -1907,6 +1992,10 @@ module Aws::Comprehend
|
|
1907
1992
|
# resp.document_classification_job_properties_list[0].document_classifier_arn #=> String
|
1908
1993
|
# resp.document_classification_job_properties_list[0].input_data_config.s3_uri #=> String
|
1909
1994
|
# resp.document_classification_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1995
|
+
# resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
1996
|
+
# resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
1997
|
+
# resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
1998
|
+
# resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
1910
1999
|
# resp.document_classification_job_properties_list[0].output_data_config.s3_uri #=> String
|
1911
2000
|
# resp.document_classification_job_properties_list[0].output_data_config.kms_key_id #=> String
|
1912
2001
|
# resp.document_classification_job_properties_list[0].data_access_role_arn #=> String
|
@@ -1926,6 +2015,49 @@ module Aws::Comprehend
|
|
1926
2015
|
req.send_request(options)
|
1927
2016
|
end
|
1928
2017
|
|
2018
|
+
# Gets a list of summaries of the document classifiers that you have
|
2019
|
+
# created
|
2020
|
+
#
|
2021
|
+
# @option params [String] :next_token
|
2022
|
+
# Identifies the next page of results to return.
|
2023
|
+
#
|
2024
|
+
# @option params [Integer] :max_results
|
2025
|
+
# The maximum number of results to return on each page. The default is
|
2026
|
+
# 100.
|
2027
|
+
#
|
2028
|
+
# @return [Types::ListDocumentClassifierSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2029
|
+
#
|
2030
|
+
# * {Types::ListDocumentClassifierSummariesResponse#document_classifier_summaries_list #document_classifier_summaries_list} => Array<Types::DocumentClassifierSummary>
|
2031
|
+
# * {Types::ListDocumentClassifierSummariesResponse#next_token #next_token} => String
|
2032
|
+
#
|
2033
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2034
|
+
#
|
2035
|
+
# @example Request syntax with placeholder values
|
2036
|
+
#
|
2037
|
+
# resp = client.list_document_classifier_summaries({
|
2038
|
+
# next_token: "String",
|
2039
|
+
# max_results: 1,
|
2040
|
+
# })
|
2041
|
+
#
|
2042
|
+
# @example Response structure
|
2043
|
+
#
|
2044
|
+
# resp.document_classifier_summaries_list #=> Array
|
2045
|
+
# resp.document_classifier_summaries_list[0].document_classifier_name #=> String
|
2046
|
+
# resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
|
2047
|
+
# resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
|
2048
|
+
# resp.document_classifier_summaries_list[0].latest_version_name #=> String
|
2049
|
+
# resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
2050
|
+
# resp.next_token #=> String
|
2051
|
+
#
|
2052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries AWS API Documentation
|
2053
|
+
#
|
2054
|
+
# @overload list_document_classifier_summaries(params = {})
|
2055
|
+
# @param [Hash] params ({})
|
2056
|
+
def list_document_classifier_summaries(params = {}, options = {})
|
2057
|
+
req = build_request(:list_document_classifier_summaries, params)
|
2058
|
+
req.send_request(options)
|
2059
|
+
end
|
2060
|
+
|
1929
2061
|
# Gets a list of the document classifiers that you have created.
|
1930
2062
|
#
|
1931
2063
|
# @option params [Types::DocumentClassifierFilter] :filter
|
@@ -1952,6 +2084,7 @@ module Aws::Comprehend
|
|
1952
2084
|
# resp = client.list_document_classifiers({
|
1953
2085
|
# filter: {
|
1954
2086
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2087
|
+
# document_classifier_name: "ComprehendArnName",
|
1955
2088
|
# submit_time_before: Time.now,
|
1956
2089
|
# submit_time_after: Time.now,
|
1957
2090
|
# },
|
@@ -1972,11 +2105,16 @@ module Aws::Comprehend
|
|
1972
2105
|
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
1973
2106
|
# resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1974
2107
|
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
2108
|
+
# resp.document_classifier_properties_list[0].input_data_config.test_s3_uri #=> String
|
1975
2109
|
# resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
|
1976
2110
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
|
1977
2111
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
2112
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
1978
2113
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1979
2114
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
2115
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
2116
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
|
2117
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
1980
2118
|
# resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
|
1981
2119
|
# resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
|
1982
2120
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
@@ -1998,6 +2136,7 @@ module Aws::Comprehend
|
|
1998
2136
|
# resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
|
1999
2137
|
# resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
2000
2138
|
# resp.document_classifier_properties_list[0].model_kms_key_id #=> String
|
2139
|
+
# resp.document_classifier_properties_list[0].version_name #=> String
|
2001
2140
|
# resp.next_token #=> String
|
2002
2141
|
#
|
2003
2142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -2048,6 +2187,7 @@ module Aws::Comprehend
|
|
2048
2187
|
#
|
2049
2188
|
# resp.dominant_language_detection_job_properties_list #=> Array
|
2050
2189
|
# resp.dominant_language_detection_job_properties_list[0].job_id #=> String
|
2190
|
+
# resp.dominant_language_detection_job_properties_list[0].job_arn #=> String
|
2051
2191
|
# resp.dominant_language_detection_job_properties_list[0].job_name #=> String
|
2052
2192
|
# resp.dominant_language_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2053
2193
|
# resp.dominant_language_detection_job_properties_list[0].message #=> String
|
@@ -2055,6 +2195,10 @@ module Aws::Comprehend
|
|
2055
2195
|
# resp.dominant_language_detection_job_properties_list[0].end_time #=> Time
|
2056
2196
|
# resp.dominant_language_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2057
2197
|
# resp.dominant_language_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2198
|
+
# resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2199
|
+
# resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2200
|
+
# resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2201
|
+
# resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2058
2202
|
# resp.dominant_language_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2059
2203
|
# resp.dominant_language_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2060
2204
|
# resp.dominant_language_detection_job_properties_list[0].data_access_role_arn #=> String
|
@@ -2113,11 +2257,13 @@ module Aws::Comprehend
|
|
2113
2257
|
# resp.endpoint_properties_list[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
|
2114
2258
|
# resp.endpoint_properties_list[0].message #=> String
|
2115
2259
|
# resp.endpoint_properties_list[0].model_arn #=> String
|
2260
|
+
# resp.endpoint_properties_list[0].desired_model_arn #=> String
|
2116
2261
|
# resp.endpoint_properties_list[0].desired_inference_units #=> Integer
|
2117
2262
|
# resp.endpoint_properties_list[0].current_inference_units #=> Integer
|
2118
2263
|
# resp.endpoint_properties_list[0].creation_time #=> Time
|
2119
2264
|
# resp.endpoint_properties_list[0].last_modified_time #=> Time
|
2120
2265
|
# resp.endpoint_properties_list[0].data_access_role_arn #=> String
|
2266
|
+
# resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
|
2121
2267
|
# resp.next_token #=> String
|
2122
2268
|
#
|
2123
2269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
|
@@ -2167,6 +2313,7 @@ module Aws::Comprehend
|
|
2167
2313
|
#
|
2168
2314
|
# resp.entities_detection_job_properties_list #=> Array
|
2169
2315
|
# resp.entities_detection_job_properties_list[0].job_id #=> String
|
2316
|
+
# resp.entities_detection_job_properties_list[0].job_arn #=> String
|
2170
2317
|
# resp.entities_detection_job_properties_list[0].job_name #=> String
|
2171
2318
|
# resp.entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2172
2319
|
# resp.entities_detection_job_properties_list[0].message #=> String
|
@@ -2175,6 +2322,10 @@ module Aws::Comprehend
|
|
2175
2322
|
# resp.entities_detection_job_properties_list[0].entity_recognizer_arn #=> String
|
2176
2323
|
# resp.entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2177
2324
|
# resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2325
|
+
# resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2326
|
+
# resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2327
|
+
# resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2328
|
+
# resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2178
2329
|
# resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2179
2330
|
# resp.entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2180
2331
|
# resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -2195,6 +2346,49 @@ module Aws::Comprehend
|
|
2195
2346
|
req.send_request(options)
|
2196
2347
|
end
|
2197
2348
|
|
2349
|
+
# Gets a list of summaries for the entity recognizers that you have
|
2350
|
+
# created.
|
2351
|
+
#
|
2352
|
+
# @option params [String] :next_token
|
2353
|
+
# Identifies the next page of results to return.
|
2354
|
+
#
|
2355
|
+
# @option params [Integer] :max_results
|
2356
|
+
# The maximum number of results to return on each page. The default is
|
2357
|
+
# 100.
|
2358
|
+
#
|
2359
|
+
# @return [Types::ListEntityRecognizerSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2360
|
+
#
|
2361
|
+
# * {Types::ListEntityRecognizerSummariesResponse#entity_recognizer_summaries_list #entity_recognizer_summaries_list} => Array<Types::EntityRecognizerSummary>
|
2362
|
+
# * {Types::ListEntityRecognizerSummariesResponse#next_token #next_token} => String
|
2363
|
+
#
|
2364
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2365
|
+
#
|
2366
|
+
# @example Request syntax with placeholder values
|
2367
|
+
#
|
2368
|
+
# resp = client.list_entity_recognizer_summaries({
|
2369
|
+
# next_token: "String",
|
2370
|
+
# max_results: 1,
|
2371
|
+
# })
|
2372
|
+
#
|
2373
|
+
# @example Response structure
|
2374
|
+
#
|
2375
|
+
# resp.entity_recognizer_summaries_list #=> Array
|
2376
|
+
# resp.entity_recognizer_summaries_list[0].recognizer_name #=> String
|
2377
|
+
# resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
|
2378
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
|
2379
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
|
2380
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
2381
|
+
# resp.next_token #=> String
|
2382
|
+
#
|
2383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries AWS API Documentation
|
2384
|
+
#
|
2385
|
+
# @overload list_entity_recognizer_summaries(params = {})
|
2386
|
+
# @param [Hash] params ({})
|
2387
|
+
def list_entity_recognizer_summaries(params = {}, options = {})
|
2388
|
+
req = build_request(:list_entity_recognizer_summaries, params)
|
2389
|
+
req.send_request(options)
|
2390
|
+
end
|
2391
|
+
|
2198
2392
|
# Gets a list of the properties of all entity recognizers that you
|
2199
2393
|
# created, including recognizers currently in training. Allows you to
|
2200
2394
|
# filter the list of recognizers based on criteria such as status and
|
@@ -2228,6 +2422,7 @@ module Aws::Comprehend
|
|
2228
2422
|
# resp = client.list_entity_recognizers({
|
2229
2423
|
# filter: {
|
2230
2424
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2425
|
+
# recognizer_name: "ComprehendArnName",
|
2231
2426
|
# submit_time_before: Time.now,
|
2232
2427
|
# submit_time_after: Time.now,
|
2233
2428
|
# },
|
@@ -2250,12 +2445,19 @@ module Aws::Comprehend
|
|
2250
2445
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
|
2251
2446
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
|
2252
2447
|
# resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
|
2448
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.documents.test_s3_uri #=> String
|
2449
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2253
2450
|
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
|
2451
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.test_s3_uri #=> String
|
2254
2452
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
|
2255
2453
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
|
2256
2454
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
2455
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
2257
2456
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
2258
2457
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
2458
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
2459
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
|
2460
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
2259
2461
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
|
2260
2462
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
|
2261
2463
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
|
@@ -2274,6 +2476,7 @@ module Aws::Comprehend
|
|
2274
2476
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
|
2275
2477
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
|
2276
2478
|
# resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
|
2479
|
+
# resp.entity_recognizer_properties_list[0].version_name #=> String
|
2277
2480
|
# resp.next_token #=> String
|
2278
2481
|
#
|
2279
2482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
@@ -2322,6 +2525,7 @@ module Aws::Comprehend
|
|
2322
2525
|
#
|
2323
2526
|
# resp.events_detection_job_properties_list #=> Array
|
2324
2527
|
# resp.events_detection_job_properties_list[0].job_id #=> String
|
2528
|
+
# resp.events_detection_job_properties_list[0].job_arn #=> String
|
2325
2529
|
# resp.events_detection_job_properties_list[0].job_name #=> String
|
2326
2530
|
# resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2327
2531
|
# resp.events_detection_job_properties_list[0].message #=> String
|
@@ -2329,6 +2533,10 @@ module Aws::Comprehend
|
|
2329
2533
|
# resp.events_detection_job_properties_list[0].end_time #=> Time
|
2330
2534
|
# resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2331
2535
|
# resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2536
|
+
# resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2537
|
+
# resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2538
|
+
# resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2539
|
+
# resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2332
2540
|
# resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2333
2541
|
# resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2334
2542
|
# resp.events_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -2384,6 +2592,7 @@ module Aws::Comprehend
|
|
2384
2592
|
#
|
2385
2593
|
# resp.key_phrases_detection_job_properties_list #=> Array
|
2386
2594
|
# resp.key_phrases_detection_job_properties_list[0].job_id #=> String
|
2595
|
+
# resp.key_phrases_detection_job_properties_list[0].job_arn #=> String
|
2387
2596
|
# resp.key_phrases_detection_job_properties_list[0].job_name #=> String
|
2388
2597
|
# resp.key_phrases_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2389
2598
|
# resp.key_phrases_detection_job_properties_list[0].message #=> String
|
@@ -2391,6 +2600,10 @@ module Aws::Comprehend
|
|
2391
2600
|
# resp.key_phrases_detection_job_properties_list[0].end_time #=> Time
|
2392
2601
|
# resp.key_phrases_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2393
2602
|
# resp.key_phrases_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2603
|
+
# resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2604
|
+
# resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2605
|
+
# resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2606
|
+
# resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2394
2607
|
# resp.key_phrases_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2395
2608
|
# resp.key_phrases_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2396
2609
|
# resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -2446,6 +2659,7 @@ module Aws::Comprehend
|
|
2446
2659
|
#
|
2447
2660
|
# resp.pii_entities_detection_job_properties_list #=> Array
|
2448
2661
|
# resp.pii_entities_detection_job_properties_list[0].job_id #=> String
|
2662
|
+
# resp.pii_entities_detection_job_properties_list[0].job_arn #=> String
|
2449
2663
|
# resp.pii_entities_detection_job_properties_list[0].job_name #=> String
|
2450
2664
|
# resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2451
2665
|
# resp.pii_entities_detection_job_properties_list[0].message #=> String
|
@@ -2453,6 +2667,10 @@ module Aws::Comprehend
|
|
2453
2667
|
# resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
|
2454
2668
|
# resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2455
2669
|
# resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2670
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2671
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2672
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2673
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2456
2674
|
# resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2457
2675
|
# resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2458
2676
|
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
|
@@ -2511,6 +2729,7 @@ module Aws::Comprehend
|
|
2511
2729
|
#
|
2512
2730
|
# resp.sentiment_detection_job_properties_list #=> Array
|
2513
2731
|
# resp.sentiment_detection_job_properties_list[0].job_id #=> String
|
2732
|
+
# resp.sentiment_detection_job_properties_list[0].job_arn #=> String
|
2514
2733
|
# resp.sentiment_detection_job_properties_list[0].job_name #=> String
|
2515
2734
|
# resp.sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2516
2735
|
# resp.sentiment_detection_job_properties_list[0].message #=> String
|
@@ -2518,6 +2737,10 @@ module Aws::Comprehend
|
|
2518
2737
|
# resp.sentiment_detection_job_properties_list[0].end_time #=> Time
|
2519
2738
|
# resp.sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2520
2739
|
# resp.sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2740
|
+
# resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2741
|
+
# resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2742
|
+
# resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2743
|
+
# resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2521
2744
|
# resp.sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2522
2745
|
# resp.sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2523
2746
|
# resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -2609,6 +2832,7 @@ module Aws::Comprehend
|
|
2609
2832
|
#
|
2610
2833
|
# resp.topics_detection_job_properties_list #=> Array
|
2611
2834
|
# resp.topics_detection_job_properties_list[0].job_id #=> String
|
2835
|
+
# resp.topics_detection_job_properties_list[0].job_arn #=> String
|
2612
2836
|
# resp.topics_detection_job_properties_list[0].job_name #=> String
|
2613
2837
|
# resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2614
2838
|
# resp.topics_detection_job_properties_list[0].message #=> String
|
@@ -2616,6 +2840,10 @@ module Aws::Comprehend
|
|
2616
2840
|
# resp.topics_detection_job_properties_list[0].end_time #=> Time
|
2617
2841
|
# resp.topics_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2618
2842
|
# resp.topics_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2843
|
+
# resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
|
2844
|
+
# resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
|
2845
|
+
# resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
|
2846
|
+
# resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
|
2619
2847
|
# resp.topics_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2620
2848
|
# resp.topics_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2621
2849
|
# resp.topics_detection_job_properties_list[0].number_of_topics #=> Integer
|
@@ -2684,9 +2912,16 @@ module Aws::Comprehend
|
|
2684
2912
|
#
|
2685
2913
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2686
2914
|
#
|
2915
|
+
# @option params [Array<Types::Tag>] :tags
|
2916
|
+
# Tags to be associated with the document classification job. A tag is a
|
2917
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
2918
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
2919
|
+
# added to a resource to indicate its use by the sales department.
|
2920
|
+
#
|
2687
2921
|
# @return [Types::StartDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2688
2922
|
#
|
2689
2923
|
# * {Types::StartDocumentClassificationJobResponse#job_id #job_id} => String
|
2924
|
+
# * {Types::StartDocumentClassificationJobResponse#job_arn #job_arn} => String
|
2690
2925
|
# * {Types::StartDocumentClassificationJobResponse#job_status #job_status} => String
|
2691
2926
|
#
|
2692
2927
|
# @example Request syntax with placeholder values
|
@@ -2697,6 +2932,11 @@ module Aws::Comprehend
|
|
2697
2932
|
# input_data_config: { # required
|
2698
2933
|
# s3_uri: "S3Uri", # required
|
2699
2934
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2935
|
+
# document_reader_config: {
|
2936
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
2937
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
2938
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
2939
|
+
# },
|
2700
2940
|
# },
|
2701
2941
|
# output_data_config: { # required
|
2702
2942
|
# s3_uri: "S3Uri", # required
|
@@ -2709,11 +2949,18 @@ module Aws::Comprehend
|
|
2709
2949
|
# security_group_ids: ["SecurityGroupId"], # required
|
2710
2950
|
# subnets: ["SubnetId"], # required
|
2711
2951
|
# },
|
2952
|
+
# tags: [
|
2953
|
+
# {
|
2954
|
+
# key: "TagKey", # required
|
2955
|
+
# value: "TagValue",
|
2956
|
+
# },
|
2957
|
+
# ],
|
2712
2958
|
# })
|
2713
2959
|
#
|
2714
2960
|
# @example Response structure
|
2715
2961
|
#
|
2716
2962
|
# resp.job_id #=> String
|
2963
|
+
# resp.job_arn #=> String
|
2717
2964
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2718
2965
|
#
|
2719
2966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob AWS API Documentation
|
@@ -2775,9 +3022,16 @@ module Aws::Comprehend
|
|
2775
3022
|
#
|
2776
3023
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2777
3024
|
#
|
3025
|
+
# @option params [Array<Types::Tag>] :tags
|
3026
|
+
# Tags to be associated with the dominant language detection job. A tag
|
3027
|
+
# is a key-value pair that adds metadata to a resource used by Amazon
|
3028
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3029
|
+
# added to a resource to indicate its use by the sales department.
|
3030
|
+
#
|
2778
3031
|
# @return [Types::StartDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2779
3032
|
#
|
2780
3033
|
# * {Types::StartDominantLanguageDetectionJobResponse#job_id #job_id} => String
|
3034
|
+
# * {Types::StartDominantLanguageDetectionJobResponse#job_arn #job_arn} => String
|
2781
3035
|
# * {Types::StartDominantLanguageDetectionJobResponse#job_status #job_status} => String
|
2782
3036
|
#
|
2783
3037
|
# @example Request syntax with placeholder values
|
@@ -2786,6 +3040,11 @@ module Aws::Comprehend
|
|
2786
3040
|
# input_data_config: { # required
|
2787
3041
|
# s3_uri: "S3Uri", # required
|
2788
3042
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3043
|
+
# document_reader_config: {
|
3044
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3045
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3046
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3047
|
+
# },
|
2789
3048
|
# },
|
2790
3049
|
# output_data_config: { # required
|
2791
3050
|
# s3_uri: "S3Uri", # required
|
@@ -2799,11 +3058,18 @@ module Aws::Comprehend
|
|
2799
3058
|
# security_group_ids: ["SecurityGroupId"], # required
|
2800
3059
|
# subnets: ["SubnetId"], # required
|
2801
3060
|
# },
|
3061
|
+
# tags: [
|
3062
|
+
# {
|
3063
|
+
# key: "TagKey", # required
|
3064
|
+
# value: "TagValue",
|
3065
|
+
# },
|
3066
|
+
# ],
|
2802
3067
|
# })
|
2803
3068
|
#
|
2804
3069
|
# @example Response structure
|
2805
3070
|
#
|
2806
3071
|
# resp.job_id #=> String
|
3072
|
+
# resp.job_arn #=> String
|
2807
3073
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2808
3074
|
#
|
2809
3075
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob AWS API Documentation
|
@@ -2880,9 +3146,16 @@ module Aws::Comprehend
|
|
2880
3146
|
#
|
2881
3147
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2882
3148
|
#
|
3149
|
+
# @option params [Array<Types::Tag>] :tags
|
3150
|
+
# Tags to be associated with the entities detection job. A tag is a
|
3151
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3152
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3153
|
+
# added to a resource to indicate its use by the sales department.
|
3154
|
+
#
|
2883
3155
|
# @return [Types::StartEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2884
3156
|
#
|
2885
3157
|
# * {Types::StartEntitiesDetectionJobResponse#job_id #job_id} => String
|
3158
|
+
# * {Types::StartEntitiesDetectionJobResponse#job_arn #job_arn} => String
|
2886
3159
|
# * {Types::StartEntitiesDetectionJobResponse#job_status #job_status} => String
|
2887
3160
|
#
|
2888
3161
|
# @example Request syntax with placeholder values
|
@@ -2891,6 +3164,11 @@ module Aws::Comprehend
|
|
2891
3164
|
# input_data_config: { # required
|
2892
3165
|
# s3_uri: "S3Uri", # required
|
2893
3166
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3167
|
+
# document_reader_config: {
|
3168
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3169
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3170
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3171
|
+
# },
|
2894
3172
|
# },
|
2895
3173
|
# output_data_config: { # required
|
2896
3174
|
# s3_uri: "S3Uri", # required
|
@@ -2906,11 +3184,18 @@ module Aws::Comprehend
|
|
2906
3184
|
# security_group_ids: ["SecurityGroupId"], # required
|
2907
3185
|
# subnets: ["SubnetId"], # required
|
2908
3186
|
# },
|
3187
|
+
# tags: [
|
3188
|
+
# {
|
3189
|
+
# key: "TagKey", # required
|
3190
|
+
# value: "TagValue",
|
3191
|
+
# },
|
3192
|
+
# ],
|
2909
3193
|
# })
|
2910
3194
|
#
|
2911
3195
|
# @example Response structure
|
2912
3196
|
#
|
2913
3197
|
# resp.job_id #=> String
|
3198
|
+
# resp.job_arn #=> String
|
2914
3199
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2915
3200
|
#
|
2916
3201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob AWS API Documentation
|
@@ -2952,9 +3237,16 @@ module Aws::Comprehend
|
|
2952
3237
|
# @option params [required, Array<String>] :target_event_types
|
2953
3238
|
# The types of events to detect in the input documents.
|
2954
3239
|
#
|
3240
|
+
# @option params [Array<Types::Tag>] :tags
|
3241
|
+
# Tags to be associated with the events detection job. A tag is a
|
3242
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3243
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3244
|
+
# added to a resource to indicate its use by the sales department.
|
3245
|
+
#
|
2955
3246
|
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2956
3247
|
#
|
2957
3248
|
# * {Types::StartEventsDetectionJobResponse#job_id #job_id} => String
|
3249
|
+
# * {Types::StartEventsDetectionJobResponse#job_arn #job_arn} => String
|
2958
3250
|
# * {Types::StartEventsDetectionJobResponse#job_status #job_status} => String
|
2959
3251
|
#
|
2960
3252
|
# @example Request syntax with placeholder values
|
@@ -2963,6 +3255,11 @@ module Aws::Comprehend
|
|
2963
3255
|
# input_data_config: { # required
|
2964
3256
|
# s3_uri: "S3Uri", # required
|
2965
3257
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3258
|
+
# document_reader_config: {
|
3259
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3260
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3261
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3262
|
+
# },
|
2966
3263
|
# },
|
2967
3264
|
# output_data_config: { # required
|
2968
3265
|
# s3_uri: "S3Uri", # required
|
@@ -2973,11 +3270,18 @@ module Aws::Comprehend
|
|
2973
3270
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2974
3271
|
# client_request_token: "ClientRequestTokenString",
|
2975
3272
|
# target_event_types: ["EventTypeString"], # required
|
3273
|
+
# tags: [
|
3274
|
+
# {
|
3275
|
+
# key: "TagKey", # required
|
3276
|
+
# value: "TagValue",
|
3277
|
+
# },
|
3278
|
+
# ],
|
2976
3279
|
# })
|
2977
3280
|
#
|
2978
3281
|
# @example Response structure
|
2979
3282
|
#
|
2980
3283
|
# resp.job_id #=> String
|
3284
|
+
# resp.job_arn #=> String
|
2981
3285
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2982
3286
|
#
|
2983
3287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob AWS API Documentation
|
@@ -3043,9 +3347,16 @@ module Aws::Comprehend
|
|
3043
3347
|
#
|
3044
3348
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3045
3349
|
#
|
3350
|
+
# @option params [Array<Types::Tag>] :tags
|
3351
|
+
# Tags to be associated with the key phrases detection job. A tag is a
|
3352
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3353
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3354
|
+
# added to a resource to indicate its use by the sales department.
|
3355
|
+
#
|
3046
3356
|
# @return [Types::StartKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3047
3357
|
#
|
3048
3358
|
# * {Types::StartKeyPhrasesDetectionJobResponse#job_id #job_id} => String
|
3359
|
+
# * {Types::StartKeyPhrasesDetectionJobResponse#job_arn #job_arn} => String
|
3049
3360
|
# * {Types::StartKeyPhrasesDetectionJobResponse#job_status #job_status} => String
|
3050
3361
|
#
|
3051
3362
|
# @example Request syntax with placeholder values
|
@@ -3054,6 +3365,11 @@ module Aws::Comprehend
|
|
3054
3365
|
# input_data_config: { # required
|
3055
3366
|
# s3_uri: "S3Uri", # required
|
3056
3367
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3368
|
+
# document_reader_config: {
|
3369
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3370
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3371
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3372
|
+
# },
|
3057
3373
|
# },
|
3058
3374
|
# output_data_config: { # required
|
3059
3375
|
# s3_uri: "S3Uri", # required
|
@@ -3068,11 +3384,18 @@ module Aws::Comprehend
|
|
3068
3384
|
# security_group_ids: ["SecurityGroupId"], # required
|
3069
3385
|
# subnets: ["SubnetId"], # required
|
3070
3386
|
# },
|
3387
|
+
# tags: [
|
3388
|
+
# {
|
3389
|
+
# key: "TagKey", # required
|
3390
|
+
# value: "TagValue",
|
3391
|
+
# },
|
3392
|
+
# ],
|
3071
3393
|
# })
|
3072
3394
|
#
|
3073
3395
|
# @example Response structure
|
3074
3396
|
#
|
3075
3397
|
# resp.job_id #=> String
|
3398
|
+
# resp.job_arn #=> String
|
3076
3399
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3077
3400
|
#
|
3078
3401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob AWS API Documentation
|
@@ -3123,9 +3446,16 @@ module Aws::Comprehend
|
|
3123
3446
|
# **A suitable default value is auto-generated.** You should normally
|
3124
3447
|
# not need to pass this option.**
|
3125
3448
|
#
|
3449
|
+
# @option params [Array<Types::Tag>] :tags
|
3450
|
+
# Tags to be associated with the PII entities detection job. A tag is a
|
3451
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3452
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3453
|
+
# added to a resource to indicate its use by the sales department.
|
3454
|
+
#
|
3126
3455
|
# @return [Types::StartPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3127
3456
|
#
|
3128
3457
|
# * {Types::StartPiiEntitiesDetectionJobResponse#job_id #job_id} => String
|
3458
|
+
# * {Types::StartPiiEntitiesDetectionJobResponse#job_arn #job_arn} => String
|
3129
3459
|
# * {Types::StartPiiEntitiesDetectionJobResponse#job_status #job_status} => String
|
3130
3460
|
#
|
3131
3461
|
# @example Request syntax with placeholder values
|
@@ -3134,6 +3464,11 @@ module Aws::Comprehend
|
|
3134
3464
|
# input_data_config: { # required
|
3135
3465
|
# s3_uri: "S3Uri", # required
|
3136
3466
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3467
|
+
# document_reader_config: {
|
3468
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3469
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3470
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3471
|
+
# },
|
3137
3472
|
# },
|
3138
3473
|
# output_data_config: { # required
|
3139
3474
|
# s3_uri: "S3Uri", # required
|
@@ -3149,11 +3484,18 @@ module Aws::Comprehend
|
|
3149
3484
|
# job_name: "JobName",
|
3150
3485
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
3151
3486
|
# client_request_token: "ClientRequestTokenString",
|
3487
|
+
# tags: [
|
3488
|
+
# {
|
3489
|
+
# key: "TagKey", # required
|
3490
|
+
# value: "TagValue",
|
3491
|
+
# },
|
3492
|
+
# ],
|
3152
3493
|
# })
|
3153
3494
|
#
|
3154
3495
|
# @example Response structure
|
3155
3496
|
#
|
3156
3497
|
# resp.job_id #=> String
|
3498
|
+
# resp.job_arn #=> String
|
3157
3499
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3158
3500
|
#
|
3159
3501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob AWS API Documentation
|
@@ -3219,9 +3561,16 @@ module Aws::Comprehend
|
|
3219
3561
|
#
|
3220
3562
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3221
3563
|
#
|
3564
|
+
# @option params [Array<Types::Tag>] :tags
|
3565
|
+
# Tags to be associated with the sentiment detection job. A tag is a
|
3566
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3567
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3568
|
+
# added to a resource to indicate its use by the sales department.
|
3569
|
+
#
|
3222
3570
|
# @return [Types::StartSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3223
3571
|
#
|
3224
3572
|
# * {Types::StartSentimentDetectionJobResponse#job_id #job_id} => String
|
3573
|
+
# * {Types::StartSentimentDetectionJobResponse#job_arn #job_arn} => String
|
3225
3574
|
# * {Types::StartSentimentDetectionJobResponse#job_status #job_status} => String
|
3226
3575
|
#
|
3227
3576
|
# @example Request syntax with placeholder values
|
@@ -3230,6 +3579,11 @@ module Aws::Comprehend
|
|
3230
3579
|
# input_data_config: { # required
|
3231
3580
|
# s3_uri: "S3Uri", # required
|
3232
3581
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3582
|
+
# document_reader_config: {
|
3583
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3584
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3585
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3586
|
+
# },
|
3233
3587
|
# },
|
3234
3588
|
# output_data_config: { # required
|
3235
3589
|
# s3_uri: "S3Uri", # required
|
@@ -3244,11 +3598,18 @@ module Aws::Comprehend
|
|
3244
3598
|
# security_group_ids: ["SecurityGroupId"], # required
|
3245
3599
|
# subnets: ["SubnetId"], # required
|
3246
3600
|
# },
|
3601
|
+
# tags: [
|
3602
|
+
# {
|
3603
|
+
# key: "TagKey", # required
|
3604
|
+
# value: "TagValue",
|
3605
|
+
# },
|
3606
|
+
# ],
|
3247
3607
|
# })
|
3248
3608
|
#
|
3249
3609
|
# @example Response structure
|
3250
3610
|
#
|
3251
3611
|
# resp.job_id #=> String
|
3612
|
+
# resp.job_arn #=> String
|
3252
3613
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3253
3614
|
#
|
3254
3615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob AWS API Documentation
|
@@ -3315,9 +3676,16 @@ module Aws::Comprehend
|
|
3315
3676
|
#
|
3316
3677
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3317
3678
|
#
|
3679
|
+
# @option params [Array<Types::Tag>] :tags
|
3680
|
+
# Tags to be associated with the topics detection job. A tag is a
|
3681
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3682
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3683
|
+
# added to a resource to indicate its use by the sales department.
|
3684
|
+
#
|
3318
3685
|
# @return [Types::StartTopicsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3319
3686
|
#
|
3320
3687
|
# * {Types::StartTopicsDetectionJobResponse#job_id #job_id} => String
|
3688
|
+
# * {Types::StartTopicsDetectionJobResponse#job_arn #job_arn} => String
|
3321
3689
|
# * {Types::StartTopicsDetectionJobResponse#job_status #job_status} => String
|
3322
3690
|
#
|
3323
3691
|
# @example Request syntax with placeholder values
|
@@ -3326,6 +3694,11 @@ module Aws::Comprehend
|
|
3326
3694
|
# input_data_config: { # required
|
3327
3695
|
# s3_uri: "S3Uri", # required
|
3328
3696
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3697
|
+
# document_reader_config: {
|
3698
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3699
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3700
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3701
|
+
# },
|
3329
3702
|
# },
|
3330
3703
|
# output_data_config: { # required
|
3331
3704
|
# s3_uri: "S3Uri", # required
|
@@ -3340,11 +3713,18 @@ module Aws::Comprehend
|
|
3340
3713
|
# security_group_ids: ["SecurityGroupId"], # required
|
3341
3714
|
# subnets: ["SubnetId"], # required
|
3342
3715
|
# },
|
3716
|
+
# tags: [
|
3717
|
+
# {
|
3718
|
+
# key: "TagKey", # required
|
3719
|
+
# value: "TagValue",
|
3720
|
+
# },
|
3721
|
+
# ],
|
3343
3722
|
# })
|
3344
3723
|
#
|
3345
3724
|
# @example Response structure
|
3346
3725
|
#
|
3347
3726
|
# resp.job_id #=> String
|
3727
|
+
# resp.job_arn #=> String
|
3348
3728
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3349
3729
|
#
|
3350
3730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob AWS API Documentation
|
@@ -3717,18 +4097,27 @@ module Aws::Comprehend
|
|
3717
4097
|
# @option params [required, String] :endpoint_arn
|
3718
4098
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
3719
4099
|
#
|
3720
|
-
# @option params [
|
4100
|
+
# @option params [String] :desired_model_arn
|
4101
|
+
# The ARN of the new model to use when updating an existing endpoint.
|
4102
|
+
#
|
4103
|
+
# @option params [Integer] :desired_inference_units
|
3721
4104
|
# The desired number of inference units to be used by the model using
|
3722
4105
|
# this endpoint. Each inference unit represents of a throughput of 100
|
3723
4106
|
# characters per second.
|
3724
4107
|
#
|
4108
|
+
# @option params [String] :desired_data_access_role_arn
|
4109
|
+
# Data access role ARN to use in case the new model is encrypted with a
|
4110
|
+
# customer CMK.
|
4111
|
+
#
|
3725
4112
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3726
4113
|
#
|
3727
4114
|
# @example Request syntax with placeholder values
|
3728
4115
|
#
|
3729
4116
|
# resp = client.update_endpoint({
|
3730
4117
|
# endpoint_arn: "ComprehendEndpointArn", # required
|
3731
|
-
#
|
4118
|
+
# desired_model_arn: "ComprehendModelArn",
|
4119
|
+
# desired_inference_units: 1,
|
4120
|
+
# desired_data_access_role_arn: "IamRoleArn",
|
3732
4121
|
# })
|
3733
4122
|
#
|
3734
4123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint AWS API Documentation
|
@@ -3753,7 +4142,7 @@ module Aws::Comprehend
|
|
3753
4142
|
params: params,
|
3754
4143
|
config: config)
|
3755
4144
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3756
|
-
context[:gem_version] = '1.
|
4145
|
+
context[:gem_version] = '1.52.0'
|
3757
4146
|
Seahorse::Client::Request.new(handlers, context)
|
3758
4147
|
end
|
3759
4148
|
|