aws-sdk-comprehend 1.41.0 → 1.46.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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 multually
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.
@@ -632,6 +632,46 @@ module Aws::Comprehend
632
632
  include Aws::Structure
633
633
  end
634
634
 
635
+ # @note When making an API call, you may pass ContainsPiiEntitiesRequest
636
+ # data as a hash:
637
+ #
638
+ # {
639
+ # text: "String", # required
640
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
641
+ # }
642
+ #
643
+ # @!attribute [rw] text
644
+ # Creates a new document classification request to analyze a single
645
+ # document in real-time, returning personally identifiable information
646
+ # (PII) entity labels.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] language_code
650
+ # The language of the input documents.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
654
+ #
655
+ class ContainsPiiEntitiesRequest < Struct.new(
656
+ :text,
657
+ :language_code)
658
+ SENSITIVE = []
659
+ include Aws::Structure
660
+ end
661
+
662
+ # @!attribute [rw] labels
663
+ # The labels used in the document being analyzed. Individual labels
664
+ # represent personally identifiable information (PII) entity types.
665
+ # @return [Array<Types::EntityLabel>]
666
+ #
667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesResponse AWS API Documentation
668
+ #
669
+ class ContainsPiiEntitiesResponse < Struct.new(
670
+ :labels)
671
+ SENSITIVE = []
672
+ include Aws::Structure
673
+ end
674
+
635
675
  # @note When making an API call, you may pass CreateDocumentClassifierRequest
636
676
  # data as a hash:
637
677
  #
@@ -667,6 +707,7 @@ module Aws::Comprehend
667
707
  # subnets: ["SubnetId"], # required
668
708
  # },
669
709
  # mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
710
+ # model_kms_key_id: "KmsKeyId",
670
711
  # }
671
712
  #
672
713
  # @!attribute [rw] document_classifier_name
@@ -743,6 +784,17 @@ module Aws::Comprehend
743
784
  # delimiter. The default delimiter between labels is a pipe (\|).
744
785
  # @return [String]
745
786
  #
787
+ # @!attribute [rw] model_kms_key_id
788
+ # ID for the AWS Key Management Service (KMS) key that Amazon
789
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
790
+ # can be either of the following formats:
791
+ #
792
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
793
+ #
794
+ # * Amazon Resource Name (ARN) of a KMS Key:
795
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
796
+ # @return [String]
797
+ #
746
798
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
747
799
  #
748
800
  class CreateDocumentClassifierRequest < Struct.new(
@@ -755,7 +807,8 @@ module Aws::Comprehend
755
807
  :language_code,
756
808
  :volume_kms_key_id,
757
809
  :vpc_config,
758
- :mode)
810
+ :mode,
811
+ :model_kms_key_id)
759
812
  SENSITIVE = []
760
813
  include Aws::Structure
761
814
  end
@@ -787,6 +840,7 @@ module Aws::Comprehend
787
840
  # value: "TagValue",
788
841
  # },
789
842
  # ],
843
+ # data_access_role_arn: "IamRoleArn",
790
844
  # }
791
845
  #
792
846
  # @!attribute [rw] endpoint_name
@@ -821,6 +875,13 @@ module Aws::Comprehend
821
875
  # indicate its use by the sales department.
822
876
  # @return [Array<Types::Tag>]
823
877
  #
878
+ # @!attribute [rw] data_access_role_arn
879
+ # The Amazon Resource Name (ARN) of the AWS identity and Access
880
+ # Management (IAM) role that grants Amazon Comprehend read access to
881
+ # trained custom models encrypted with a customer managed key
882
+ # (ModelKmsKeyId).
883
+ # @return [String]
884
+ #
824
885
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
825
886
  #
826
887
  class CreateEndpointRequest < Struct.new(
@@ -828,7 +889,8 @@ module Aws::Comprehend
828
889
  :model_arn,
829
890
  :desired_inference_units,
830
891
  :client_request_token,
831
- :tags)
892
+ :tags,
893
+ :data_access_role_arn)
832
894
  SENSITIVE = []
833
895
  include Aws::Structure
834
896
  end
@@ -887,6 +949,7 @@ module Aws::Comprehend
887
949
  # security_group_ids: ["SecurityGroupId"], # required
888
950
  # subnets: ["SubnetId"], # required
889
951
  # },
952
+ # model_kms_key_id: "KmsKeyId",
890
953
  # }
891
954
  #
892
955
  # @!attribute [rw] recognizer_name
@@ -953,6 +1016,17 @@ module Aws::Comprehend
953
1016
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
954
1017
  # @return [Types::VpcConfig]
955
1018
  #
1019
+ # @!attribute [rw] model_kms_key_id
1020
+ # ID for the AWS Key Management Service (KMS) key that Amazon
1021
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1022
+ # can be either of the following formats
1023
+ #
1024
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1025
+ #
1026
+ # * Amazon Resource Name (ARN) of a KMS Key:
1027
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
1028
+ # @return [String]
1029
+ #
956
1030
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
957
1031
  #
958
1032
  class CreateEntityRecognizerRequest < Struct.new(
@@ -963,7 +1037,8 @@ module Aws::Comprehend
963
1037
  :client_request_token,
964
1038
  :language_code,
965
1039
  :volume_kms_key_id,
966
- :vpc_config)
1040
+ :vpc_config,
1041
+ :model_kms_key_id)
967
1042
  SENSITIVE = []
968
1043
  include Aws::Structure
969
1044
  end
@@ -1247,6 +1322,38 @@ module Aws::Comprehend
1247
1322
  include Aws::Structure
1248
1323
  end
1249
1324
 
1325
+ # @note When making an API call, you may pass DescribeEventsDetectionJobRequest
1326
+ # data as a hash:
1327
+ #
1328
+ # {
1329
+ # job_id: "JobId", # required
1330
+ # }
1331
+ #
1332
+ # @!attribute [rw] job_id
1333
+ # The identifier of the events detection job.
1334
+ # @return [String]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobRequest AWS API Documentation
1337
+ #
1338
+ class DescribeEventsDetectionJobRequest < Struct.new(
1339
+ :job_id)
1340
+ SENSITIVE = []
1341
+ include Aws::Structure
1342
+ end
1343
+
1344
+ # @!attribute [rw] events_detection_job_properties
1345
+ # An object that contains the properties associated with an event
1346
+ # detection job.
1347
+ # @return [Types::EventsDetectionJobProperties]
1348
+ #
1349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobResponse AWS API Documentation
1350
+ #
1351
+ class DescribeEventsDetectionJobResponse < Struct.new(
1352
+ :events_detection_job_properties)
1353
+ SENSITIVE = []
1354
+ include Aws::Structure
1355
+ end
1356
+
1250
1357
  # @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
1251
1358
  # data as a hash:
1252
1359
  #
@@ -2088,6 +2195,17 @@ module Aws::Comprehend
2088
2195
  # mode and this cannot be changed once the classifier is trained.
2089
2196
  # @return [String]
2090
2197
  #
2198
+ # @!attribute [rw] model_kms_key_id
2199
+ # ID for the AWS Key Management Service (KMS) key that Amazon
2200
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
2201
+ # can be either of the following formats:
2202
+ #
2203
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2204
+ #
2205
+ # * Amazon Resource Name (ARN) of a KMS Key:
2206
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
2207
+ # @return [String]
2208
+ #
2091
2209
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
2092
2210
  #
2093
2211
  class DocumentClassifierProperties < Struct.new(
@@ -2105,7 +2223,8 @@ module Aws::Comprehend
2105
2223
  :data_access_role_arn,
2106
2224
  :volume_kms_key_id,
2107
2225
  :vpc_config,
2108
- :mode)
2226
+ :mode,
2227
+ :model_kms_key_id)
2109
2228
  SENSITIVE = [:classifier_metadata]
2110
2229
  include Aws::Structure
2111
2230
  end
@@ -2290,7 +2409,7 @@ module Aws::Comprehend
2290
2409
  include Aws::Structure
2291
2410
  end
2292
2411
 
2293
- # The filter used to determine which endpoints are are returned. You can
2412
+ # The filter used to determine which endpoints are returned. You can
2294
2413
  # filter jobs on their name, model, status, or the date and time that
2295
2414
  # they were created. You can only set one filter at a time.
2296
2415
  #
@@ -2375,6 +2494,13 @@ module Aws::Comprehend
2375
2494
  # The date and time that the endpoint was last modified.
2376
2495
  # @return [Time]
2377
2496
  #
2497
+ # @!attribute [rw] data_access_role_arn
2498
+ # The Amazon Resource Name (ARN) of the AWS identity and Access
2499
+ # Management (IAM) role that grants Amazon Comprehend read access to
2500
+ # trained custom models encrypted with a customer managed key
2501
+ # (ModelKmsKeyId).
2502
+ # @return [String]
2503
+ #
2378
2504
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
2379
2505
  #
2380
2506
  class EndpointProperties < Struct.new(
@@ -2385,7 +2511,8 @@ module Aws::Comprehend
2385
2511
  :desired_inference_units,
2386
2512
  :current_inference_units,
2387
2513
  :creation_time,
2388
- :last_modified_time)
2514
+ :last_modified_time,
2515
+ :data_access_role_arn)
2389
2516
  SENSITIVE = []
2390
2517
  include Aws::Structure
2391
2518
  end
@@ -2575,6 +2702,27 @@ module Aws::Comprehend
2575
2702
  include Aws::Structure
2576
2703
  end
2577
2704
 
2705
+ # Specifies one of the label or labels that categorize the personally
2706
+ # identifiable information (PII) entity being analyzed.
2707
+ #
2708
+ # @!attribute [rw] name
2709
+ # The name of the label.
2710
+ # @return [String]
2711
+ #
2712
+ # @!attribute [rw] score
2713
+ # The level of confidence that Amazon Comprehend has in the accuracy
2714
+ # of the detection.
2715
+ # @return [Float]
2716
+ #
2717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityLabel AWS API Documentation
2718
+ #
2719
+ class EntityLabel < Struct.new(
2720
+ :name,
2721
+ :score)
2722
+ SENSITIVE = []
2723
+ include Aws::Structure
2724
+ end
2725
+
2578
2726
  # Describes the annotations associated with a entity recognizer.
2579
2727
  #
2580
2728
  # @note When making an API call, you may pass EntityRecognizerAnnotations
@@ -2957,6 +3105,17 @@ module Aws::Comprehend
2957
3105
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
2958
3106
  # @return [Types::VpcConfig]
2959
3107
  #
3108
+ # @!attribute [rw] model_kms_key_id
3109
+ # ID for the AWS Key Management Service (KMS) key that Amazon
3110
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
3111
+ # can be either of the following formats:
3112
+ #
3113
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3114
+ #
3115
+ # * Amazon Resource Name (ARN) of a KMS Key:
3116
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
3117
+ # @return [String]
3118
+ #
2960
3119
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
2961
3120
  #
2962
3121
  class EntityRecognizerProperties < Struct.new(
@@ -2972,7 +3131,8 @@ module Aws::Comprehend
2972
3131
  :recognizer_metadata,
2973
3132
  :data_access_role_arn,
2974
3133
  :volume_kms_key_id,
2975
- :vpc_config)
3134
+ :vpc_config,
3135
+ :model_kms_key_id)
2976
3136
  SENSITIVE = [:recognizer_metadata]
2977
3137
  include Aws::Structure
2978
3138
  end
@@ -2994,11 +3154,10 @@ module Aws::Comprehend
2994
3154
  # @return [Float]
2995
3155
  #
2996
3156
  # @!attribute [rw] f1_score
2997
- # A measure of how accurate the recognizer results are for for a
2998
- # specific entity type in the test data. It is derived from the
2999
- # `Precision` and `Recall` values. The `F1Score` is the harmonic
3000
- # average of the two scores. The highest score is 1, and the worst
3001
- # score is 0.
3157
+ # A measure of how accurate the recognizer results are for a specific
3158
+ # entity type in the test data. It is derived from the `Precision` and
3159
+ # `Recall` values. The `F1Score` is the harmonic average of the two
3160
+ # scores. The highest score is 1, and the worst score is 0.
3002
3161
  # @return [Float]
3003
3162
  #
3004
3163
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesEvaluationMetrics AWS API Documentation
@@ -3039,6 +3198,120 @@ module Aws::Comprehend
3039
3198
  include Aws::Structure
3040
3199
  end
3041
3200
 
3201
+ # Provides information for filtering a list of event detection jobs.
3202
+ #
3203
+ # @note When making an API call, you may pass EventsDetectionJobFilter
3204
+ # data as a hash:
3205
+ #
3206
+ # {
3207
+ # job_name: "JobName",
3208
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3209
+ # submit_time_before: Time.now,
3210
+ # submit_time_after: Time.now,
3211
+ # }
3212
+ #
3213
+ # @!attribute [rw] job_name
3214
+ # Filters on the name of the events detection job.
3215
+ # @return [String]
3216
+ #
3217
+ # @!attribute [rw] job_status
3218
+ # Filters the list of jobs based on job status. Returns only jobs with
3219
+ # the specified status.
3220
+ # @return [String]
3221
+ #
3222
+ # @!attribute [rw] submit_time_before
3223
+ # Filters the list of jobs based on the time that the job was
3224
+ # submitted for processing. Returns only jobs submitted before the
3225
+ # specified time. Jobs are returned in ascending order, oldest to
3226
+ # newest.
3227
+ # @return [Time]
3228
+ #
3229
+ # @!attribute [rw] submit_time_after
3230
+ # Filters the list of jobs based on the time that the job was
3231
+ # submitted for processing. Returns only jobs submitted after the
3232
+ # specified time. Jobs are returned in descending order, newest to
3233
+ # oldest.
3234
+ # @return [Time]
3235
+ #
3236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobFilter AWS API Documentation
3237
+ #
3238
+ class EventsDetectionJobFilter < Struct.new(
3239
+ :job_name,
3240
+ :job_status,
3241
+ :submit_time_before,
3242
+ :submit_time_after)
3243
+ SENSITIVE = []
3244
+ include Aws::Structure
3245
+ end
3246
+
3247
+ # Provides information about an events detection job.
3248
+ #
3249
+ # @!attribute [rw] job_id
3250
+ # The identifier assigned to the events detection job.
3251
+ # @return [String]
3252
+ #
3253
+ # @!attribute [rw] job_name
3254
+ # The name you assigned the events detection job.
3255
+ # @return [String]
3256
+ #
3257
+ # @!attribute [rw] job_status
3258
+ # The current status of the events detection job.
3259
+ # @return [String]
3260
+ #
3261
+ # @!attribute [rw] message
3262
+ # A description of the status of the events detection job.
3263
+ # @return [String]
3264
+ #
3265
+ # @!attribute [rw] submit_time
3266
+ # The time that the events detection job was submitted for processing.
3267
+ # @return [Time]
3268
+ #
3269
+ # @!attribute [rw] end_time
3270
+ # The time that the events detection job completed.
3271
+ # @return [Time]
3272
+ #
3273
+ # @!attribute [rw] input_data_config
3274
+ # The input data configuration that you supplied when you created the
3275
+ # events detection job.
3276
+ # @return [Types::InputDataConfig]
3277
+ #
3278
+ # @!attribute [rw] output_data_config
3279
+ # The output data configuration that you supplied when you created the
3280
+ # events detection job.
3281
+ # @return [Types::OutputDataConfig]
3282
+ #
3283
+ # @!attribute [rw] language_code
3284
+ # The language code of the input documents.
3285
+ # @return [String]
3286
+ #
3287
+ # @!attribute [rw] data_access_role_arn
3288
+ # The Amazon Resource Name (ARN) of the AWS Identify and Access
3289
+ # Management (IAM) role that grants Amazon Comprehend read access to
3290
+ # your input data.
3291
+ # @return [String]
3292
+ #
3293
+ # @!attribute [rw] target_event_types
3294
+ # The types of events that are detected by the job.
3295
+ # @return [Array<String>]
3296
+ #
3297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobProperties AWS API Documentation
3298
+ #
3299
+ class EventsDetectionJobProperties < Struct.new(
3300
+ :job_id,
3301
+ :job_name,
3302
+ :job_status,
3303
+ :message,
3304
+ :submit_time,
3305
+ :end_time,
3306
+ :input_data_config,
3307
+ :output_data_config,
3308
+ :language_code,
3309
+ :data_access_role_arn,
3310
+ :target_event_types)
3311
+ SENSITIVE = []
3312
+ include Aws::Structure
3313
+ end
3314
+
3042
3315
  # The input properties for a topic detection job.
3043
3316
  #
3044
3317
  # @note When making an API call, you may pass InputDataConfig
@@ -3658,6 +3931,61 @@ module Aws::Comprehend
3658
3931
  include Aws::Structure
3659
3932
  end
3660
3933
 
3934
+ # @note When making an API call, you may pass ListEventsDetectionJobsRequest
3935
+ # data as a hash:
3936
+ #
3937
+ # {
3938
+ # filter: {
3939
+ # job_name: "JobName",
3940
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
3941
+ # submit_time_before: Time.now,
3942
+ # submit_time_after: Time.now,
3943
+ # },
3944
+ # next_token: "String",
3945
+ # max_results: 1,
3946
+ # }
3947
+ #
3948
+ # @!attribute [rw] filter
3949
+ # Filters the jobs that are returned. You can filter jobs on their
3950
+ # name, status, or the date and time that they were submitted. You can
3951
+ # only set one filter at a time.
3952
+ # @return [Types::EventsDetectionJobFilter]
3953
+ #
3954
+ # @!attribute [rw] next_token
3955
+ # Identifies the next page of results to return.
3956
+ # @return [String]
3957
+ #
3958
+ # @!attribute [rw] max_results
3959
+ # The maximum number of results to return in each page.
3960
+ # @return [Integer]
3961
+ #
3962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsRequest AWS API Documentation
3963
+ #
3964
+ class ListEventsDetectionJobsRequest < Struct.new(
3965
+ :filter,
3966
+ :next_token,
3967
+ :max_results)
3968
+ SENSITIVE = []
3969
+ include Aws::Structure
3970
+ end
3971
+
3972
+ # @!attribute [rw] events_detection_job_properties_list
3973
+ # A list containing the properties of each job that is returned.
3974
+ # @return [Array<Types::EventsDetectionJobProperties>]
3975
+ #
3976
+ # @!attribute [rw] next_token
3977
+ # Identifies the next page of results to return.
3978
+ # @return [String]
3979
+ #
3980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsResponse AWS API Documentation
3981
+ #
3982
+ class ListEventsDetectionJobsResponse < Struct.new(
3983
+ :events_detection_job_properties_list,
3984
+ :next_token)
3985
+ SENSITIVE = []
3986
+ include Aws::Structure
3987
+ end
3988
+
3661
3989
  # @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
3662
3990
  # data as a hash:
3663
3991
  #
@@ -4824,6 +5152,91 @@ module Aws::Comprehend
4824
5152
  include Aws::Structure
4825
5153
  end
4826
5154
 
5155
+ # @note When making an API call, you may pass StartEventsDetectionJobRequest
5156
+ # data as a hash:
5157
+ #
5158
+ # {
5159
+ # input_data_config: { # required
5160
+ # s3_uri: "S3Uri", # required
5161
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
5162
+ # },
5163
+ # output_data_config: { # required
5164
+ # s3_uri: "S3Uri", # required
5165
+ # kms_key_id: "KmsKeyId",
5166
+ # },
5167
+ # data_access_role_arn: "IamRoleArn", # required
5168
+ # job_name: "JobName",
5169
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
5170
+ # client_request_token: "ClientRequestTokenString",
5171
+ # target_event_types: ["EventTypeString"], # required
5172
+ # }
5173
+ #
5174
+ # @!attribute [rw] input_data_config
5175
+ # Specifies the format and location of the input data for the job.
5176
+ # @return [Types::InputDataConfig]
5177
+ #
5178
+ # @!attribute [rw] output_data_config
5179
+ # Specifies where to send the output files.
5180
+ # @return [Types::OutputDataConfig]
5181
+ #
5182
+ # @!attribute [rw] data_access_role_arn
5183
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
5184
+ # Management (IAM) role that grants Amazon Comprehend read access to
5185
+ # your input data.
5186
+ # @return [String]
5187
+ #
5188
+ # @!attribute [rw] job_name
5189
+ # The identifier of the events detection job.
5190
+ # @return [String]
5191
+ #
5192
+ # @!attribute [rw] language_code
5193
+ # The language code of the input documents.
5194
+ # @return [String]
5195
+ #
5196
+ # @!attribute [rw] client_request_token
5197
+ # An unique identifier for the request. If you don't set the client
5198
+ # request token, Amazon Comprehend generates one.
5199
+ #
5200
+ # **A suitable default value is auto-generated.** You should normally
5201
+ # not need to pass this option.
5202
+ # @return [String]
5203
+ #
5204
+ # @!attribute [rw] target_event_types
5205
+ # The types of events to detect in the input documents.
5206
+ # @return [Array<String>]
5207
+ #
5208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
5209
+ #
5210
+ class StartEventsDetectionJobRequest < Struct.new(
5211
+ :input_data_config,
5212
+ :output_data_config,
5213
+ :data_access_role_arn,
5214
+ :job_name,
5215
+ :language_code,
5216
+ :client_request_token,
5217
+ :target_event_types)
5218
+ SENSITIVE = []
5219
+ include Aws::Structure
5220
+ end
5221
+
5222
+ # @!attribute [rw] job_id
5223
+ # An unique identifier for the request. If you don't set the client
5224
+ # request token, Amazon Comprehend generates one.
5225
+ # @return [String]
5226
+ #
5227
+ # @!attribute [rw] job_status
5228
+ # The status of the events detection job.
5229
+ # @return [String]
5230
+ #
5231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobResponse AWS API Documentation
5232
+ #
5233
+ class StartEventsDetectionJobResponse < Struct.new(
5234
+ :job_id,
5235
+ :job_status)
5236
+ SENSITIVE = []
5237
+ include Aws::Structure
5238
+ end
5239
+
4827
5240
  # @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
4828
5241
  # data as a hash:
4829
5242
  #
@@ -5379,6 +5792,42 @@ module Aws::Comprehend
5379
5792
  include Aws::Structure
5380
5793
  end
5381
5794
 
5795
+ # @note When making an API call, you may pass StopEventsDetectionJobRequest
5796
+ # data as a hash:
5797
+ #
5798
+ # {
5799
+ # job_id: "JobId", # required
5800
+ # }
5801
+ #
5802
+ # @!attribute [rw] job_id
5803
+ # The identifier of the events detection job to stop.
5804
+ # @return [String]
5805
+ #
5806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobRequest AWS API Documentation
5807
+ #
5808
+ class StopEventsDetectionJobRequest < Struct.new(
5809
+ :job_id)
5810
+ SENSITIVE = []
5811
+ include Aws::Structure
5812
+ end
5813
+
5814
+ # @!attribute [rw] job_id
5815
+ # The identifier of the events detection job to stop.
5816
+ # @return [String]
5817
+ #
5818
+ # @!attribute [rw] job_status
5819
+ # The status of the events detection job.
5820
+ # @return [String]
5821
+ #
5822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobResponse AWS API Documentation
5823
+ #
5824
+ class StopEventsDetectionJobResponse < Struct.new(
5825
+ :job_id,
5826
+ :job_status)
5827
+ SENSITIVE = []
5828
+ include Aws::Structure
5829
+ end
5830
+
5382
5831
  # @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
5383
5832
  # data as a hash:
5384
5833
  #
@@ -5846,11 +6295,9 @@ module Aws::Comprehend
5846
6295
  end
5847
6296
 
5848
6297
  # Amazon Comprehend can't process the language of the input text. For
5849
- # all custom entity recognition APIs (such as `CreateEntityRecognizer`),
5850
- # only English, Spanish, French, Italian, German, or Portuguese are
5851
- # accepted. For most other APIs, such as those for Custom
5852
- # Classification, Amazon Comprehend accepts text in all supported
5853
- # languages. For a list of supported languages, see supported-languages.
6298
+ # custom entity recognition APIs, only English, Spanish, French,
6299
+ # Italian, German, or Portuguese are accepted. For a list of supported
6300
+ # languages, see supported-languages.
5854
6301
  #
5855
6302
  # @!attribute [rw] message
5856
6303
  # @return [String]
@@ -5929,7 +6376,7 @@ module Aws::Comprehend
5929
6376
  class UpdateEndpointResponse < Aws::EmptyStructure; end
5930
6377
 
5931
6378
  # Configuration parameters for an optional private Virtual Private Cloud
5932
- # (VPC) containing the resources you are using for the job. For For more
6379
+ # (VPC) containing the resources you are using for the job. For more
5933
6380
  # information, see [Amazon VPC][1].
5934
6381
  #
5935
6382
  #