aws-sdk-comprehend 1.41.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +200 -1
- data/lib/aws-sdk-comprehend/client_api.rb +124 -0
- data/lib/aws-sdk-comprehend/types.rb +329 -8
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b742f41b8729d157dc0220a9066fd13e7ef35f8cd74ed4dffda2a404d30f74cc
|
4
|
+
data.tar.gz: ed3245b0270f71abdc8a92725dd8f725e4e3bafbbd8490a4a8ed80cfd8d150c0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0204deb04b9404e7ff743e3aafac4504920c9279a026fe6ab9c17767817589fb6bcc0198b5ffe6716ba0800d5fcb5e1734b0420428626ab4ff5e6b852cae46a6
|
7
|
+
data.tar.gz: 49cafb1cf8bfd2d6bdd7b09aac3ac188269b0cbbb1bb406f76d4f44febfe211c5e0d2494ecc3ac7ecc458e6a569d2f10a1bced03614784e0140e818e37453010
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -1312,6 +1312,47 @@ module Aws::Comprehend
|
|
1312
1312
|
req.send_request(options)
|
1313
1313
|
end
|
1314
1314
|
|
1315
|
+
# Gets the status and details of an events detection job.
|
1316
|
+
#
|
1317
|
+
# @option params [required, String] :job_id
|
1318
|
+
# The identifier of the events detection job.
|
1319
|
+
#
|
1320
|
+
# @return [Types::DescribeEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
|
+
#
|
1322
|
+
# * {Types::DescribeEventsDetectionJobResponse#events_detection_job_properties #events_detection_job_properties} => Types::EventsDetectionJobProperties
|
1323
|
+
#
|
1324
|
+
# @example Request syntax with placeholder values
|
1325
|
+
#
|
1326
|
+
# resp = client.describe_events_detection_job({
|
1327
|
+
# job_id: "JobId", # required
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
#
|
1332
|
+
# resp.events_detection_job_properties.job_id #=> String
|
1333
|
+
# resp.events_detection_job_properties.job_name #=> String
|
1334
|
+
# resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1335
|
+
# resp.events_detection_job_properties.message #=> String
|
1336
|
+
# resp.events_detection_job_properties.submit_time #=> Time
|
1337
|
+
# resp.events_detection_job_properties.end_time #=> Time
|
1338
|
+
# resp.events_detection_job_properties.input_data_config.s3_uri #=> String
|
1339
|
+
# resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1340
|
+
# resp.events_detection_job_properties.output_data_config.s3_uri #=> String
|
1341
|
+
# resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
|
1342
|
+
# resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1343
|
+
# resp.events_detection_job_properties.data_access_role_arn #=> String
|
1344
|
+
# resp.events_detection_job_properties.target_event_types #=> Array
|
1345
|
+
# resp.events_detection_job_properties.target_event_types[0] #=> String
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob AWS API Documentation
|
1348
|
+
#
|
1349
|
+
# @overload describe_events_detection_job(params = {})
|
1350
|
+
# @param [Hash] params ({})
|
1351
|
+
def describe_events_detection_job(params = {}, options = {})
|
1352
|
+
req = build_request(:describe_events_detection_job, params)
|
1353
|
+
req.send_request(options)
|
1354
|
+
end
|
1355
|
+
|
1315
1356
|
# Gets the properties associated with a key phrases detection job. Use
|
1316
1357
|
# this operation to get the status of a detection job.
|
1317
1358
|
#
|
@@ -2171,6 +2212,67 @@ module Aws::Comprehend
|
|
2171
2212
|
req.send_request(options)
|
2172
2213
|
end
|
2173
2214
|
|
2215
|
+
# Gets a list of the events detection jobs that you have submitted.
|
2216
|
+
#
|
2217
|
+
# @option params [Types::EventsDetectionJobFilter] :filter
|
2218
|
+
# Filters the jobs that are returned. You can filter jobs on their name,
|
2219
|
+
# status, or the date and time that they were submitted. You can only
|
2220
|
+
# set one filter at a time.
|
2221
|
+
#
|
2222
|
+
# @option params [String] :next_token
|
2223
|
+
# Identifies the next page of results to return.
|
2224
|
+
#
|
2225
|
+
# @option params [Integer] :max_results
|
2226
|
+
# The maximum number of results to return in each page.
|
2227
|
+
#
|
2228
|
+
# @return [Types::ListEventsDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2229
|
+
#
|
2230
|
+
# * {Types::ListEventsDetectionJobsResponse#events_detection_job_properties_list #events_detection_job_properties_list} => Array<Types::EventsDetectionJobProperties>
|
2231
|
+
# * {Types::ListEventsDetectionJobsResponse#next_token #next_token} => String
|
2232
|
+
#
|
2233
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2234
|
+
#
|
2235
|
+
# @example Request syntax with placeholder values
|
2236
|
+
#
|
2237
|
+
# resp = client.list_events_detection_jobs({
|
2238
|
+
# filter: {
|
2239
|
+
# job_name: "JobName",
|
2240
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
2241
|
+
# submit_time_before: Time.now,
|
2242
|
+
# submit_time_after: Time.now,
|
2243
|
+
# },
|
2244
|
+
# next_token: "String",
|
2245
|
+
# max_results: 1,
|
2246
|
+
# })
|
2247
|
+
#
|
2248
|
+
# @example Response structure
|
2249
|
+
#
|
2250
|
+
# resp.events_detection_job_properties_list #=> Array
|
2251
|
+
# resp.events_detection_job_properties_list[0].job_id #=> String
|
2252
|
+
# resp.events_detection_job_properties_list[0].job_name #=> String
|
2253
|
+
# resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2254
|
+
# resp.events_detection_job_properties_list[0].message #=> String
|
2255
|
+
# resp.events_detection_job_properties_list[0].submit_time #=> Time
|
2256
|
+
# resp.events_detection_job_properties_list[0].end_time #=> Time
|
2257
|
+
# resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2258
|
+
# resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2259
|
+
# resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2260
|
+
# resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2261
|
+
# 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"
|
2262
|
+
# resp.events_detection_job_properties_list[0].data_access_role_arn #=> String
|
2263
|
+
# resp.events_detection_job_properties_list[0].target_event_types #=> Array
|
2264
|
+
# resp.events_detection_job_properties_list[0].target_event_types[0] #=> String
|
2265
|
+
# resp.next_token #=> String
|
2266
|
+
#
|
2267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs AWS API Documentation
|
2268
|
+
#
|
2269
|
+
# @overload list_events_detection_jobs(params = {})
|
2270
|
+
# @param [Hash] params ({})
|
2271
|
+
def list_events_detection_jobs(params = {}, options = {})
|
2272
|
+
req = build_request(:list_events_detection_jobs, params)
|
2273
|
+
req.send_request(options)
|
2274
|
+
end
|
2275
|
+
|
2174
2276
|
# Get a list of key phrase detection jobs that you have submitted.
|
2175
2277
|
#
|
2176
2278
|
# @option params [Types::KeyPhrasesDetectionJobFilter] :filter
|
@@ -2747,6 +2849,73 @@ module Aws::Comprehend
|
|
2747
2849
|
req.send_request(options)
|
2748
2850
|
end
|
2749
2851
|
|
2852
|
+
# Starts an asynchronous event detection job for a collection of
|
2853
|
+
# documents.
|
2854
|
+
#
|
2855
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
2856
|
+
# Specifies the format and location of the input data for the job.
|
2857
|
+
#
|
2858
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
2859
|
+
# Specifies where to send the output files.
|
2860
|
+
#
|
2861
|
+
# @option params [required, String] :data_access_role_arn
|
2862
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2863
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
2864
|
+
# your input data.
|
2865
|
+
#
|
2866
|
+
# @option params [String] :job_name
|
2867
|
+
# The identifier of the events detection job.
|
2868
|
+
#
|
2869
|
+
# @option params [required, String] :language_code
|
2870
|
+
# The language code of the input documents.
|
2871
|
+
#
|
2872
|
+
# @option params [String] :client_request_token
|
2873
|
+
# An unique identifier for the request. If you don't set the client
|
2874
|
+
# request token, Amazon Comprehend generates one.
|
2875
|
+
#
|
2876
|
+
# **A suitable default value is auto-generated.** You should normally
|
2877
|
+
# not need to pass this option.**
|
2878
|
+
#
|
2879
|
+
# @option params [required, Array<String>] :target_event_types
|
2880
|
+
# The types of events to detect in the input documents.
|
2881
|
+
#
|
2882
|
+
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2883
|
+
#
|
2884
|
+
# * {Types::StartEventsDetectionJobResponse#job_id #job_id} => String
|
2885
|
+
# * {Types::StartEventsDetectionJobResponse#job_status #job_status} => String
|
2886
|
+
#
|
2887
|
+
# @example Request syntax with placeholder values
|
2888
|
+
#
|
2889
|
+
# resp = client.start_events_detection_job({
|
2890
|
+
# input_data_config: { # required
|
2891
|
+
# s3_uri: "S3Uri", # required
|
2892
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2893
|
+
# },
|
2894
|
+
# output_data_config: { # required
|
2895
|
+
# s3_uri: "S3Uri", # required
|
2896
|
+
# kms_key_id: "KmsKeyId",
|
2897
|
+
# },
|
2898
|
+
# data_access_role_arn: "IamRoleArn", # required
|
2899
|
+
# job_name: "JobName",
|
2900
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2901
|
+
# client_request_token: "ClientRequestTokenString",
|
2902
|
+
# target_event_types: ["EventTypeString"], # required
|
2903
|
+
# })
|
2904
|
+
#
|
2905
|
+
# @example Response structure
|
2906
|
+
#
|
2907
|
+
# resp.job_id #=> String
|
2908
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2909
|
+
#
|
2910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob AWS API Documentation
|
2911
|
+
#
|
2912
|
+
# @overload start_events_detection_job(params = {})
|
2913
|
+
# @param [Hash] params ({})
|
2914
|
+
def start_events_detection_job(params = {}, options = {})
|
2915
|
+
req = build_request(:start_events_detection_job, params)
|
2916
|
+
req.send_request(options)
|
2917
|
+
end
|
2918
|
+
|
2750
2919
|
# Starts an asynchronous key phrase detection job for a collection of
|
2751
2920
|
# documents. Use the operation to track the status of a job.
|
2752
2921
|
#
|
@@ -3198,6 +3367,36 @@ module Aws::Comprehend
|
|
3198
3367
|
req.send_request(options)
|
3199
3368
|
end
|
3200
3369
|
|
3370
|
+
# Stops an events detection job in progress.
|
3371
|
+
#
|
3372
|
+
# @option params [required, String] :job_id
|
3373
|
+
# The identifier of the events detection job to stop.
|
3374
|
+
#
|
3375
|
+
# @return [Types::StopEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3376
|
+
#
|
3377
|
+
# * {Types::StopEventsDetectionJobResponse#job_id #job_id} => String
|
3378
|
+
# * {Types::StopEventsDetectionJobResponse#job_status #job_status} => String
|
3379
|
+
#
|
3380
|
+
# @example Request syntax with placeholder values
|
3381
|
+
#
|
3382
|
+
# resp = client.stop_events_detection_job({
|
3383
|
+
# job_id: "JobId", # required
|
3384
|
+
# })
|
3385
|
+
#
|
3386
|
+
# @example Response structure
|
3387
|
+
#
|
3388
|
+
# resp.job_id #=> String
|
3389
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3390
|
+
#
|
3391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob AWS API Documentation
|
3392
|
+
#
|
3393
|
+
# @overload stop_events_detection_job(params = {})
|
3394
|
+
# @param [Hash] params ({})
|
3395
|
+
def stop_events_detection_job(params = {}, options = {})
|
3396
|
+
req = build_request(:stop_events_detection_job, params)
|
3397
|
+
req.send_request(options)
|
3398
|
+
end
|
3399
|
+
|
3201
3400
|
# Stops a key phrases detection job in progress.
|
3202
3401
|
#
|
3203
3402
|
# If the job state is `IN_PROGRESS` the job is marked for termination
|
@@ -3481,7 +3680,7 @@ module Aws::Comprehend
|
|
3481
3680
|
params: params,
|
3482
3681
|
config: config)
|
3483
3682
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3484
|
-
context[:gem_version] = '1.
|
3683
|
+
context[:gem_version] = '1.42.0'
|
3485
3684
|
Seahorse::Client::Request.new(handlers, context)
|
3486
3685
|
end
|
3487
3686
|
|
@@ -72,6 +72,8 @@ module Aws::Comprehend
|
|
72
72
|
DescribeEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionJobResponse')
|
73
73
|
DescribeEntityRecognizerRequest = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerRequest')
|
74
74
|
DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
|
75
|
+
DescribeEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeEventsDetectionJobRequest')
|
76
|
+
DescribeEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeEventsDetectionJobResponse')
|
75
77
|
DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
|
76
78
|
DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
|
77
79
|
DescribePiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobRequest')
|
@@ -140,6 +142,10 @@ module Aws::Comprehend
|
|
140
142
|
EntityTypesEvaluationMetrics = Shapes::StructureShape.new(name: 'EntityTypesEvaluationMetrics')
|
141
143
|
EntityTypesList = Shapes::ListShape.new(name: 'EntityTypesList')
|
142
144
|
EntityTypesListItem = Shapes::StructureShape.new(name: 'EntityTypesListItem')
|
145
|
+
EventTypeString = Shapes::StringShape.new(name: 'EventTypeString')
|
146
|
+
EventsDetectionJobFilter = Shapes::StructureShape.new(name: 'EventsDetectionJobFilter')
|
147
|
+
EventsDetectionJobProperties = Shapes::StructureShape.new(name: 'EventsDetectionJobProperties')
|
148
|
+
EventsDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EventsDetectionJobPropertiesList')
|
143
149
|
Float = Shapes::FloatShape.new(name: 'Float')
|
144
150
|
IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
|
145
151
|
InferenceUnitsInteger = Shapes::IntegerShape.new(name: 'InferenceUnitsInteger')
|
@@ -173,6 +179,8 @@ module Aws::Comprehend
|
|
173
179
|
ListEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsResponse')
|
174
180
|
ListEntityRecognizersRequest = Shapes::StructureShape.new(name: 'ListEntityRecognizersRequest')
|
175
181
|
ListEntityRecognizersResponse = Shapes::StructureShape.new(name: 'ListEntityRecognizersResponse')
|
182
|
+
ListEventsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEventsDetectionJobsRequest')
|
183
|
+
ListEventsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEventsDetectionJobsResponse')
|
176
184
|
ListKeyPhrasesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsRequest')
|
177
185
|
ListKeyPhrasesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsResponse')
|
178
186
|
ListOfClasses = Shapes::ListShape.new(name: 'ListOfClasses')
|
@@ -230,6 +238,8 @@ module Aws::Comprehend
|
|
230
238
|
StartDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'StartDominantLanguageDetectionJobResponse')
|
231
239
|
StartEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobRequest')
|
232
240
|
StartEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobResponse')
|
241
|
+
StartEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartEventsDetectionJobRequest')
|
242
|
+
StartEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEventsDetectionJobResponse')
|
233
243
|
StartKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobRequest')
|
234
244
|
StartKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobResponse')
|
235
245
|
StartPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobRequest')
|
@@ -242,6 +252,8 @@ module Aws::Comprehend
|
|
242
252
|
StopDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'StopDominantLanguageDetectionJobResponse')
|
243
253
|
StopEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobRequest')
|
244
254
|
StopEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobResponse')
|
255
|
+
StopEventsDetectionJobRequest = Shapes::StructureShape.new(name: 'StopEventsDetectionJobRequest')
|
256
|
+
StopEventsDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEventsDetectionJobResponse')
|
245
257
|
StopKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobRequest')
|
246
258
|
StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
|
247
259
|
StopPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobRequest')
|
@@ -264,6 +276,7 @@ module Aws::Comprehend
|
|
264
276
|
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
265
277
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
266
278
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
279
|
+
TargetEventTypes = Shapes::ListShape.new(name: 'TargetEventTypes')
|
267
280
|
TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
|
268
281
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
269
282
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
@@ -473,6 +486,12 @@ module Aws::Comprehend
|
|
473
486
|
DescribeEntityRecognizerResponse.add_member(:entity_recognizer_properties, Shapes::ShapeRef.new(shape: EntityRecognizerProperties, location_name: "EntityRecognizerProperties"))
|
474
487
|
DescribeEntityRecognizerResponse.struct_class = Types::DescribeEntityRecognizerResponse
|
475
488
|
|
489
|
+
DescribeEventsDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
490
|
+
DescribeEventsDetectionJobRequest.struct_class = Types::DescribeEventsDetectionJobRequest
|
491
|
+
|
492
|
+
DescribeEventsDetectionJobResponse.add_member(:events_detection_job_properties, Shapes::ShapeRef.new(shape: EventsDetectionJobProperties, location_name: "EventsDetectionJobProperties"))
|
493
|
+
DescribeEventsDetectionJobResponse.struct_class = Types::DescribeEventsDetectionJobResponse
|
494
|
+
|
476
495
|
DescribeKeyPhrasesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
477
496
|
DescribeKeyPhrasesDetectionJobRequest.struct_class = Types::DescribeKeyPhrasesDetectionJobRequest
|
478
497
|
|
@@ -748,6 +767,27 @@ module Aws::Comprehend
|
|
748
767
|
EntityTypesListItem.add_member(:type, Shapes::ShapeRef.new(shape: EntityTypeName, required: true, location_name: "Type"))
|
749
768
|
EntityTypesListItem.struct_class = Types::EntityTypesListItem
|
750
769
|
|
770
|
+
EventsDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
771
|
+
EventsDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
772
|
+
EventsDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
773
|
+
EventsDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
774
|
+
EventsDetectionJobFilter.struct_class = Types::EventsDetectionJobFilter
|
775
|
+
|
776
|
+
EventsDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
777
|
+
EventsDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
778
|
+
EventsDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
779
|
+
EventsDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
780
|
+
EventsDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
781
|
+
EventsDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
782
|
+
EventsDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
783
|
+
EventsDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
784
|
+
EventsDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
785
|
+
EventsDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
786
|
+
EventsDetectionJobProperties.add_member(:target_event_types, Shapes::ShapeRef.new(shape: TargetEventTypes, location_name: "TargetEventTypes"))
|
787
|
+
EventsDetectionJobProperties.struct_class = Types::EventsDetectionJobProperties
|
788
|
+
|
789
|
+
EventsDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: EventsDetectionJobProperties)
|
790
|
+
|
751
791
|
InputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
752
792
|
InputDataConfig.add_member(:input_format, Shapes::ShapeRef.new(shape: InputFormat, location_name: "InputFormat"))
|
753
793
|
InputDataConfig.struct_class = Types::InputDataConfig
|
@@ -849,6 +889,15 @@ module Aws::Comprehend
|
|
849
889
|
ListEntityRecognizersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
850
890
|
ListEntityRecognizersResponse.struct_class = Types::ListEntityRecognizersResponse
|
851
891
|
|
892
|
+
ListEventsDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: EventsDetectionJobFilter, location_name: "Filter"))
|
893
|
+
ListEventsDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
894
|
+
ListEventsDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
895
|
+
ListEventsDetectionJobsRequest.struct_class = Types::ListEventsDetectionJobsRequest
|
896
|
+
|
897
|
+
ListEventsDetectionJobsResponse.add_member(:events_detection_job_properties_list, Shapes::ShapeRef.new(shape: EventsDetectionJobPropertiesList, location_name: "EventsDetectionJobPropertiesList"))
|
898
|
+
ListEventsDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
899
|
+
ListEventsDetectionJobsResponse.struct_class = Types::ListEventsDetectionJobsResponse
|
900
|
+
|
852
901
|
ListKeyPhrasesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobFilter, location_name: "Filter"))
|
853
902
|
ListKeyPhrasesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
854
903
|
ListKeyPhrasesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -1047,6 +1096,19 @@ module Aws::Comprehend
|
|
1047
1096
|
StartEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1048
1097
|
StartEntitiesDetectionJobResponse.struct_class = Types::StartEntitiesDetectionJobResponse
|
1049
1098
|
|
1099
|
+
StartEventsDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1100
|
+
StartEventsDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1101
|
+
StartEventsDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
1102
|
+
StartEventsDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
1103
|
+
StartEventsDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
1104
|
+
StartEventsDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
1105
|
+
StartEventsDetectionJobRequest.add_member(:target_event_types, Shapes::ShapeRef.new(shape: TargetEventTypes, required: true, location_name: "TargetEventTypes"))
|
1106
|
+
StartEventsDetectionJobRequest.struct_class = Types::StartEventsDetectionJobRequest
|
1107
|
+
|
1108
|
+
StartEventsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1109
|
+
StartEventsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1110
|
+
StartEventsDetectionJobResponse.struct_class = Types::StartEventsDetectionJobResponse
|
1111
|
+
|
1050
1112
|
StartKeyPhrasesDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
1051
1113
|
StartKeyPhrasesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
1052
1114
|
StartKeyPhrasesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
@@ -1117,6 +1179,13 @@ module Aws::Comprehend
|
|
1117
1179
|
StopEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1118
1180
|
StopEntitiesDetectionJobResponse.struct_class = Types::StopEntitiesDetectionJobResponse
|
1119
1181
|
|
1182
|
+
StopEventsDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1183
|
+
StopEventsDetectionJobRequest.struct_class = Types::StopEventsDetectionJobRequest
|
1184
|
+
|
1185
|
+
StopEventsDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
1186
|
+
StopEventsDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
1187
|
+
StopEventsDetectionJobResponse.struct_class = Types::StopEventsDetectionJobResponse
|
1188
|
+
|
1120
1189
|
StopKeyPhrasesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
1121
1190
|
StopKeyPhrasesDetectionJobRequest.struct_class = Types::StopKeyPhrasesDetectionJobRequest
|
1122
1191
|
|
@@ -1171,6 +1240,8 @@ module Aws::Comprehend
|
|
1171
1240
|
|
1172
1241
|
TagResourceResponse.struct_class = Types::TagResourceResponse
|
1173
1242
|
|
1243
|
+
TargetEventTypes.member = Shapes::ShapeRef.new(shape: EventTypeString)
|
1244
|
+
|
1174
1245
|
TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
1175
1246
|
TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
|
1176
1247
|
|
@@ -1480,6 +1551,18 @@ module Aws::Comprehend
|
|
1480
1551
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1481
1552
|
end)
|
1482
1553
|
|
1554
|
+
api.add_operation(:describe_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1555
|
+
o.name = "DescribeEventsDetectionJob"
|
1556
|
+
o.http_method = "POST"
|
1557
|
+
o.http_request_uri = "/"
|
1558
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeEventsDetectionJobRequest)
|
1559
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeEventsDetectionJobResponse)
|
1560
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1561
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
1562
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1563
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1564
|
+
end)
|
1565
|
+
|
1483
1566
|
api.add_operation(:describe_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1484
1567
|
o.name = "DescribeKeyPhrasesDetectionJob"
|
1485
1568
|
o.http_method = "POST"
|
@@ -1701,6 +1784,24 @@ module Aws::Comprehend
|
|
1701
1784
|
)
|
1702
1785
|
end)
|
1703
1786
|
|
1787
|
+
api.add_operation(:list_events_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1788
|
+
o.name = "ListEventsDetectionJobs"
|
1789
|
+
o.http_method = "POST"
|
1790
|
+
o.http_request_uri = "/"
|
1791
|
+
o.input = Shapes::ShapeRef.new(shape: ListEventsDetectionJobsRequest)
|
1792
|
+
o.output = Shapes::ShapeRef.new(shape: ListEventsDetectionJobsResponse)
|
1793
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1794
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1795
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
1796
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1797
|
+
o[:pager] = Aws::Pager.new(
|
1798
|
+
limit_key: "max_results",
|
1799
|
+
tokens: {
|
1800
|
+
"next_token" => "next_token"
|
1801
|
+
}
|
1802
|
+
)
|
1803
|
+
end)
|
1804
|
+
|
1704
1805
|
api.add_operation(:list_key_phrases_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1705
1806
|
o.name = "ListKeyPhrasesDetectionJobs"
|
1706
1807
|
o.http_method = "POST"
|
@@ -1818,6 +1919,18 @@ module Aws::Comprehend
|
|
1818
1919
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1819
1920
|
end)
|
1820
1921
|
|
1922
|
+
api.add_operation(:start_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1923
|
+
o.name = "StartEventsDetectionJob"
|
1924
|
+
o.http_method = "POST"
|
1925
|
+
o.http_request_uri = "/"
|
1926
|
+
o.input = Shapes::ShapeRef.new(shape: StartEventsDetectionJobRequest)
|
1927
|
+
o.output = Shapes::ShapeRef.new(shape: StartEventsDetectionJobResponse)
|
1928
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1929
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1930
|
+
o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
|
1931
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1932
|
+
end)
|
1933
|
+
|
1821
1934
|
api.add_operation(:start_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1822
1935
|
o.name = "StartKeyPhrasesDetectionJob"
|
1823
1936
|
o.http_method = "POST"
|
@@ -1888,6 +2001,17 @@ module Aws::Comprehend
|
|
1888
2001
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1889
2002
|
end)
|
1890
2003
|
|
2004
|
+
api.add_operation(:stop_events_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
2005
|
+
o.name = "StopEventsDetectionJob"
|
2006
|
+
o.http_method = "POST"
|
2007
|
+
o.http_request_uri = "/"
|
2008
|
+
o.input = Shapes::ShapeRef.new(shape: StopEventsDetectionJobRequest)
|
2009
|
+
o.output = Shapes::ShapeRef.new(shape: StopEventsDetectionJobResponse)
|
2010
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2011
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
2012
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2013
|
+
end)
|
2014
|
+
|
1891
2015
|
api.add_operation(:stop_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
1892
2016
|
o.name = "StopKeyPhrasesDetectionJob"
|
1893
2017
|
o.http_method = "POST"
|
@@ -603,7 +603,7 @@ module Aws::Comprehend
|
|
603
603
|
# @!attribute [rw] labels
|
604
604
|
# The labels used the document being analyzed. These are used for
|
605
605
|
# multi-label trained models. Individual labels represent different
|
606
|
-
# categories that are related in some manner and are not
|
606
|
+
# categories that are related in some manner and are not mutually
|
607
607
|
# exclusive. For example, a movie can be just an action movie, or it
|
608
608
|
# can be an action movie, a science fiction movie, and a comedy, all
|
609
609
|
# at the same time.
|
@@ -1247,6 +1247,38 @@ module Aws::Comprehend
|
|
1247
1247
|
include Aws::Structure
|
1248
1248
|
end
|
1249
1249
|
|
1250
|
+
# @note When making an API call, you may pass DescribeEventsDetectionJobRequest
|
1251
|
+
# data as a hash:
|
1252
|
+
#
|
1253
|
+
# {
|
1254
|
+
# job_id: "JobId", # required
|
1255
|
+
# }
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] job_id
|
1258
|
+
# The identifier of the events detection job.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobRequest AWS API Documentation
|
1262
|
+
#
|
1263
|
+
class DescribeEventsDetectionJobRequest < Struct.new(
|
1264
|
+
:job_id)
|
1265
|
+
SENSITIVE = []
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# @!attribute [rw] events_detection_job_properties
|
1270
|
+
# An object that contains the properties associated with an event
|
1271
|
+
# detection job.
|
1272
|
+
# @return [Types::EventsDetectionJobProperties]
|
1273
|
+
#
|
1274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobResponse AWS API Documentation
|
1275
|
+
#
|
1276
|
+
class DescribeEventsDetectionJobResponse < Struct.new(
|
1277
|
+
:events_detection_job_properties)
|
1278
|
+
SENSITIVE = []
|
1279
|
+
include Aws::Structure
|
1280
|
+
end
|
1281
|
+
|
1250
1282
|
# @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
|
1251
1283
|
# data as a hash:
|
1252
1284
|
#
|
@@ -2290,7 +2322,7 @@ module Aws::Comprehend
|
|
2290
2322
|
include Aws::Structure
|
2291
2323
|
end
|
2292
2324
|
|
2293
|
-
# The filter used to determine which endpoints are
|
2325
|
+
# The filter used to determine which endpoints are returned. You can
|
2294
2326
|
# filter jobs on their name, model, status, or the date and time that
|
2295
2327
|
# they were created. You can only set one filter at a time.
|
2296
2328
|
#
|
@@ -2994,11 +3026,10 @@ module Aws::Comprehend
|
|
2994
3026
|
# @return [Float]
|
2995
3027
|
#
|
2996
3028
|
# @!attribute [rw] f1_score
|
2997
|
-
# A measure of how accurate the recognizer results are for
|
2998
|
-
#
|
2999
|
-
# `
|
3000
|
-
#
|
3001
|
-
# score is 0.
|
3029
|
+
# A measure of how accurate the recognizer results are for a specific
|
3030
|
+
# entity type in the test data. It is derived from the `Precision` and
|
3031
|
+
# `Recall` values. The `F1Score` is the harmonic average of the two
|
3032
|
+
# scores. The highest score is 1, and the worst score is 0.
|
3002
3033
|
# @return [Float]
|
3003
3034
|
#
|
3004
3035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesEvaluationMetrics AWS API Documentation
|
@@ -3039,6 +3070,120 @@ module Aws::Comprehend
|
|
3039
3070
|
include Aws::Structure
|
3040
3071
|
end
|
3041
3072
|
|
3073
|
+
# Provides information for filtering a list of event detection jobs.
|
3074
|
+
#
|
3075
|
+
# @note When making an API call, you may pass EventsDetectionJobFilter
|
3076
|
+
# data as a hash:
|
3077
|
+
#
|
3078
|
+
# {
|
3079
|
+
# job_name: "JobName",
|
3080
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3081
|
+
# submit_time_before: Time.now,
|
3082
|
+
# submit_time_after: Time.now,
|
3083
|
+
# }
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] job_name
|
3086
|
+
# Filters on the name of the events detection job.
|
3087
|
+
# @return [String]
|
3088
|
+
#
|
3089
|
+
# @!attribute [rw] job_status
|
3090
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
3091
|
+
# the specified status.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] submit_time_before
|
3095
|
+
# Filters the list of jobs based on the time that the job was
|
3096
|
+
# submitted for processing. Returns only jobs submitted before the
|
3097
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
3098
|
+
# newest.
|
3099
|
+
# @return [Time]
|
3100
|
+
#
|
3101
|
+
# @!attribute [rw] submit_time_after
|
3102
|
+
# Filters the list of jobs based on the time that the job was
|
3103
|
+
# submitted for processing. Returns only jobs submitted after the
|
3104
|
+
# specified time. Jobs are returned in descending order, newest to
|
3105
|
+
# oldest.
|
3106
|
+
# @return [Time]
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobFilter AWS API Documentation
|
3109
|
+
#
|
3110
|
+
class EventsDetectionJobFilter < Struct.new(
|
3111
|
+
:job_name,
|
3112
|
+
:job_status,
|
3113
|
+
:submit_time_before,
|
3114
|
+
:submit_time_after)
|
3115
|
+
SENSITIVE = []
|
3116
|
+
include Aws::Structure
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# Provides information about an events detection job.
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] job_id
|
3122
|
+
# The identifier assigned to the events detection job.
|
3123
|
+
# @return [String]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] job_name
|
3126
|
+
# The name you assigned the events detection job.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] job_status
|
3130
|
+
# The current status of the events detection job.
|
3131
|
+
# @return [String]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] message
|
3134
|
+
# A description of the status of the events detection job.
|
3135
|
+
# @return [String]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] submit_time
|
3138
|
+
# The time that the events detection job was submitted for processing.
|
3139
|
+
# @return [Time]
|
3140
|
+
#
|
3141
|
+
# @!attribute [rw] end_time
|
3142
|
+
# The time that the events detection job completed.
|
3143
|
+
# @return [Time]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] input_data_config
|
3146
|
+
# The input data configuration that you supplied when you created the
|
3147
|
+
# events detection job.
|
3148
|
+
# @return [Types::InputDataConfig]
|
3149
|
+
#
|
3150
|
+
# @!attribute [rw] output_data_config
|
3151
|
+
# The output data configuration that you supplied when you created the
|
3152
|
+
# events detection job.
|
3153
|
+
# @return [Types::OutputDataConfig]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] language_code
|
3156
|
+
# The language code of the input documents.
|
3157
|
+
# @return [String]
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] data_access_role_arn
|
3160
|
+
# The Amazon Resource Name (ARN) of the AWS Identify and Access
|
3161
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
3162
|
+
# your input data.
|
3163
|
+
# @return [String]
|
3164
|
+
#
|
3165
|
+
# @!attribute [rw] target_event_types
|
3166
|
+
# The types of events that are detected by the job.
|
3167
|
+
# @return [Array<String>]
|
3168
|
+
#
|
3169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobProperties AWS API Documentation
|
3170
|
+
#
|
3171
|
+
class EventsDetectionJobProperties < Struct.new(
|
3172
|
+
:job_id,
|
3173
|
+
:job_name,
|
3174
|
+
:job_status,
|
3175
|
+
:message,
|
3176
|
+
:submit_time,
|
3177
|
+
:end_time,
|
3178
|
+
:input_data_config,
|
3179
|
+
:output_data_config,
|
3180
|
+
:language_code,
|
3181
|
+
:data_access_role_arn,
|
3182
|
+
:target_event_types)
|
3183
|
+
SENSITIVE = []
|
3184
|
+
include Aws::Structure
|
3185
|
+
end
|
3186
|
+
|
3042
3187
|
# The input properties for a topic detection job.
|
3043
3188
|
#
|
3044
3189
|
# @note When making an API call, you may pass InputDataConfig
|
@@ -3658,6 +3803,61 @@ module Aws::Comprehend
|
|
3658
3803
|
include Aws::Structure
|
3659
3804
|
end
|
3660
3805
|
|
3806
|
+
# @note When making an API call, you may pass ListEventsDetectionJobsRequest
|
3807
|
+
# data as a hash:
|
3808
|
+
#
|
3809
|
+
# {
|
3810
|
+
# filter: {
|
3811
|
+
# job_name: "JobName",
|
3812
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3813
|
+
# submit_time_before: Time.now,
|
3814
|
+
# submit_time_after: Time.now,
|
3815
|
+
# },
|
3816
|
+
# next_token: "String",
|
3817
|
+
# max_results: 1,
|
3818
|
+
# }
|
3819
|
+
#
|
3820
|
+
# @!attribute [rw] filter
|
3821
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3822
|
+
# name, status, or the date and time that they were submitted. You can
|
3823
|
+
# only set one filter at a time.
|
3824
|
+
# @return [Types::EventsDetectionJobFilter]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] next_token
|
3827
|
+
# Identifies the next page of results to return.
|
3828
|
+
# @return [String]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] max_results
|
3831
|
+
# The maximum number of results to return in each page.
|
3832
|
+
# @return [Integer]
|
3833
|
+
#
|
3834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsRequest AWS API Documentation
|
3835
|
+
#
|
3836
|
+
class ListEventsDetectionJobsRequest < Struct.new(
|
3837
|
+
:filter,
|
3838
|
+
:next_token,
|
3839
|
+
:max_results)
|
3840
|
+
SENSITIVE = []
|
3841
|
+
include Aws::Structure
|
3842
|
+
end
|
3843
|
+
|
3844
|
+
# @!attribute [rw] events_detection_job_properties_list
|
3845
|
+
# A list containing the properties of each job that is returned.
|
3846
|
+
# @return [Array<Types::EventsDetectionJobProperties>]
|
3847
|
+
#
|
3848
|
+
# @!attribute [rw] next_token
|
3849
|
+
# Identifies the next page of results to return.
|
3850
|
+
# @return [String]
|
3851
|
+
#
|
3852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsResponse AWS API Documentation
|
3853
|
+
#
|
3854
|
+
class ListEventsDetectionJobsResponse < Struct.new(
|
3855
|
+
:events_detection_job_properties_list,
|
3856
|
+
:next_token)
|
3857
|
+
SENSITIVE = []
|
3858
|
+
include Aws::Structure
|
3859
|
+
end
|
3860
|
+
|
3661
3861
|
# @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
|
3662
3862
|
# data as a hash:
|
3663
3863
|
#
|
@@ -4824,6 +5024,91 @@ module Aws::Comprehend
|
|
4824
5024
|
include Aws::Structure
|
4825
5025
|
end
|
4826
5026
|
|
5027
|
+
# @note When making an API call, you may pass StartEventsDetectionJobRequest
|
5028
|
+
# data as a hash:
|
5029
|
+
#
|
5030
|
+
# {
|
5031
|
+
# input_data_config: { # required
|
5032
|
+
# s3_uri: "S3Uri", # required
|
5033
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5034
|
+
# },
|
5035
|
+
# output_data_config: { # required
|
5036
|
+
# s3_uri: "S3Uri", # required
|
5037
|
+
# kms_key_id: "KmsKeyId",
|
5038
|
+
# },
|
5039
|
+
# data_access_role_arn: "IamRoleArn", # required
|
5040
|
+
# job_name: "JobName",
|
5041
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5042
|
+
# client_request_token: "ClientRequestTokenString",
|
5043
|
+
# target_event_types: ["EventTypeString"], # required
|
5044
|
+
# }
|
5045
|
+
#
|
5046
|
+
# @!attribute [rw] input_data_config
|
5047
|
+
# Specifies the format and location of the input data for the job.
|
5048
|
+
# @return [Types::InputDataConfig]
|
5049
|
+
#
|
5050
|
+
# @!attribute [rw] output_data_config
|
5051
|
+
# Specifies where to send the output files.
|
5052
|
+
# @return [Types::OutputDataConfig]
|
5053
|
+
#
|
5054
|
+
# @!attribute [rw] data_access_role_arn
|
5055
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
5056
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
5057
|
+
# your input data.
|
5058
|
+
# @return [String]
|
5059
|
+
#
|
5060
|
+
# @!attribute [rw] job_name
|
5061
|
+
# The identifier of the events detection job.
|
5062
|
+
# @return [String]
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] language_code
|
5065
|
+
# The language code of the input documents.
|
5066
|
+
# @return [String]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] client_request_token
|
5069
|
+
# An unique identifier for the request. If you don't set the client
|
5070
|
+
# request token, Amazon Comprehend generates one.
|
5071
|
+
#
|
5072
|
+
# **A suitable default value is auto-generated.** You should normally
|
5073
|
+
# not need to pass this option.
|
5074
|
+
# @return [String]
|
5075
|
+
#
|
5076
|
+
# @!attribute [rw] target_event_types
|
5077
|
+
# The types of events to detect in the input documents.
|
5078
|
+
# @return [Array<String>]
|
5079
|
+
#
|
5080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5081
|
+
#
|
5082
|
+
class StartEventsDetectionJobRequest < Struct.new(
|
5083
|
+
:input_data_config,
|
5084
|
+
:output_data_config,
|
5085
|
+
:data_access_role_arn,
|
5086
|
+
:job_name,
|
5087
|
+
:language_code,
|
5088
|
+
:client_request_token,
|
5089
|
+
:target_event_types)
|
5090
|
+
SENSITIVE = []
|
5091
|
+
include Aws::Structure
|
5092
|
+
end
|
5093
|
+
|
5094
|
+
# @!attribute [rw] job_id
|
5095
|
+
# An unique identifier for the request. If you don't set the client
|
5096
|
+
# request token, Amazon Comprehend generates one.
|
5097
|
+
# @return [String]
|
5098
|
+
#
|
5099
|
+
# @!attribute [rw] job_status
|
5100
|
+
# The status of the events detection job.
|
5101
|
+
# @return [String]
|
5102
|
+
#
|
5103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobResponse AWS API Documentation
|
5104
|
+
#
|
5105
|
+
class StartEventsDetectionJobResponse < Struct.new(
|
5106
|
+
:job_id,
|
5107
|
+
:job_status)
|
5108
|
+
SENSITIVE = []
|
5109
|
+
include Aws::Structure
|
5110
|
+
end
|
5111
|
+
|
4827
5112
|
# @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
|
4828
5113
|
# data as a hash:
|
4829
5114
|
#
|
@@ -5379,6 +5664,42 @@ module Aws::Comprehend
|
|
5379
5664
|
include Aws::Structure
|
5380
5665
|
end
|
5381
5666
|
|
5667
|
+
# @note When making an API call, you may pass StopEventsDetectionJobRequest
|
5668
|
+
# data as a hash:
|
5669
|
+
#
|
5670
|
+
# {
|
5671
|
+
# job_id: "JobId", # required
|
5672
|
+
# }
|
5673
|
+
#
|
5674
|
+
# @!attribute [rw] job_id
|
5675
|
+
# The identifier of the events detection job to stop.
|
5676
|
+
# @return [String]
|
5677
|
+
#
|
5678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobRequest AWS API Documentation
|
5679
|
+
#
|
5680
|
+
class StopEventsDetectionJobRequest < Struct.new(
|
5681
|
+
:job_id)
|
5682
|
+
SENSITIVE = []
|
5683
|
+
include Aws::Structure
|
5684
|
+
end
|
5685
|
+
|
5686
|
+
# @!attribute [rw] job_id
|
5687
|
+
# The identifier of the events detection job to stop.
|
5688
|
+
# @return [String]
|
5689
|
+
#
|
5690
|
+
# @!attribute [rw] job_status
|
5691
|
+
# The status of the events detection job.
|
5692
|
+
# @return [String]
|
5693
|
+
#
|
5694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobResponse AWS API Documentation
|
5695
|
+
#
|
5696
|
+
class StopEventsDetectionJobResponse < Struct.new(
|
5697
|
+
:job_id,
|
5698
|
+
:job_status)
|
5699
|
+
SENSITIVE = []
|
5700
|
+
include Aws::Structure
|
5701
|
+
end
|
5702
|
+
|
5382
5703
|
# @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
|
5383
5704
|
# data as a hash:
|
5384
5705
|
#
|
@@ -5929,7 +6250,7 @@ module Aws::Comprehend
|
|
5929
6250
|
class UpdateEndpointResponse < Aws::EmptyStructure; end
|
5930
6251
|
|
5931
6252
|
# Configuration parameters for an optional private Virtual Private Cloud
|
5932
|
-
# (VPC) containing the resources you are using for the job. For
|
6253
|
+
# (VPC) containing the resources you are using for the job. For more
|
5933
6254
|
# information, see [Amazon VPC][1].
|
5934
6255
|
#
|
5935
6256
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-comprehend
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.42.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-11-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|