aws-sdk-comprehend 1.45.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e84ed3b91bde0a46d306f27ef576c8d786121dce4ff08bce6eee7ee9cab9a1cc
|
4
|
+
data.tar.gz: fd48e0402e535df6409ef3f873bcb2b602454d11a13cff7c87ba072369282898
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4548e853d136310b906f1ed7026e31ce53615faf3ff65546f4496b1ea7e076026a626e73487caa7d541753039fd28687faca3dffd899079d85da16e7cba57ddb
|
7
|
+
data.tar.gz: 3932323d51c44ba763fabfa26d7beca99900f2848b653ae0c363f69c22b6542126df3902c07fdfe906a81050ba5992fc08eb57f4dc2e62c0525feac39fa6e4b5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.49.0 (2021-08-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add tagging support for Comprehend async inference job.
|
8
|
+
|
9
|
+
1.48.0 (2021-07-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.47.0 (2021-07-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.46.0 (2021-03-31)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Support for customer managed KMS encryption of Comprehend custom models
|
23
|
+
|
4
24
|
1.45.0 (2021-03-11)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.49.0
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -728,6 +728,16 @@ module Aws::Comprehend
|
|
728
728
|
# multiple labels for an individual document are separated by a
|
729
729
|
# delimiter. The default delimiter between labels is a pipe (\|).
|
730
730
|
#
|
731
|
+
# @option params [String] :model_kms_key_id
|
732
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
|
733
|
+
# uses to encrypt trained custom models. The ModelKmsKeyId can be either
|
734
|
+
# of the following formats:
|
735
|
+
#
|
736
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
737
|
+
#
|
738
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
739
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
740
|
+
#
|
731
741
|
# @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
732
742
|
#
|
733
743
|
# * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
|
@@ -766,6 +776,7 @@ module Aws::Comprehend
|
|
766
776
|
# subnets: ["SubnetId"], # required
|
767
777
|
# },
|
768
778
|
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
779
|
+
# model_kms_key_id: "KmsKeyId",
|
769
780
|
# })
|
770
781
|
#
|
771
782
|
# @example Response structure
|
@@ -811,6 +822,12 @@ module Aws::Comprehend
|
|
811
822
|
# "Sales" as the key might be added to an endpoint to indicate its use
|
812
823
|
# by the sales department.
|
813
824
|
#
|
825
|
+
# @option params [String] :data_access_role_arn
|
826
|
+
# The Amazon Resource Name (ARN) of the AWS identity and Access
|
827
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
828
|
+
# trained custom models encrypted with a customer managed key
|
829
|
+
# (ModelKmsKeyId).
|
830
|
+
#
|
814
831
|
# @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
832
|
#
|
816
833
|
# * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
|
@@ -828,6 +845,7 @@ module Aws::Comprehend
|
|
828
845
|
# value: "TagValue",
|
829
846
|
# },
|
830
847
|
# ],
|
848
|
+
# data_access_role_arn: "IamRoleArn",
|
831
849
|
# })
|
832
850
|
#
|
833
851
|
# @example Response structure
|
@@ -902,6 +920,16 @@ module Aws::Comprehend
|
|
902
920
|
#
|
903
921
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
904
922
|
#
|
923
|
+
# @option params [String] :model_kms_key_id
|
924
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
|
925
|
+
# uses to encrypt trained custom models. The ModelKmsKeyId can be either
|
926
|
+
# of the following formats
|
927
|
+
#
|
928
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
929
|
+
#
|
930
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
931
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
932
|
+
#
|
905
933
|
# @return [Types::CreateEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
906
934
|
#
|
907
935
|
# * {Types::CreateEntityRecognizerResponse#entity_recognizer_arn #entity_recognizer_arn} => String
|
@@ -947,6 +975,7 @@ module Aws::Comprehend
|
|
947
975
|
# security_group_ids: ["SecurityGroupId"], # required
|
948
976
|
# subnets: ["SubnetId"], # required
|
949
977
|
# },
|
978
|
+
# model_kms_key_id: "KmsKeyId",
|
950
979
|
# })
|
951
980
|
#
|
952
981
|
# @example Response structure
|
@@ -1069,6 +1098,7 @@ module Aws::Comprehend
|
|
1069
1098
|
# @example Response structure
|
1070
1099
|
#
|
1071
1100
|
# resp.document_classification_job_properties.job_id #=> String
|
1101
|
+
# resp.document_classification_job_properties.job_arn #=> String
|
1072
1102
|
# resp.document_classification_job_properties.job_name #=> String
|
1073
1103
|
# resp.document_classification_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1074
1104
|
# resp.document_classification_job_properties.message #=> String
|
@@ -1148,6 +1178,7 @@ module Aws::Comprehend
|
|
1148
1178
|
# resp.document_classifier_properties.vpc_config.subnets #=> Array
|
1149
1179
|
# resp.document_classifier_properties.vpc_config.subnets[0] #=> String
|
1150
1180
|
# resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
1181
|
+
# resp.document_classifier_properties.model_kms_key_id #=> String
|
1151
1182
|
#
|
1152
1183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1153
1184
|
#
|
@@ -1178,6 +1209,7 @@ module Aws::Comprehend
|
|
1178
1209
|
# @example Response structure
|
1179
1210
|
#
|
1180
1211
|
# resp.dominant_language_detection_job_properties.job_id #=> String
|
1212
|
+
# resp.dominant_language_detection_job_properties.job_arn #=> String
|
1181
1213
|
# resp.dominant_language_detection_job_properties.job_name #=> String
|
1182
1214
|
# resp.dominant_language_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1183
1215
|
# resp.dominant_language_detection_job_properties.message #=> String
|
@@ -1229,6 +1261,7 @@ module Aws::Comprehend
|
|
1229
1261
|
# resp.endpoint_properties.current_inference_units #=> Integer
|
1230
1262
|
# resp.endpoint_properties.creation_time #=> Time
|
1231
1263
|
# resp.endpoint_properties.last_modified_time #=> Time
|
1264
|
+
# resp.endpoint_properties.data_access_role_arn #=> String
|
1232
1265
|
#
|
1233
1266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
|
1234
1267
|
#
|
@@ -1259,6 +1292,7 @@ module Aws::Comprehend
|
|
1259
1292
|
# @example Response structure
|
1260
1293
|
#
|
1261
1294
|
# resp.entities_detection_job_properties.job_id #=> String
|
1295
|
+
# resp.entities_detection_job_properties.job_arn #=> String
|
1262
1296
|
# resp.entities_detection_job_properties.job_name #=> String
|
1263
1297
|
# resp.entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1264
1298
|
# resp.entities_detection_job_properties.message #=> String
|
@@ -1340,6 +1374,7 @@ module Aws::Comprehend
|
|
1340
1374
|
# resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
|
1341
1375
|
# resp.entity_recognizer_properties.vpc_config.subnets #=> Array
|
1342
1376
|
# resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
|
1377
|
+
# resp.entity_recognizer_properties.model_kms_key_id #=> String
|
1343
1378
|
#
|
1344
1379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
1345
1380
|
#
|
@@ -1368,6 +1403,7 @@ module Aws::Comprehend
|
|
1368
1403
|
# @example Response structure
|
1369
1404
|
#
|
1370
1405
|
# resp.events_detection_job_properties.job_id #=> String
|
1406
|
+
# resp.events_detection_job_properties.job_arn #=> String
|
1371
1407
|
# resp.events_detection_job_properties.job_name #=> String
|
1372
1408
|
# resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1373
1409
|
# resp.events_detection_job_properties.message #=> String
|
@@ -1411,6 +1447,7 @@ module Aws::Comprehend
|
|
1411
1447
|
# @example Response structure
|
1412
1448
|
#
|
1413
1449
|
# resp.key_phrases_detection_job_properties.job_id #=> String
|
1450
|
+
# resp.key_phrases_detection_job_properties.job_arn #=> String
|
1414
1451
|
# resp.key_phrases_detection_job_properties.job_name #=> String
|
1415
1452
|
# resp.key_phrases_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1416
1453
|
# resp.key_phrases_detection_job_properties.message #=> String
|
@@ -1457,6 +1494,7 @@ module Aws::Comprehend
|
|
1457
1494
|
# @example Response structure
|
1458
1495
|
#
|
1459
1496
|
# resp.pii_entities_detection_job_properties.job_id #=> String
|
1497
|
+
# resp.pii_entities_detection_job_properties.job_arn #=> String
|
1460
1498
|
# resp.pii_entities_detection_job_properties.job_name #=> String
|
1461
1499
|
# resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1462
1500
|
# resp.pii_entities_detection_job_properties.message #=> String
|
@@ -1503,6 +1541,7 @@ module Aws::Comprehend
|
|
1503
1541
|
# @example Response structure
|
1504
1542
|
#
|
1505
1543
|
# resp.sentiment_detection_job_properties.job_id #=> String
|
1544
|
+
# resp.sentiment_detection_job_properties.job_arn #=> String
|
1506
1545
|
# resp.sentiment_detection_job_properties.job_name #=> String
|
1507
1546
|
# resp.sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1508
1547
|
# resp.sentiment_detection_job_properties.message #=> String
|
@@ -1548,6 +1587,7 @@ module Aws::Comprehend
|
|
1548
1587
|
# @example Response structure
|
1549
1588
|
#
|
1550
1589
|
# resp.topics_detection_job_properties.job_id #=> String
|
1590
|
+
# resp.topics_detection_job_properties.job_arn #=> String
|
1551
1591
|
# resp.topics_detection_job_properties.job_name #=> String
|
1552
1592
|
# resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1553
1593
|
# resp.topics_detection_job_properties.message #=> String
|
@@ -1867,6 +1907,7 @@ module Aws::Comprehend
|
|
1867
1907
|
#
|
1868
1908
|
# resp.document_classification_job_properties_list #=> Array
|
1869
1909
|
# resp.document_classification_job_properties_list[0].job_id #=> String
|
1910
|
+
# resp.document_classification_job_properties_list[0].job_arn #=> String
|
1870
1911
|
# resp.document_classification_job_properties_list[0].job_name #=> String
|
1871
1912
|
# resp.document_classification_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1872
1913
|
# resp.document_classification_job_properties_list[0].message #=> String
|
@@ -1965,6 +2006,7 @@ module Aws::Comprehend
|
|
1965
2006
|
# resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
|
1966
2007
|
# resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
|
1967
2008
|
# resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
2009
|
+
# resp.document_classifier_properties_list[0].model_kms_key_id #=> String
|
1968
2010
|
# resp.next_token #=> String
|
1969
2011
|
#
|
1970
2012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -2015,6 +2057,7 @@ module Aws::Comprehend
|
|
2015
2057
|
#
|
2016
2058
|
# resp.dominant_language_detection_job_properties_list #=> Array
|
2017
2059
|
# resp.dominant_language_detection_job_properties_list[0].job_id #=> String
|
2060
|
+
# resp.dominant_language_detection_job_properties_list[0].job_arn #=> String
|
2018
2061
|
# resp.dominant_language_detection_job_properties_list[0].job_name #=> String
|
2019
2062
|
# resp.dominant_language_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2020
2063
|
# resp.dominant_language_detection_job_properties_list[0].message #=> String
|
@@ -2084,6 +2127,7 @@ module Aws::Comprehend
|
|
2084
2127
|
# resp.endpoint_properties_list[0].current_inference_units #=> Integer
|
2085
2128
|
# resp.endpoint_properties_list[0].creation_time #=> Time
|
2086
2129
|
# resp.endpoint_properties_list[0].last_modified_time #=> Time
|
2130
|
+
# resp.endpoint_properties_list[0].data_access_role_arn #=> String
|
2087
2131
|
# resp.next_token #=> String
|
2088
2132
|
#
|
2089
2133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
|
@@ -2133,6 +2177,7 @@ module Aws::Comprehend
|
|
2133
2177
|
#
|
2134
2178
|
# resp.entities_detection_job_properties_list #=> Array
|
2135
2179
|
# resp.entities_detection_job_properties_list[0].job_id #=> String
|
2180
|
+
# resp.entities_detection_job_properties_list[0].job_arn #=> String
|
2136
2181
|
# resp.entities_detection_job_properties_list[0].job_name #=> String
|
2137
2182
|
# resp.entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2138
2183
|
# resp.entities_detection_job_properties_list[0].message #=> String
|
@@ -2239,6 +2284,7 @@ module Aws::Comprehend
|
|
2239
2284
|
# resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
|
2240
2285
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
|
2241
2286
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
|
2287
|
+
# resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
|
2242
2288
|
# resp.next_token #=> String
|
2243
2289
|
#
|
2244
2290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
@@ -2287,6 +2333,7 @@ module Aws::Comprehend
|
|
2287
2333
|
#
|
2288
2334
|
# resp.events_detection_job_properties_list #=> Array
|
2289
2335
|
# resp.events_detection_job_properties_list[0].job_id #=> String
|
2336
|
+
# resp.events_detection_job_properties_list[0].job_arn #=> String
|
2290
2337
|
# resp.events_detection_job_properties_list[0].job_name #=> String
|
2291
2338
|
# resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2292
2339
|
# resp.events_detection_job_properties_list[0].message #=> String
|
@@ -2349,6 +2396,7 @@ module Aws::Comprehend
|
|
2349
2396
|
#
|
2350
2397
|
# resp.key_phrases_detection_job_properties_list #=> Array
|
2351
2398
|
# resp.key_phrases_detection_job_properties_list[0].job_id #=> String
|
2399
|
+
# resp.key_phrases_detection_job_properties_list[0].job_arn #=> String
|
2352
2400
|
# resp.key_phrases_detection_job_properties_list[0].job_name #=> String
|
2353
2401
|
# resp.key_phrases_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2354
2402
|
# resp.key_phrases_detection_job_properties_list[0].message #=> String
|
@@ -2411,6 +2459,7 @@ module Aws::Comprehend
|
|
2411
2459
|
#
|
2412
2460
|
# resp.pii_entities_detection_job_properties_list #=> Array
|
2413
2461
|
# resp.pii_entities_detection_job_properties_list[0].job_id #=> String
|
2462
|
+
# resp.pii_entities_detection_job_properties_list[0].job_arn #=> String
|
2414
2463
|
# resp.pii_entities_detection_job_properties_list[0].job_name #=> String
|
2415
2464
|
# resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2416
2465
|
# resp.pii_entities_detection_job_properties_list[0].message #=> String
|
@@ -2476,6 +2525,7 @@ module Aws::Comprehend
|
|
2476
2525
|
#
|
2477
2526
|
# resp.sentiment_detection_job_properties_list #=> Array
|
2478
2527
|
# resp.sentiment_detection_job_properties_list[0].job_id #=> String
|
2528
|
+
# resp.sentiment_detection_job_properties_list[0].job_arn #=> String
|
2479
2529
|
# resp.sentiment_detection_job_properties_list[0].job_name #=> String
|
2480
2530
|
# resp.sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2481
2531
|
# resp.sentiment_detection_job_properties_list[0].message #=> String
|
@@ -2574,6 +2624,7 @@ module Aws::Comprehend
|
|
2574
2624
|
#
|
2575
2625
|
# resp.topics_detection_job_properties_list #=> Array
|
2576
2626
|
# resp.topics_detection_job_properties_list[0].job_id #=> String
|
2627
|
+
# resp.topics_detection_job_properties_list[0].job_arn #=> String
|
2577
2628
|
# resp.topics_detection_job_properties_list[0].job_name #=> String
|
2578
2629
|
# resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2579
2630
|
# resp.topics_detection_job_properties_list[0].message #=> String
|
@@ -2649,9 +2700,16 @@ module Aws::Comprehend
|
|
2649
2700
|
#
|
2650
2701
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2651
2702
|
#
|
2703
|
+
# @option params [Array<Types::Tag>] :tags
|
2704
|
+
# Tags to be associated with the document classification job. A tag is a
|
2705
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
2706
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
2707
|
+
# added to a resource to indicate its use by the sales department.
|
2708
|
+
#
|
2652
2709
|
# @return [Types::StartDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2653
2710
|
#
|
2654
2711
|
# * {Types::StartDocumentClassificationJobResponse#job_id #job_id} => String
|
2712
|
+
# * {Types::StartDocumentClassificationJobResponse#job_arn #job_arn} => String
|
2655
2713
|
# * {Types::StartDocumentClassificationJobResponse#job_status #job_status} => String
|
2656
2714
|
#
|
2657
2715
|
# @example Request syntax with placeholder values
|
@@ -2674,11 +2732,18 @@ module Aws::Comprehend
|
|
2674
2732
|
# security_group_ids: ["SecurityGroupId"], # required
|
2675
2733
|
# subnets: ["SubnetId"], # required
|
2676
2734
|
# },
|
2735
|
+
# tags: [
|
2736
|
+
# {
|
2737
|
+
# key: "TagKey", # required
|
2738
|
+
# value: "TagValue",
|
2739
|
+
# },
|
2740
|
+
# ],
|
2677
2741
|
# })
|
2678
2742
|
#
|
2679
2743
|
# @example Response structure
|
2680
2744
|
#
|
2681
2745
|
# resp.job_id #=> String
|
2746
|
+
# resp.job_arn #=> String
|
2682
2747
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2683
2748
|
#
|
2684
2749
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob AWS API Documentation
|
@@ -2740,9 +2805,16 @@ module Aws::Comprehend
|
|
2740
2805
|
#
|
2741
2806
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2742
2807
|
#
|
2808
|
+
# @option params [Array<Types::Tag>] :tags
|
2809
|
+
# Tags to be associated with the dominant language detection job. A tag
|
2810
|
+
# is a key-value pair that adds metadata to a resource used by Amazon
|
2811
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
2812
|
+
# added to a resource to indicate its use by the sales department.
|
2813
|
+
#
|
2743
2814
|
# @return [Types::StartDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2744
2815
|
#
|
2745
2816
|
# * {Types::StartDominantLanguageDetectionJobResponse#job_id #job_id} => String
|
2817
|
+
# * {Types::StartDominantLanguageDetectionJobResponse#job_arn #job_arn} => String
|
2746
2818
|
# * {Types::StartDominantLanguageDetectionJobResponse#job_status #job_status} => String
|
2747
2819
|
#
|
2748
2820
|
# @example Request syntax with placeholder values
|
@@ -2764,11 +2836,18 @@ module Aws::Comprehend
|
|
2764
2836
|
# security_group_ids: ["SecurityGroupId"], # required
|
2765
2837
|
# subnets: ["SubnetId"], # required
|
2766
2838
|
# },
|
2839
|
+
# tags: [
|
2840
|
+
# {
|
2841
|
+
# key: "TagKey", # required
|
2842
|
+
# value: "TagValue",
|
2843
|
+
# },
|
2844
|
+
# ],
|
2767
2845
|
# })
|
2768
2846
|
#
|
2769
2847
|
# @example Response structure
|
2770
2848
|
#
|
2771
2849
|
# resp.job_id #=> String
|
2850
|
+
# resp.job_arn #=> String
|
2772
2851
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2773
2852
|
#
|
2774
2853
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob AWS API Documentation
|
@@ -2845,9 +2924,16 @@ module Aws::Comprehend
|
|
2845
2924
|
#
|
2846
2925
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
2847
2926
|
#
|
2927
|
+
# @option params [Array<Types::Tag>] :tags
|
2928
|
+
# Tags to be associated with the entities detection job. A tag is a
|
2929
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
2930
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
2931
|
+
# added to a resource to indicate its use by the sales department.
|
2932
|
+
#
|
2848
2933
|
# @return [Types::StartEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2849
2934
|
#
|
2850
2935
|
# * {Types::StartEntitiesDetectionJobResponse#job_id #job_id} => String
|
2936
|
+
# * {Types::StartEntitiesDetectionJobResponse#job_arn #job_arn} => String
|
2851
2937
|
# * {Types::StartEntitiesDetectionJobResponse#job_status #job_status} => String
|
2852
2938
|
#
|
2853
2939
|
# @example Request syntax with placeholder values
|
@@ -2871,11 +2957,18 @@ module Aws::Comprehend
|
|
2871
2957
|
# security_group_ids: ["SecurityGroupId"], # required
|
2872
2958
|
# subnets: ["SubnetId"], # required
|
2873
2959
|
# },
|
2960
|
+
# tags: [
|
2961
|
+
# {
|
2962
|
+
# key: "TagKey", # required
|
2963
|
+
# value: "TagValue",
|
2964
|
+
# },
|
2965
|
+
# ],
|
2874
2966
|
# })
|
2875
2967
|
#
|
2876
2968
|
# @example Response structure
|
2877
2969
|
#
|
2878
2970
|
# resp.job_id #=> String
|
2971
|
+
# resp.job_arn #=> String
|
2879
2972
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2880
2973
|
#
|
2881
2974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob AWS API Documentation
|
@@ -2917,9 +3010,16 @@ module Aws::Comprehend
|
|
2917
3010
|
# @option params [required, Array<String>] :target_event_types
|
2918
3011
|
# The types of events to detect in the input documents.
|
2919
3012
|
#
|
3013
|
+
# @option params [Array<Types::Tag>] :tags
|
3014
|
+
# Tags to be associated with the events detection job. A tag is a
|
3015
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3016
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3017
|
+
# added to a resource to indicate its use by the sales department.
|
3018
|
+
#
|
2920
3019
|
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2921
3020
|
#
|
2922
3021
|
# * {Types::StartEventsDetectionJobResponse#job_id #job_id} => String
|
3022
|
+
# * {Types::StartEventsDetectionJobResponse#job_arn #job_arn} => String
|
2923
3023
|
# * {Types::StartEventsDetectionJobResponse#job_status #job_status} => String
|
2924
3024
|
#
|
2925
3025
|
# @example Request syntax with placeholder values
|
@@ -2938,11 +3038,18 @@ module Aws::Comprehend
|
|
2938
3038
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2939
3039
|
# client_request_token: "ClientRequestTokenString",
|
2940
3040
|
# target_event_types: ["EventTypeString"], # required
|
3041
|
+
# tags: [
|
3042
|
+
# {
|
3043
|
+
# key: "TagKey", # required
|
3044
|
+
# value: "TagValue",
|
3045
|
+
# },
|
3046
|
+
# ],
|
2941
3047
|
# })
|
2942
3048
|
#
|
2943
3049
|
# @example Response structure
|
2944
3050
|
#
|
2945
3051
|
# resp.job_id #=> String
|
3052
|
+
# resp.job_arn #=> String
|
2946
3053
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2947
3054
|
#
|
2948
3055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob AWS API Documentation
|
@@ -3008,9 +3115,16 @@ module Aws::Comprehend
|
|
3008
3115
|
#
|
3009
3116
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3010
3117
|
#
|
3118
|
+
# @option params [Array<Types::Tag>] :tags
|
3119
|
+
# Tags to be associated with the key phrases detection job. A tag is a
|
3120
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3121
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3122
|
+
# added to a resource to indicate its use by the sales department.
|
3123
|
+
#
|
3011
3124
|
# @return [Types::StartKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3012
3125
|
#
|
3013
3126
|
# * {Types::StartKeyPhrasesDetectionJobResponse#job_id #job_id} => String
|
3127
|
+
# * {Types::StartKeyPhrasesDetectionJobResponse#job_arn #job_arn} => String
|
3014
3128
|
# * {Types::StartKeyPhrasesDetectionJobResponse#job_status #job_status} => String
|
3015
3129
|
#
|
3016
3130
|
# @example Request syntax with placeholder values
|
@@ -3033,11 +3147,18 @@ module Aws::Comprehend
|
|
3033
3147
|
# security_group_ids: ["SecurityGroupId"], # required
|
3034
3148
|
# subnets: ["SubnetId"], # required
|
3035
3149
|
# },
|
3150
|
+
# tags: [
|
3151
|
+
# {
|
3152
|
+
# key: "TagKey", # required
|
3153
|
+
# value: "TagValue",
|
3154
|
+
# },
|
3155
|
+
# ],
|
3036
3156
|
# })
|
3037
3157
|
#
|
3038
3158
|
# @example Response structure
|
3039
3159
|
#
|
3040
3160
|
# resp.job_id #=> String
|
3161
|
+
# resp.job_arn #=> String
|
3041
3162
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3042
3163
|
#
|
3043
3164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob AWS API Documentation
|
@@ -3088,9 +3209,16 @@ module Aws::Comprehend
|
|
3088
3209
|
# **A suitable default value is auto-generated.** You should normally
|
3089
3210
|
# not need to pass this option.**
|
3090
3211
|
#
|
3212
|
+
# @option params [Array<Types::Tag>] :tags
|
3213
|
+
# Tags to be associated with the PII entities detection job. A tag is a
|
3214
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3215
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3216
|
+
# added to a resource to indicate its use by the sales department.
|
3217
|
+
#
|
3091
3218
|
# @return [Types::StartPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3092
3219
|
#
|
3093
3220
|
# * {Types::StartPiiEntitiesDetectionJobResponse#job_id #job_id} => String
|
3221
|
+
# * {Types::StartPiiEntitiesDetectionJobResponse#job_arn #job_arn} => String
|
3094
3222
|
# * {Types::StartPiiEntitiesDetectionJobResponse#job_status #job_status} => String
|
3095
3223
|
#
|
3096
3224
|
# @example Request syntax with placeholder values
|
@@ -3114,11 +3242,18 @@ module Aws::Comprehend
|
|
3114
3242
|
# job_name: "JobName",
|
3115
3243
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
3116
3244
|
# client_request_token: "ClientRequestTokenString",
|
3245
|
+
# tags: [
|
3246
|
+
# {
|
3247
|
+
# key: "TagKey", # required
|
3248
|
+
# value: "TagValue",
|
3249
|
+
# },
|
3250
|
+
# ],
|
3117
3251
|
# })
|
3118
3252
|
#
|
3119
3253
|
# @example Response structure
|
3120
3254
|
#
|
3121
3255
|
# resp.job_id #=> String
|
3256
|
+
# resp.job_arn #=> String
|
3122
3257
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3123
3258
|
#
|
3124
3259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob AWS API Documentation
|
@@ -3184,9 +3319,16 @@ module Aws::Comprehend
|
|
3184
3319
|
#
|
3185
3320
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3186
3321
|
#
|
3322
|
+
# @option params [Array<Types::Tag>] :tags
|
3323
|
+
# Tags to be associated with the sentiment detection job. A tag is a
|
3324
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3325
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3326
|
+
# added to a resource to indicate its use by the sales department.
|
3327
|
+
#
|
3187
3328
|
# @return [Types::StartSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3188
3329
|
#
|
3189
3330
|
# * {Types::StartSentimentDetectionJobResponse#job_id #job_id} => String
|
3331
|
+
# * {Types::StartSentimentDetectionJobResponse#job_arn #job_arn} => String
|
3190
3332
|
# * {Types::StartSentimentDetectionJobResponse#job_status #job_status} => String
|
3191
3333
|
#
|
3192
3334
|
# @example Request syntax with placeholder values
|
@@ -3209,11 +3351,18 @@ module Aws::Comprehend
|
|
3209
3351
|
# security_group_ids: ["SecurityGroupId"], # required
|
3210
3352
|
# subnets: ["SubnetId"], # required
|
3211
3353
|
# },
|
3354
|
+
# tags: [
|
3355
|
+
# {
|
3356
|
+
# key: "TagKey", # required
|
3357
|
+
# value: "TagValue",
|
3358
|
+
# },
|
3359
|
+
# ],
|
3212
3360
|
# })
|
3213
3361
|
#
|
3214
3362
|
# @example Response structure
|
3215
3363
|
#
|
3216
3364
|
# resp.job_id #=> String
|
3365
|
+
# resp.job_arn #=> String
|
3217
3366
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3218
3367
|
#
|
3219
3368
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob AWS API Documentation
|
@@ -3280,9 +3429,16 @@ module Aws::Comprehend
|
|
3280
3429
|
#
|
3281
3430
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3282
3431
|
#
|
3432
|
+
# @option params [Array<Types::Tag>] :tags
|
3433
|
+
# Tags to be associated with the topics detection job. A tag is a
|
3434
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3435
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
3436
|
+
# added to a resource to indicate its use by the sales department.
|
3437
|
+
#
|
3283
3438
|
# @return [Types::StartTopicsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3284
3439
|
#
|
3285
3440
|
# * {Types::StartTopicsDetectionJobResponse#job_id #job_id} => String
|
3441
|
+
# * {Types::StartTopicsDetectionJobResponse#job_arn #job_arn} => String
|
3286
3442
|
# * {Types::StartTopicsDetectionJobResponse#job_status #job_status} => String
|
3287
3443
|
#
|
3288
3444
|
# @example Request syntax with placeholder values
|
@@ -3305,11 +3461,18 @@ module Aws::Comprehend
|
|
3305
3461
|
# security_group_ids: ["SecurityGroupId"], # required
|
3306
3462
|
# subnets: ["SubnetId"], # required
|
3307
3463
|
# },
|
3464
|
+
# tags: [
|
3465
|
+
# {
|
3466
|
+
# key: "TagKey", # required
|
3467
|
+
# value: "TagValue",
|
3468
|
+
# },
|
3469
|
+
# ],
|
3308
3470
|
# })
|
3309
3471
|
#
|
3310
3472
|
# @example Response structure
|
3311
3473
|
#
|
3312
3474
|
# resp.job_id #=> String
|
3475
|
+
# resp.job_arn #=> String
|
3313
3476
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3314
3477
|
#
|
3315
3478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob AWS API Documentation
|
@@ -3718,7 +3881,7 @@ module Aws::Comprehend
|
|
3718
3881
|
params: params,
|
3719
3882
|
config: config)
|
3720
3883
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3721
|
-
context[:gem_version] = '1.
|
3884
|
+
context[:gem_version] = '1.49.0'
|
3722
3885
|
Seahorse::Client::Request.new(handlers, context)
|
3723
3886
|
end
|
3724
3887
|
|