aws-sdk-comprehend 1.41.0 → 1.46.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 +248 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-comprehend.rb +2 -2
- data/lib/aws-sdk-comprehend/client.rb +274 -2
- data/lib/aws-sdk-comprehend/client_api.rb +160 -1
- data/lib/aws-sdk-comprehend/errors.rb +1 -1
- data/lib/aws-sdk-comprehend/resource.rb +1 -1
- data/lib/aws-sdk-comprehend/types.rb +467 -20
- metadata +10 -7
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.46.0
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::Comprehend
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.46.0'
|
52
52
|
|
53
53
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -621,6 +621,44 @@ module Aws::Comprehend
|
|
621
621
|
req.send_request(options)
|
622
622
|
end
|
623
623
|
|
624
|
+
# Analyzes input text for the presence of personally identifiable
|
625
|
+
# information (PII) and returns the labels of identified PII entity
|
626
|
+
# types such as name, address, bank account number, or phone number.
|
627
|
+
#
|
628
|
+
# @option params [required, String] :text
|
629
|
+
# Creates a new document classification request to analyze a single
|
630
|
+
# document in real-time, returning personally identifiable information
|
631
|
+
# (PII) entity labels.
|
632
|
+
#
|
633
|
+
# @option params [required, String] :language_code
|
634
|
+
# The language of the input documents.
|
635
|
+
#
|
636
|
+
# @return [Types::ContainsPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
637
|
+
#
|
638
|
+
# * {Types::ContainsPiiEntitiesResponse#labels #labels} => Array<Types::EntityLabel>
|
639
|
+
#
|
640
|
+
# @example Request syntax with placeholder values
|
641
|
+
#
|
642
|
+
# resp = client.contains_pii_entities({
|
643
|
+
# text: "String", # required
|
644
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
645
|
+
# })
|
646
|
+
#
|
647
|
+
# @example Response structure
|
648
|
+
#
|
649
|
+
# resp.labels #=> Array
|
650
|
+
# resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
651
|
+
# resp.labels[0].score #=> Float
|
652
|
+
#
|
653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities AWS API Documentation
|
654
|
+
#
|
655
|
+
# @overload contains_pii_entities(params = {})
|
656
|
+
# @param [Hash] params ({})
|
657
|
+
def contains_pii_entities(params = {}, options = {})
|
658
|
+
req = build_request(:contains_pii_entities, params)
|
659
|
+
req.send_request(options)
|
660
|
+
end
|
661
|
+
|
624
662
|
# Creates a new document classifier that you can use to categorize
|
625
663
|
# documents. To create a classifier, you provide a set of training
|
626
664
|
# documents that labeled with the categories that you want to use. After
|
@@ -690,6 +728,16 @@ module Aws::Comprehend
|
|
690
728
|
# multiple labels for an individual document are separated by a
|
691
729
|
# delimiter. The default delimiter between labels is a pipe (\|).
|
692
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
|
+
#
|
693
741
|
# @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
694
742
|
#
|
695
743
|
# * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
|
@@ -728,6 +776,7 @@ module Aws::Comprehend
|
|
728
776
|
# subnets: ["SubnetId"], # required
|
729
777
|
# },
|
730
778
|
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
779
|
+
# model_kms_key_id: "KmsKeyId",
|
731
780
|
# })
|
732
781
|
#
|
733
782
|
# @example Response structure
|
@@ -773,6 +822,12 @@ module Aws::Comprehend
|
|
773
822
|
# "Sales" as the key might be added to an endpoint to indicate its use
|
774
823
|
# by the sales department.
|
775
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
|
+
#
|
776
831
|
# @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
777
832
|
#
|
778
833
|
# * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
|
@@ -790,6 +845,7 @@ module Aws::Comprehend
|
|
790
845
|
# value: "TagValue",
|
791
846
|
# },
|
792
847
|
# ],
|
848
|
+
# data_access_role_arn: "IamRoleArn",
|
793
849
|
# })
|
794
850
|
#
|
795
851
|
# @example Response structure
|
@@ -864,6 +920,16 @@ module Aws::Comprehend
|
|
864
920
|
#
|
865
921
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
866
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
|
+
#
|
867
933
|
# @return [Types::CreateEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
868
934
|
#
|
869
935
|
# * {Types::CreateEntityRecognizerResponse#entity_recognizer_arn #entity_recognizer_arn} => String
|
@@ -909,6 +975,7 @@ module Aws::Comprehend
|
|
909
975
|
# security_group_ids: ["SecurityGroupId"], # required
|
910
976
|
# subnets: ["SubnetId"], # required
|
911
977
|
# },
|
978
|
+
# model_kms_key_id: "KmsKeyId",
|
912
979
|
# })
|
913
980
|
#
|
914
981
|
# @example Response structure
|
@@ -1110,6 +1177,7 @@ module Aws::Comprehend
|
|
1110
1177
|
# resp.document_classifier_properties.vpc_config.subnets #=> Array
|
1111
1178
|
# resp.document_classifier_properties.vpc_config.subnets[0] #=> String
|
1112
1179
|
# resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
1180
|
+
# resp.document_classifier_properties.model_kms_key_id #=> String
|
1113
1181
|
#
|
1114
1182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1115
1183
|
#
|
@@ -1191,6 +1259,7 @@ module Aws::Comprehend
|
|
1191
1259
|
# resp.endpoint_properties.current_inference_units #=> Integer
|
1192
1260
|
# resp.endpoint_properties.creation_time #=> Time
|
1193
1261
|
# resp.endpoint_properties.last_modified_time #=> Time
|
1262
|
+
# resp.endpoint_properties.data_access_role_arn #=> String
|
1194
1263
|
#
|
1195
1264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
|
1196
1265
|
#
|
@@ -1302,6 +1371,7 @@ module Aws::Comprehend
|
|
1302
1371
|
# resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
|
1303
1372
|
# resp.entity_recognizer_properties.vpc_config.subnets #=> Array
|
1304
1373
|
# resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
|
1374
|
+
# resp.entity_recognizer_properties.model_kms_key_id #=> String
|
1305
1375
|
#
|
1306
1376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
1307
1377
|
#
|
@@ -1312,6 +1382,47 @@ module Aws::Comprehend
|
|
1312
1382
|
req.send_request(options)
|
1313
1383
|
end
|
1314
1384
|
|
1385
|
+
# Gets the status and details of an events detection job.
|
1386
|
+
#
|
1387
|
+
# @option params [required, String] :job_id
|
1388
|
+
# The identifier of the events detection job.
|
1389
|
+
#
|
1390
|
+
# @return [Types::DescribeEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
|
+
#
|
1392
|
+
# * {Types::DescribeEventsDetectionJobResponse#events_detection_job_properties #events_detection_job_properties} => Types::EventsDetectionJobProperties
|
1393
|
+
#
|
1394
|
+
# @example Request syntax with placeholder values
|
1395
|
+
#
|
1396
|
+
# resp = client.describe_events_detection_job({
|
1397
|
+
# job_id: "JobId", # required
|
1398
|
+
# })
|
1399
|
+
#
|
1400
|
+
# @example Response structure
|
1401
|
+
#
|
1402
|
+
# resp.events_detection_job_properties.job_id #=> String
|
1403
|
+
# resp.events_detection_job_properties.job_name #=> String
|
1404
|
+
# resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1405
|
+
# resp.events_detection_job_properties.message #=> String
|
1406
|
+
# resp.events_detection_job_properties.submit_time #=> Time
|
1407
|
+
# resp.events_detection_job_properties.end_time #=> Time
|
1408
|
+
# resp.events_detection_job_properties.input_data_config.s3_uri #=> String
|
1409
|
+
# resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1410
|
+
# resp.events_detection_job_properties.output_data_config.s3_uri #=> String
|
1411
|
+
# resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
|
1412
|
+
# resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1413
|
+
# resp.events_detection_job_properties.data_access_role_arn #=> String
|
1414
|
+
# resp.events_detection_job_properties.target_event_types #=> Array
|
1415
|
+
# resp.events_detection_job_properties.target_event_types[0] #=> String
|
1416
|
+
#
|
1417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob AWS API Documentation
|
1418
|
+
#
|
1419
|
+
# @overload describe_events_detection_job(params = {})
|
1420
|
+
# @param [Hash] params ({})
|
1421
|
+
def describe_events_detection_job(params = {}, options = {})
|
1422
|
+
req = build_request(:describe_events_detection_job, params)
|
1423
|
+
req.send_request(options)
|
1424
|
+
end
|
1425
|
+
|
1315
1426
|
# Gets the properties associated with a key phrases detection job. Use
|
1316
1427
|
# this operation to get the status of a detection job.
|
1317
1428
|
#
|
@@ -1886,6 +1997,7 @@ module Aws::Comprehend
|
|
1886
1997
|
# resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
|
1887
1998
|
# resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
|
1888
1999
|
# resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
2000
|
+
# resp.document_classifier_properties_list[0].model_kms_key_id #=> String
|
1889
2001
|
# resp.next_token #=> String
|
1890
2002
|
#
|
1891
2003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -2005,6 +2117,7 @@ module Aws::Comprehend
|
|
2005
2117
|
# resp.endpoint_properties_list[0].current_inference_units #=> Integer
|
2006
2118
|
# resp.endpoint_properties_list[0].creation_time #=> Time
|
2007
2119
|
# resp.endpoint_properties_list[0].last_modified_time #=> Time
|
2120
|
+
# resp.endpoint_properties_list[0].data_access_role_arn #=> String
|
2008
2121
|
# resp.next_token #=> String
|
2009
2122
|
#
|
2010
2123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
|
@@ -2160,6 +2273,7 @@ module Aws::Comprehend
|
|
2160
2273
|
# resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
|
2161
2274
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
|
2162
2275
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
|
2276
|
+
# resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
|
2163
2277
|
# resp.next_token #=> String
|
2164
2278
|
#
|
2165
2279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
@@ -2171,6 +2285,67 @@ module Aws::Comprehend
|
|
2171
2285
|
req.send_request(options)
|
2172
2286
|
end
|
2173
2287
|
|
2288
|
+
# Gets a list of the events detection jobs that you have submitted.
|
2289
|
+
#
|
2290
|
+
# @option params [Types::EventsDetectionJobFilter] :filter
|
2291
|
+
# Filters the jobs that are returned. You can filter jobs on their name,
|
2292
|
+
# status, or the date and time that they were submitted. You can only
|
2293
|
+
# set one filter at a time.
|
2294
|
+
#
|
2295
|
+
# @option params [String] :next_token
|
2296
|
+
# Identifies the next page of results to return.
|
2297
|
+
#
|
2298
|
+
# @option params [Integer] :max_results
|
2299
|
+
# The maximum number of results to return in each page.
|
2300
|
+
#
|
2301
|
+
# @return [Types::ListEventsDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2302
|
+
#
|
2303
|
+
# * {Types::ListEventsDetectionJobsResponse#events_detection_job_properties_list #events_detection_job_properties_list} => Array<Types::EventsDetectionJobProperties>
|
2304
|
+
# * {Types::ListEventsDetectionJobsResponse#next_token #next_token} => String
|
2305
|
+
#
|
2306
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2307
|
+
#
|
2308
|
+
# @example Request syntax with placeholder values
|
2309
|
+
#
|
2310
|
+
# resp = client.list_events_detection_jobs({
|
2311
|
+
# filter: {
|
2312
|
+
# job_name: "JobName",
|
2313
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
2314
|
+
# submit_time_before: Time.now,
|
2315
|
+
# submit_time_after: Time.now,
|
2316
|
+
# },
|
2317
|
+
# next_token: "String",
|
2318
|
+
# max_results: 1,
|
2319
|
+
# })
|
2320
|
+
#
|
2321
|
+
# @example Response structure
|
2322
|
+
#
|
2323
|
+
# resp.events_detection_job_properties_list #=> Array
|
2324
|
+
# resp.events_detection_job_properties_list[0].job_id #=> String
|
2325
|
+
# resp.events_detection_job_properties_list[0].job_name #=> String
|
2326
|
+
# resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2327
|
+
# resp.events_detection_job_properties_list[0].message #=> String
|
2328
|
+
# resp.events_detection_job_properties_list[0].submit_time #=> Time
|
2329
|
+
# resp.events_detection_job_properties_list[0].end_time #=> Time
|
2330
|
+
# resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2331
|
+
# resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2332
|
+
# resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2333
|
+
# resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2334
|
+
# 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"
|
2335
|
+
# resp.events_detection_job_properties_list[0].data_access_role_arn #=> String
|
2336
|
+
# resp.events_detection_job_properties_list[0].target_event_types #=> Array
|
2337
|
+
# resp.events_detection_job_properties_list[0].target_event_types[0] #=> String
|
2338
|
+
# resp.next_token #=> String
|
2339
|
+
#
|
2340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs AWS API Documentation
|
2341
|
+
#
|
2342
|
+
# @overload list_events_detection_jobs(params = {})
|
2343
|
+
# @param [Hash] params ({})
|
2344
|
+
def list_events_detection_jobs(params = {}, options = {})
|
2345
|
+
req = build_request(:list_events_detection_jobs, params)
|
2346
|
+
req.send_request(options)
|
2347
|
+
end
|
2348
|
+
|
2174
2349
|
# Get a list of key phrase detection jobs that you have submitted.
|
2175
2350
|
#
|
2176
2351
|
# @option params [Types::KeyPhrasesDetectionJobFilter] :filter
|
@@ -2747,6 +2922,73 @@ module Aws::Comprehend
|
|
2747
2922
|
req.send_request(options)
|
2748
2923
|
end
|
2749
2924
|
|
2925
|
+
# Starts an asynchronous event detection job for a collection of
|
2926
|
+
# documents.
|
2927
|
+
#
|
2928
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
2929
|
+
# Specifies the format and location of the input data for the job.
|
2930
|
+
#
|
2931
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
2932
|
+
# Specifies where to send the output files.
|
2933
|
+
#
|
2934
|
+
# @option params [required, String] :data_access_role_arn
|
2935
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2936
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
2937
|
+
# your input data.
|
2938
|
+
#
|
2939
|
+
# @option params [String] :job_name
|
2940
|
+
# The identifier of the events detection job.
|
2941
|
+
#
|
2942
|
+
# @option params [required, String] :language_code
|
2943
|
+
# The language code of the input documents.
|
2944
|
+
#
|
2945
|
+
# @option params [String] :client_request_token
|
2946
|
+
# An unique identifier for the request. If you don't set the client
|
2947
|
+
# request token, Amazon Comprehend generates one.
|
2948
|
+
#
|
2949
|
+
# **A suitable default value is auto-generated.** You should normally
|
2950
|
+
# not need to pass this option.**
|
2951
|
+
#
|
2952
|
+
# @option params [required, Array<String>] :target_event_types
|
2953
|
+
# The types of events to detect in the input documents.
|
2954
|
+
#
|
2955
|
+
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2956
|
+
#
|
2957
|
+
# * {Types::StartEventsDetectionJobResponse#job_id #job_id} => String
|
2958
|
+
# * {Types::StartEventsDetectionJobResponse#job_status #job_status} => String
|
2959
|
+
#
|
2960
|
+
# @example Request syntax with placeholder values
|
2961
|
+
#
|
2962
|
+
# resp = client.start_events_detection_job({
|
2963
|
+
# input_data_config: { # required
|
2964
|
+
# s3_uri: "S3Uri", # required
|
2965
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2966
|
+
# },
|
2967
|
+
# output_data_config: { # required
|
2968
|
+
# s3_uri: "S3Uri", # required
|
2969
|
+
# kms_key_id: "KmsKeyId",
|
2970
|
+
# },
|
2971
|
+
# data_access_role_arn: "IamRoleArn", # required
|
2972
|
+
# job_name: "JobName",
|
2973
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2974
|
+
# client_request_token: "ClientRequestTokenString",
|
2975
|
+
# target_event_types: ["EventTypeString"], # required
|
2976
|
+
# })
|
2977
|
+
#
|
2978
|
+
# @example Response structure
|
2979
|
+
#
|
2980
|
+
# resp.job_id #=> String
|
2981
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2982
|
+
#
|
2983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob AWS API Documentation
|
2984
|
+
#
|
2985
|
+
# @overload start_events_detection_job(params = {})
|
2986
|
+
# @param [Hash] params ({})
|
2987
|
+
def start_events_detection_job(params = {}, options = {})
|
2988
|
+
req = build_request(:start_events_detection_job, params)
|
2989
|
+
req.send_request(options)
|
2990
|
+
end
|
2991
|
+
|
2750
2992
|
# Starts an asynchronous key phrase detection job for a collection of
|
2751
2993
|
# documents. Use the operation to track the status of a job.
|
2752
2994
|
#
|
@@ -3198,6 +3440,36 @@ module Aws::Comprehend
|
|
3198
3440
|
req.send_request(options)
|
3199
3441
|
end
|
3200
3442
|
|
3443
|
+
# Stops an events detection job in progress.
|
3444
|
+
#
|
3445
|
+
# @option params [required, String] :job_id
|
3446
|
+
# The identifier of the events detection job to stop.
|
3447
|
+
#
|
3448
|
+
# @return [Types::StopEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3449
|
+
#
|
3450
|
+
# * {Types::StopEventsDetectionJobResponse#job_id #job_id} => String
|
3451
|
+
# * {Types::StopEventsDetectionJobResponse#job_status #job_status} => String
|
3452
|
+
#
|
3453
|
+
# @example Request syntax with placeholder values
|
3454
|
+
#
|
3455
|
+
# resp = client.stop_events_detection_job({
|
3456
|
+
# job_id: "JobId", # required
|
3457
|
+
# })
|
3458
|
+
#
|
3459
|
+
# @example Response structure
|
3460
|
+
#
|
3461
|
+
# resp.job_id #=> String
|
3462
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3463
|
+
#
|
3464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob AWS API Documentation
|
3465
|
+
#
|
3466
|
+
# @overload stop_events_detection_job(params = {})
|
3467
|
+
# @param [Hash] params ({})
|
3468
|
+
def stop_events_detection_job(params = {}, options = {})
|
3469
|
+
req = build_request(:stop_events_detection_job, params)
|
3470
|
+
req.send_request(options)
|
3471
|
+
end
|
3472
|
+
|
3201
3473
|
# Stops a key phrases detection job in progress.
|
3202
3474
|
#
|
3203
3475
|
# If the job state is `IN_PROGRESS` the job is marked for termination
|
@@ -3481,7 +3753,7 @@ module Aws::Comprehend
|
|
3481
3753
|
params: params,
|
3482
3754
|
config: config)
|
3483
3755
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3484
|
-
context[:gem_version] = '1.
|
3756
|
+
context[:gem_version] = '1.46.0'
|
3485
3757
|
Seahorse::Client::Request.new(handlers, context)
|
3486
3758
|
end
|
3487
3759
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -46,6 +46,8 @@ module Aws::Comprehend
|
|
46
46
|
ComprehendEndpointName = Shapes::StringShape.new(name: 'ComprehendEndpointName')
|
47
47
|
ComprehendModelArn = Shapes::StringShape.new(name: 'ComprehendModelArn')
|
48
48
|
ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
|
49
|
+
ContainsPiiEntitiesRequest = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesRequest')
|
50
|
+
ContainsPiiEntitiesResponse = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesResponse')
|
49
51
|
CreateDocumentClassifierRequest = Shapes::StructureShape.new(name: 'CreateDocumentClassifierRequest')
|
50
52
|
CreateDocumentClassifierResponse = Shapes::StructureShape.new(name: 'CreateDocumentClassifierResponse')
|
51
53
|
CreateEndpointRequest = Shapes::StructureShape.new(name: 'CreateEndpointRequest')
|
@@ -72,6 +74,8 @@ module Aws::Comprehend
|
|
72
74
|
DescribeEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionJobResponse')
|
73
75
|
DescribeEntityRecognizerRequest = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerRequest')
|
74
76
|
DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
|
77
|
+
DescribeEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeEventsDetectionJobRequest')
|
78
|
+
DescribeEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeEventsDetectionJobResponse')
|
75
79
|
DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
|
76
80
|
DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
|
77
81
|
DescribePiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobRequest')
|
@@ -120,6 +124,7 @@ module Aws::Comprehend
|
|
120
124
|
EntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'EntitiesDetectionJobProperties')
|
121
125
|
EntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EntitiesDetectionJobPropertiesList')
|
122
126
|
Entity = Shapes::StructureShape.new(name: 'Entity')
|
127
|
+
EntityLabel = Shapes::StructureShape.new(name: 'EntityLabel')
|
123
128
|
EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
|
124
129
|
EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
|
125
130
|
EntityRecognizerAugmentedManifestsList = Shapes::ListShape.new(name: 'EntityRecognizerAugmentedManifestsList')
|
@@ -140,6 +145,10 @@ module Aws::Comprehend
|
|
140
145
|
EntityTypesEvaluationMetrics = Shapes::StructureShape.new(name: 'EntityTypesEvaluationMetrics')
|
141
146
|
EntityTypesList = Shapes::ListShape.new(name: 'EntityTypesList')
|
142
147
|
EntityTypesListItem = Shapes::StructureShape.new(name: 'EntityTypesListItem')
|
148
|
+
EventTypeString = Shapes::StringShape.new(name: 'EventTypeString')
|
149
|
+
EventsDetectionJobFilter = Shapes::StructureShape.new(name: 'EventsDetectionJobFilter')
|
150
|
+
EventsDetectionJobProperties = Shapes::StructureShape.new(name: 'EventsDetectionJobProperties')
|
151
|
+
EventsDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EventsDetectionJobPropertiesList')
|
143
152
|
Float = Shapes::FloatShape.new(name: 'Float')
|
144
153
|
IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
|
145
154
|
InferenceUnitsInteger = Shapes::IntegerShape.new(name: 'InferenceUnitsInteger')
|
@@ -173,6 +182,8 @@ module Aws::Comprehend
|
|
173
182
|
ListEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsResponse')
|
174
183
|
ListEntityRecognizersRequest = Shapes::StructureShape.new(name: 'ListEntityRecognizersRequest')
|
175
184
|
ListEntityRecognizersResponse = Shapes::StructureShape.new(name: 'ListEntityRecognizersResponse')
|
185
|
+
ListEventsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEventsDetectionJobsRequest')
|
186
|
+
ListEventsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEventsDetectionJobsResponse')
|
176
187
|
ListKeyPhrasesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsRequest')
|
177
188
|
ListKeyPhrasesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsResponse')
|
178
189
|
ListOfClasses = Shapes::ListShape.new(name: 'ListOfClasses')
|
@@ -183,6 +194,7 @@ module Aws::Comprehend
|
|
183
194
|
ListOfDetectSyntaxResult = Shapes::ListShape.new(name: 'ListOfDetectSyntaxResult')
|
184
195
|
ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
|
185
196
|
ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
|
197
|
+
ListOfEntityLabels = Shapes::ListShape.new(name: 'ListOfEntityLabels')
|
186
198
|
ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
|
187
199
|
ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
|
188
200
|
ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
|
@@ -230,6 +242,8 @@ module Aws::Comprehend
|
|
230
242
|
StartDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'StartDominantLanguageDetectionJobResponse')
|
231
243
|
StartEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobRequest')
|
232
244
|
StartEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobResponse')
|
245
|
+
StartEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartEventsDetectionJobRequest')
|
246
|
+
StartEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEventsDetectionJobResponse')
|
233
247
|
StartKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobRequest')
|
234
248
|
StartKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobResponse')
|
235
249
|
StartPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobRequest')
|
@@ -242,6 +256,8 @@ module Aws::Comprehend
|
|
242
256
|
StopDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'StopDominantLanguageDetectionJobResponse')
|
243
257
|
StopEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobRequest')
|
244
258
|
StopEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobResponse')
|
259
|
+
StopEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'StopEventsDetectionJobRequest')
|
260
|
+
StopEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEventsDetectionJobResponse')
|
245
261
|
StopKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobRequest')
|
246
262
|
StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
|
247
263
|
StopPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobRequest')
|
@@ -264,6 +280,7 @@ module Aws::Comprehend
|
|
264
280
|
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
265
281
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
266
282
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
283
|
+
TargetEventTypes = Shapes::ListShape.new(name: 'TargetEventTypes')
|
267
284
|
TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
|
268
285
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
269
286
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
@@ -382,6 +399,13 @@ module Aws::Comprehend
|
|
382
399
|
ConcurrentModificationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
383
400
|
ConcurrentModificationException.struct_class = Types::ConcurrentModificationException
|
384
401
|
|
402
|
+
ContainsPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
403
|
+
ContainsPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
404
|
+
ContainsPiiEntitiesRequest.struct_class = Types::ContainsPiiEntitiesRequest
|
405
|
+
|
406
|
+
ContainsPiiEntitiesResponse.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfEntityLabels, location_name: "Labels"))
|
407
|
+
ContainsPiiEntitiesResponse.struct_class = Types::ContainsPiiEntitiesResponse
|
408
|
+
|
385
409
|
CreateDocumentClassifierRequest.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "DocumentClassifierName"))
|
386
410
|
CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
387
411
|
CreateDocumentClassifierRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
@@ -392,6 +416,7 @@ module Aws::Comprehend
|
|
392
416
|
CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
393
417
|
CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
394
418
|
CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
419
|
+
CreateDocumentClassifierRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
395
420
|
CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
|
396
421
|
|
397
422
|
CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
@@ -402,6 +427,7 @@ module Aws::Comprehend
|
|
402
427
|
CreateEndpointRequest.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, required: true, location_name: "DesiredInferenceUnits"))
|
403
428
|
CreateEndpointRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
404
429
|
CreateEndpointRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
430
|
+
CreateEndpointRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
405
431
|
CreateEndpointRequest.struct_class = Types::CreateEndpointRequest
|
406
432
|
|
407
433
|
CreateEndpointResponse.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: ComprehendEndpointArn, location_name: "EndpointArn"))
|
@@ -415,6 +441,7 @@ module Aws::Comprehend
|
|
415
441
|
CreateEntityRecognizerRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
416
442
|
CreateEntityRecognizerRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
417
443
|
CreateEntityRecognizerRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
444
|
+
CreateEntityRecognizerRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
418
445
|
CreateEntityRecognizerRequest.struct_class = Types::CreateEntityRecognizerRequest
|
419
446
|
|
420
447
|
CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
@@ -473,6 +500,12 @@ module Aws::Comprehend
|
|
473
500
|
DescribeEntityRecognizerResponse.add_member(:entity_recognizer_properties, Shapes::ShapeRef.new(shape: EntityRecognizerProperties, location_name: "EntityRecognizerProperties"))
|
474
501
|
DescribeEntityRecognizerResponse.struct_class = Types::DescribeEntityRecognizerResponse
|
475
502
|
|
503
|
+
DescribeEventsDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
504
|
+
DescribeEventsDetectionJobRequest.struct_class = Types::DescribeEventsDetectionJobRequest
|
505
|
+
|
506
|
+
DescribeEventsDetectionJobResponse.add_member(:events_detection_job_properties, Shapes::ShapeRef.new(shape: EventsDetectionJobProperties, location_name: "EventsDetectionJobProperties"))
|
507
|
+
DescribeEventsDetectionJobResponse.struct_class = Types::DescribeEventsDetectionJobResponse
|
508
|
+
|
476
509
|
DescribeKeyPhrasesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
477
510
|
DescribeKeyPhrasesDetectionJobRequest.struct_class = Types::DescribeKeyPhrasesDetectionJobRequest
|
478
511
|
|
@@ -598,6 +631,7 @@ module Aws::Comprehend
|
|
598
631
|
DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
599
632
|
DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
600
633
|
DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
634
|
+
DocumentClassifierProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
601
635
|
DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
|
602
636
|
|
603
637
|
DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
|
@@ -645,6 +679,7 @@ module Aws::Comprehend
|
|
645
679
|
EndpointProperties.add_member(:current_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "CurrentInferenceUnits"))
|
646
680
|
EndpointProperties.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
647
681
|
EndpointProperties.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
|
682
|
+
EndpointProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
648
683
|
EndpointProperties.struct_class = Types::EndpointProperties
|
649
684
|
|
650
685
|
EndpointPropertiesList.member = Shapes::ShapeRef.new(shape: EndpointProperties)
|
@@ -679,6 +714,10 @@ module Aws::Comprehend
|
|
679
714
|
Entity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
|
680
715
|
Entity.struct_class = Types::Entity
|
681
716
|
|
717
|
+
EntityLabel.add_member(:name, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Name"))
|
718
|
+
EntityLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
719
|
+
EntityLabel.struct_class = Types::EntityLabel
|
720
|
+
|
682
721
|
EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
683
722
|
EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
|
684
723
|
|
@@ -734,6 +773,7 @@ module Aws::Comprehend
|
|
734
773
|
EntityRecognizerProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
735
774
|
EntityRecognizerProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
736
775
|
EntityRecognizerProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
776
|
+
EntityRecognizerProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
737
777
|
EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
|
738
778
|
|
739
779
|
EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
|
@@ -748,6 +788,27 @@ module Aws::Comprehend
|
|
748
788
|
EntityTypesListItem.add_member(:type, Shapes::ShapeRef.new(shape: EntityTypeName, required: true, location_name: "Type"))
|
749
789
|
EntityTypesListItem.struct_class = Types::EntityTypesListItem
|
750
790
|
|
791
|
+
EventsDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
792
|
+
EventsDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
793
|
+
EventsDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
794
|
+
EventsDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
795
|
+
EventsDetectionJobFilter.struct_class = Types::EventsDetectionJobFilter
|
796
|
+
|
797
|
+
EventsDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
798
|
+
EventsDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
799
|
+
EventsDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
800
|
+
EventsDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
801
|
+
EventsDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
802
|
+
EventsDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
803
|
+
EventsDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
804
|
+
EventsDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
805
|
+
EventsDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
806
|
+
EventsDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
807
|
+
EventsDetectionJobProperties.add_member(:target_event_types, Shapes::ShapeRef.new(shape: TargetEventTypes, location_name: "TargetEventTypes"))
|
808
|
+
EventsDetectionJobProperties.struct_class = Types::EventsDetectionJobProperties
|
809
|
+
|
810
|
+
EventsDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: EventsDetectionJobProperties)
|
811
|
+
|
751
812
|
InputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
752
813
|
InputDataConfig.add_member(:input_format, Shapes::ShapeRef.new(shape: InputFormat, location_name: "InputFormat"))
|
753
814
|
InputDataConfig.struct_class = Types::InputDataConfig
|
@@ -849,6 +910,15 @@ module Aws::Comprehend
|
|
849
910
|
ListEntityRecognizersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
850
911
|
ListEntityRecognizersResponse.struct_class = Types::ListEntityRecognizersResponse
|
851
912
|
|
913
|
+
ListEventsDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: EventsDetectionJobFilter, location_name: "Filter"))
|
914
|
+
ListEventsDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
915
|
+
ListEventsDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
916
|
+
ListEventsDetectionJobsRequest.struct_class = Types::ListEventsDetectionJobsRequest
|
917
|
+
|
918
|
+
ListEventsDetectionJobsResponse.add_member(:events_detection_job_properties_list, Shapes::ShapeRef.new(shape: EventsDetectionJobPropertiesList, location_name: "EventsDetectionJobPropertiesList"))
|
919
|
+
ListEventsDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
920
|
+
ListEventsDetectionJobsResponse.struct_class = Types::ListEventsDetectionJobsResponse
|
921
|
+
|
852
922
|
ListKeyPhrasesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobFilter, location_name: "Filter"))
|
853
923
|
ListKeyPhrasesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
854
924
|
ListKeyPhrasesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -874,6 +944,8 @@ module Aws::Comprehend
|
|
874
944
|
|
875
945
|
ListOfEntities.member = Shapes::ShapeRef.new(shape: Entity)
|
876
946
|
|
947
|
+
ListOfEntityLabels.member = Shapes::ShapeRef.new(shape: EntityLabel)
|
948
|
+
|
877
949
|
ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
|
878
950
|
|
879
951
|
ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
|
@@ -1047,6 +1119,19 @@ module Aws::Comprehend
|
|
1047
1119
|
StartEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1048
1120
|
StartEntitiesDetectionJobResponse.struct_class = Types::StartEntitiesDetectionJobResponse
|
1049
1121
|
|
1122
|
+
StartEventsDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1123
|
+
StartEventsDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1124
|
+
StartEventsDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
1125
|
+
StartEventsDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1126
|
+
StartEventsDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1127
|
+
StartEventsDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1128
|
+
StartEventsDetectionJobRequest.add_member(:target_event_types, Shapes::ShapeRef.new(shape: TargetEventTypes, required: true, location_name: "TargetEventTypes"))
|
1129
|
+
StartEventsDetectionJobRequest.struct_class = Types::StartEventsDetectionJobRequest
|
1130
|
+
|
1131
|
+
StartEventsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1132
|
+
StartEventsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1133
|
+
StartEventsDetectionJobResponse.struct_class = Types::StartEventsDetectionJobResponse
|
1134
|
+
|
1050
1135
|
StartKeyPhrasesDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1051
1136
|
StartKeyPhrasesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1052
1137
|
StartKeyPhrasesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
@@ -1117,6 +1202,13 @@ module Aws::Comprehend
|
|
1117
1202
|
StopEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1118
1203
|
StopEntitiesDetectionJobResponse.struct_class = Types::StopEntitiesDetectionJobResponse
|
1119
1204
|
|
1205
|
+
StopEventsDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1206
|
+
StopEventsDetectionJobRequest.struct_class = Types::StopEventsDetectionJobRequest
|
1207
|
+
|
1208
|
+
StopEventsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1209
|
+
StopEventsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1210
|
+
StopEventsDetectionJobResponse.struct_class = Types::StopEventsDetectionJobResponse
|
1211
|
+
|
1120
1212
|
StopKeyPhrasesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1121
1213
|
StopKeyPhrasesDetectionJobRequest.struct_class = Types::StopKeyPhrasesDetectionJobRequest
|
1122
1214
|
|
@@ -1171,6 +1263,8 @@ module Aws::Comprehend
|
|
1171
1263
|
|
1172
1264
|
TagResourceResponse.struct_class = Types::TagResourceResponse
|
1173
1265
|
|
1266
|
+
TargetEventTypes.member = Shapes::ShapeRef.new(shape: EventTypeString)
|
1267
|
+
|
1174
1268
|
TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
1175
1269
|
TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
|
1176
1270
|
|
@@ -1319,6 +1413,18 @@ module Aws::Comprehend
|
|
1319
1413
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1320
1414
|
end)
|
1321
1415
|
|
1416
|
+
api.add_operation(:contains_pii_entities, Seahorse::Model::Operation.new.tap do |o|
|
1417
|
+
o.name = "ContainsPiiEntities"
|
1418
|
+
o.http_method = "POST"
|
1419
|
+
o.http_request_uri = "/"
|
1420
|
+
o.input = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesRequest)
|
1421
|
+
o.output = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesResponse)
|
1422
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1423
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
1424
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
1425
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1426
|
+
end)
|
1427
|
+
|
1322
1428
|
api.add_operation(:create_document_classifier, Seahorse::Model::Operation.new.tap do |o|
|
1323
1429
|
o.name = "CreateDocumentClassifier"
|
1324
1430
|
o.http_method = "POST"
|
@@ -1480,6 +1586,18 @@ module Aws::Comprehend
|
|
1480
1586
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1481
1587
|
end)
|
1482
1588
|
|
1589
|
+
api.add_operation(:describe_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1590
|
+
o.name = "DescribeEventsDetectionJob"
|
1591
|
+
o.http_method = "POST"
|
1592
|
+
o.http_request_uri = "/"
|
1593
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeEventsDetectionJobRequest)
|
1594
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeEventsDetectionJobResponse)
|
1595
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1596
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1597
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1598
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1599
|
+
end)
|
1600
|
+
|
1483
1601
|
api.add_operation(:describe_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1484
1602
|
o.name = "DescribeKeyPhrasesDetectionJob"
|
1485
1603
|
o.http_method = "POST"
|
@@ -1701,6 +1819,24 @@ module Aws::Comprehend
|
|
1701
1819
|
)
|
1702
1820
|
end)
|
1703
1821
|
|
1822
|
+
api.add_operation(:list_events_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1823
|
+
o.name = "ListEventsDetectionJobs"
|
1824
|
+
o.http_method = "POST"
|
1825
|
+
o.http_request_uri = "/"
|
1826
|
+
o.input = Shapes::ShapeRef.new(shape: ListEventsDetectionJobsRequest)
|
1827
|
+
o.output = Shapes::ShapeRef.new(shape: ListEventsDetectionJobsResponse)
|
1828
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1829
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1830
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
1831
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1832
|
+
o[:pager] = Aws::Pager.new(
|
1833
|
+
limit_key: "max_results",
|
1834
|
+
tokens: {
|
1835
|
+
"next_token" => "next_token"
|
1836
|
+
}
|
1837
|
+
)
|
1838
|
+
end)
|
1839
|
+
|
1704
1840
|
api.add_operation(:list_key_phrases_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1705
1841
|
o.name = "ListKeyPhrasesDetectionJobs"
|
1706
1842
|
o.http_method = "POST"
|
@@ -1818,6 +1954,18 @@ module Aws::Comprehend
|
|
1818
1954
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1819
1955
|
end)
|
1820
1956
|
|
1957
|
+
api.add_operation(:start_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1958
|
+
o.name = "StartEventsDetectionJob"
|
1959
|
+
o.http_method = "POST"
|
1960
|
+
o.http_request_uri = "/"
|
1961
|
+
o.input = Shapes::ShapeRef.new(shape: StartEventsDetectionJobRequest)
|
1962
|
+
o.output = Shapes::ShapeRef.new(shape: StartEventsDetectionJobResponse)
|
1963
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1964
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1965
|
+
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1966
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1967
|
+
end)
|
1968
|
+
|
1821
1969
|
api.add_operation(:start_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1822
1970
|
o.name = "StartKeyPhrasesDetectionJob"
|
1823
1971
|
o.http_method = "POST"
|
@@ -1888,6 +2036,17 @@ module Aws::Comprehend
|
|
1888
2036
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1889
2037
|
end)
|
1890
2038
|
|
2039
|
+
api.add_operation(:stop_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
2040
|
+
o.name = "StopEventsDetectionJob"
|
2041
|
+
o.http_method = "POST"
|
2042
|
+
o.http_request_uri = "/"
|
2043
|
+
o.input = Shapes::ShapeRef.new(shape: StopEventsDetectionJobRequest)
|
2044
|
+
o.output = Shapes::ShapeRef.new(shape: StopEventsDetectionJobResponse)
|
2045
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2046
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
2047
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2048
|
+
end)
|
2049
|
+
|
1891
2050
|
api.add_operation(:stop_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1892
2051
|
o.name = "StopKeyPhrasesDetectionJob"
|
1893
2052
|
o.http_method = "POST"
|