aws-sdk-comprehend 1.48.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +129 -1
- data/lib/aws-sdk-comprehend/client_api.rb +32 -0
- data/lib/aws-sdk-comprehend/types.rb +345 -8
- metadata +2 -2
@@ -1841,6 +1841,19 @@ module Aws::Comprehend
|
|
1841
1841
|
# The identifier assigned to the document classification job.
|
1842
1842
|
# @return [String]
|
1843
1843
|
#
|
1844
|
+
# @!attribute [rw] job_arn
|
1845
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
1846
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
1847
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
1848
|
+
# follows:
|
1849
|
+
#
|
1850
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
1851
|
+
#
|
1852
|
+
# The following is an example job ARN:
|
1853
|
+
#
|
1854
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
1855
|
+
# @return [String]
|
1856
|
+
#
|
1844
1857
|
# @!attribute [rw] job_name
|
1845
1858
|
# The name that you assigned to the document classification job.
|
1846
1859
|
# @return [String]
|
@@ -1910,6 +1923,7 @@ module Aws::Comprehend
|
|
1910
1923
|
#
|
1911
1924
|
class DocumentClassificationJobProperties < Struct.new(
|
1912
1925
|
:job_id,
|
1926
|
+
:job_arn,
|
1913
1927
|
:job_name,
|
1914
1928
|
:job_status,
|
1915
1929
|
:message,
|
@@ -2331,6 +2345,19 @@ module Aws::Comprehend
|
|
2331
2345
|
# The identifier assigned to the dominant language detection job.
|
2332
2346
|
# @return [String]
|
2333
2347
|
#
|
2348
|
+
# @!attribute [rw] job_arn
|
2349
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
2350
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
2351
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
2352
|
+
# ARN is as follows:
|
2353
|
+
#
|
2354
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
2355
|
+
#
|
2356
|
+
# The following is an example job ARN:
|
2357
|
+
#
|
2358
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2359
|
+
# @return [String]
|
2360
|
+
#
|
2334
2361
|
# @!attribute [rw] job_name
|
2335
2362
|
# The name that you assigned to the dominant language detection job.
|
2336
2363
|
# @return [String]
|
@@ -2395,6 +2422,7 @@ module Aws::Comprehend
|
|
2395
2422
|
#
|
2396
2423
|
class DominantLanguageDetectionJobProperties < Struct.new(
|
2397
2424
|
:job_id,
|
2425
|
+
:job_arn,
|
2398
2426
|
:job_name,
|
2399
2427
|
:job_status,
|
2400
2428
|
:message,
|
@@ -2570,6 +2598,19 @@ module Aws::Comprehend
|
|
2570
2598
|
# The identifier assigned to the entities detection job.
|
2571
2599
|
# @return [String]
|
2572
2600
|
#
|
2601
|
+
# @!attribute [rw] job_arn
|
2602
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
2603
|
+
# a unique, fully qualified identifier for the job. It includes the
|
2604
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
2605
|
+
# follows:
|
2606
|
+
#
|
2607
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
2608
|
+
#
|
2609
|
+
# The following is an example job ARN:
|
2610
|
+
#
|
2611
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2612
|
+
# @return [String]
|
2613
|
+
#
|
2573
2614
|
# @!attribute [rw] job_name
|
2574
2615
|
# The name that you assigned the entities detection job.
|
2575
2616
|
# @return [String]
|
@@ -2642,6 +2683,7 @@ module Aws::Comprehend
|
|
2642
2683
|
#
|
2643
2684
|
class EntitiesDetectionJobProperties < Struct.new(
|
2644
2685
|
:job_id,
|
2686
|
+
:job_arn,
|
2645
2687
|
:job_name,
|
2646
2688
|
:job_status,
|
2647
2689
|
:message,
|
@@ -3250,6 +3292,19 @@ module Aws::Comprehend
|
|
3250
3292
|
# The identifier assigned to the events detection job.
|
3251
3293
|
# @return [String]
|
3252
3294
|
#
|
3295
|
+
# @!attribute [rw] job_arn
|
3296
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
3297
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
3298
|
+
# account, Region, and the job ID. The format of the ARN is as
|
3299
|
+
# follows:
|
3300
|
+
#
|
3301
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
3302
|
+
#
|
3303
|
+
# The following is an example job ARN:
|
3304
|
+
#
|
3305
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3306
|
+
# @return [String]
|
3307
|
+
#
|
3253
3308
|
# @!attribute [rw] job_name
|
3254
3309
|
# The name you assigned the events detection job.
|
3255
3310
|
# @return [String]
|
@@ -3298,6 +3353,7 @@ module Aws::Comprehend
|
|
3298
3353
|
#
|
3299
3354
|
class EventsDetectionJobProperties < Struct.new(
|
3300
3355
|
:job_id,
|
3356
|
+
:job_arn,
|
3301
3357
|
:job_name,
|
3302
3358
|
:job_status,
|
3303
3359
|
:message,
|
@@ -3500,6 +3556,19 @@ module Aws::Comprehend
|
|
3500
3556
|
# The identifier assigned to the key phrases detection job.
|
3501
3557
|
# @return [String]
|
3502
3558
|
#
|
3559
|
+
# @!attribute [rw] job_arn
|
3560
|
+
# The Amazon Resource Name (ARN) of the key phrases detection job. It
|
3561
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
3562
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
3563
|
+
# follows:
|
3564
|
+
#
|
3565
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
3566
|
+
#
|
3567
|
+
# The following is an example job ARN:
|
3568
|
+
#
|
3569
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3570
|
+
# @return [String]
|
3571
|
+
#
|
3503
3572
|
# @!attribute [rw] job_name
|
3504
3573
|
# The name that you assigned the key phrases detection job.
|
3505
3574
|
# @return [String]
|
@@ -3567,6 +3636,7 @@ module Aws::Comprehend
|
|
3567
3636
|
#
|
3568
3637
|
class KeyPhrasesDetectionJobProperties < Struct.new(
|
3569
3638
|
:job_id,
|
3639
|
+
:job_arn,
|
3570
3640
|
:job_name,
|
3571
3641
|
:job_status,
|
3572
3642
|
:message,
|
@@ -4376,6 +4446,19 @@ module Aws::Comprehend
|
|
4376
4446
|
# The identifier assigned to the PII entities detection job.
|
4377
4447
|
# @return [String]
|
4378
4448
|
#
|
4449
|
+
# @!attribute [rw] job_arn
|
4450
|
+
# The Amazon Resource Name (ARN) of the PII entities detection job. It
|
4451
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
4452
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
4453
|
+
# follows:
|
4454
|
+
#
|
4455
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
4456
|
+
#
|
4457
|
+
# The following is an example job ARN:
|
4458
|
+
#
|
4459
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
4460
|
+
# @return [String]
|
4461
|
+
#
|
4379
4462
|
# @!attribute [rw] job_name
|
4380
4463
|
# The name that you assigned the PII entities detection job.
|
4381
4464
|
# @return [String]
|
@@ -4433,6 +4516,7 @@ module Aws::Comprehend
|
|
4433
4516
|
#
|
4434
4517
|
class PiiEntitiesDetectionJobProperties < Struct.new(
|
4435
4518
|
:job_id,
|
4519
|
+
:job_arn,
|
4436
4520
|
:job_name,
|
4437
4521
|
:job_status,
|
4438
4522
|
:message,
|
@@ -4654,6 +4738,19 @@ module Aws::Comprehend
|
|
4654
4738
|
# The identifier assigned to the sentiment detection job.
|
4655
4739
|
# @return [String]
|
4656
4740
|
#
|
4741
|
+
# @!attribute [rw] job_arn
|
4742
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
4743
|
+
# a unique, fully qualified identifier for the job. It includes the
|
4744
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
4745
|
+
# follows:
|
4746
|
+
#
|
4747
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
4748
|
+
#
|
4749
|
+
# The following is an example job ARN:
|
4750
|
+
#
|
4751
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
4752
|
+
# @return [String]
|
4753
|
+
#
|
4657
4754
|
# @!attribute [rw] job_name
|
4658
4755
|
# The name that you assigned to the sentiment detection job
|
4659
4756
|
# @return [String]
|
@@ -4721,6 +4818,7 @@ module Aws::Comprehend
|
|
4721
4818
|
#
|
4722
4819
|
class SentimentDetectionJobProperties < Struct.new(
|
4723
4820
|
:job_id,
|
4821
|
+
:job_arn,
|
4724
4822
|
:job_name,
|
4725
4823
|
:job_status,
|
4726
4824
|
:message,
|
@@ -4791,6 +4889,12 @@ module Aws::Comprehend
|
|
4791
4889
|
# security_group_ids: ["SecurityGroupId"], # required
|
4792
4890
|
# subnets: ["SubnetId"], # required
|
4793
4891
|
# },
|
4892
|
+
# tags: [
|
4893
|
+
# {
|
4894
|
+
# key: "TagKey", # required
|
4895
|
+
# value: "TagValue",
|
4896
|
+
# },
|
4897
|
+
# ],
|
4794
4898
|
# }
|
4795
4899
|
#
|
4796
4900
|
# @!attribute [rw] job_name
|
@@ -4846,6 +4950,13 @@ module Aws::Comprehend
|
|
4846
4950
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4847
4951
|
# @return [Types::VpcConfig]
|
4848
4952
|
#
|
4953
|
+
# @!attribute [rw] tags
|
4954
|
+
# Tags to be associated with the document classification job. A tag is
|
4955
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
4956
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
4957
|
+
# added to a resource to indicate its use by the sales department.
|
4958
|
+
# @return [Array<Types::Tag>]
|
4959
|
+
#
|
4849
4960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
|
4850
4961
|
#
|
4851
4962
|
class StartDocumentClassificationJobRequest < Struct.new(
|
@@ -4856,7 +4967,8 @@ module Aws::Comprehend
|
|
4856
4967
|
:data_access_role_arn,
|
4857
4968
|
:client_request_token,
|
4858
4969
|
:volume_kms_key_id,
|
4859
|
-
:vpc_config
|
4970
|
+
:vpc_config,
|
4971
|
+
:tags)
|
4860
4972
|
SENSITIVE = []
|
4861
4973
|
include Aws::Structure
|
4862
4974
|
end
|
@@ -4866,6 +4978,19 @@ module Aws::Comprehend
|
|
4866
4978
|
# use this identifier with the operation.
|
4867
4979
|
# @return [String]
|
4868
4980
|
#
|
4981
|
+
# @!attribute [rw] job_arn
|
4982
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
4983
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
4984
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
4985
|
+
# follows:
|
4986
|
+
#
|
4987
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
4988
|
+
#
|
4989
|
+
# The following is an example job ARN:
|
4990
|
+
#
|
4991
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
4992
|
+
# @return [String]
|
4993
|
+
#
|
4869
4994
|
# @!attribute [rw] job_status
|
4870
4995
|
# The status of the job:
|
4871
4996
|
#
|
@@ -4888,6 +5013,7 @@ module Aws::Comprehend
|
|
4888
5013
|
#
|
4889
5014
|
class StartDocumentClassificationJobResponse < Struct.new(
|
4890
5015
|
:job_id,
|
5016
|
+
:job_arn,
|
4891
5017
|
:job_status)
|
4892
5018
|
SENSITIVE = []
|
4893
5019
|
include Aws::Structure
|
@@ -4913,6 +5039,12 @@ module Aws::Comprehend
|
|
4913
5039
|
# security_group_ids: ["SecurityGroupId"], # required
|
4914
5040
|
# subnets: ["SubnetId"], # required
|
4915
5041
|
# },
|
5042
|
+
# tags: [
|
5043
|
+
# {
|
5044
|
+
# key: "TagKey", # required
|
5045
|
+
# value: "TagValue",
|
5046
|
+
# },
|
5047
|
+
# ],
|
4916
5048
|
# }
|
4917
5049
|
#
|
4918
5050
|
# @!attribute [rw] input_data_config
|
@@ -4968,6 +5100,14 @@ module Aws::Comprehend
|
|
4968
5100
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4969
5101
|
# @return [Types::VpcConfig]
|
4970
5102
|
#
|
5103
|
+
# @!attribute [rw] tags
|
5104
|
+
# Tags to be associated with the dominant language detection job. A
|
5105
|
+
# tag is a key-value pair that adds metadata to a resource used by
|
5106
|
+
# Amazon Comprehend. For example, a tag with "Sales" as the key
|
5107
|
+
# might be added to a resource to indicate its use by the sales
|
5108
|
+
# department.
|
5109
|
+
# @return [Array<Types::Tag>]
|
5110
|
+
#
|
4971
5111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
|
4972
5112
|
#
|
4973
5113
|
class StartDominantLanguageDetectionJobRequest < Struct.new(
|
@@ -4977,7 +5117,8 @@ module Aws::Comprehend
|
|
4977
5117
|
:job_name,
|
4978
5118
|
:client_request_token,
|
4979
5119
|
:volume_kms_key_id,
|
4980
|
-
:vpc_config
|
5120
|
+
:vpc_config,
|
5121
|
+
:tags)
|
4981
5122
|
SENSITIVE = []
|
4982
5123
|
include Aws::Structure
|
4983
5124
|
end
|
@@ -4987,6 +5128,19 @@ module Aws::Comprehend
|
|
4987
5128
|
# use this identifier with the operation.
|
4988
5129
|
# @return [String]
|
4989
5130
|
#
|
5131
|
+
# @!attribute [rw] job_arn
|
5132
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
5133
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
5134
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
5135
|
+
# ARN is as follows:
|
5136
|
+
#
|
5137
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
5138
|
+
#
|
5139
|
+
# The following is an example job ARN:
|
5140
|
+
#
|
5141
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5142
|
+
# @return [String]
|
5143
|
+
#
|
4990
5144
|
# @!attribute [rw] job_status
|
4991
5145
|
# The status of the job.
|
4992
5146
|
#
|
@@ -5006,6 +5160,7 @@ module Aws::Comprehend
|
|
5006
5160
|
#
|
5007
5161
|
class StartDominantLanguageDetectionJobResponse < Struct.new(
|
5008
5162
|
:job_id,
|
5163
|
+
:job_arn,
|
5009
5164
|
:job_status)
|
5010
5165
|
SENSITIVE = []
|
5011
5166
|
include Aws::Structure
|
@@ -5033,6 +5188,12 @@ module Aws::Comprehend
|
|
5033
5188
|
# security_group_ids: ["SecurityGroupId"], # required
|
5034
5189
|
# subnets: ["SubnetId"], # required
|
5035
5190
|
# },
|
5191
|
+
# tags: [
|
5192
|
+
# {
|
5193
|
+
# key: "TagKey", # required
|
5194
|
+
# value: "TagValue",
|
5195
|
+
# },
|
5196
|
+
# ],
|
5036
5197
|
# }
|
5037
5198
|
#
|
5038
5199
|
# @!attribute [rw] input_data_config
|
@@ -5102,6 +5263,13 @@ module Aws::Comprehend
|
|
5102
5263
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5103
5264
|
# @return [Types::VpcConfig]
|
5104
5265
|
#
|
5266
|
+
# @!attribute [rw] tags
|
5267
|
+
# Tags to be associated with the entities detection job. A tag is a
|
5268
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5269
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5270
|
+
# added to a resource to indicate its use by the sales department.
|
5271
|
+
# @return [Array<Types::Tag>]
|
5272
|
+
#
|
5105
5273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
|
5106
5274
|
#
|
5107
5275
|
class StartEntitiesDetectionJobRequest < Struct.new(
|
@@ -5113,7 +5281,8 @@ module Aws::Comprehend
|
|
5113
5281
|
:language_code,
|
5114
5282
|
:client_request_token,
|
5115
5283
|
:volume_kms_key_id,
|
5116
|
-
:vpc_config
|
5284
|
+
:vpc_config,
|
5285
|
+
:tags)
|
5117
5286
|
SENSITIVE = []
|
5118
5287
|
include Aws::Structure
|
5119
5288
|
end
|
@@ -5123,6 +5292,19 @@ module Aws::Comprehend
|
|
5123
5292
|
# this identifier with the operation.
|
5124
5293
|
# @return [String]
|
5125
5294
|
#
|
5295
|
+
# @!attribute [rw] job_arn
|
5296
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
5297
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5298
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5299
|
+
# follows:
|
5300
|
+
#
|
5301
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
5302
|
+
#
|
5303
|
+
# The following is an example job ARN:
|
5304
|
+
#
|
5305
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5306
|
+
# @return [String]
|
5307
|
+
#
|
5126
5308
|
# @!attribute [rw] job_status
|
5127
5309
|
# The status of the job.
|
5128
5310
|
#
|
@@ -5147,6 +5329,7 @@ module Aws::Comprehend
|
|
5147
5329
|
#
|
5148
5330
|
class StartEntitiesDetectionJobResponse < Struct.new(
|
5149
5331
|
:job_id,
|
5332
|
+
:job_arn,
|
5150
5333
|
:job_status)
|
5151
5334
|
SENSITIVE = []
|
5152
5335
|
include Aws::Structure
|
@@ -5169,6 +5352,12 @@ module Aws::Comprehend
|
|
5169
5352
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5170
5353
|
# client_request_token: "ClientRequestTokenString",
|
5171
5354
|
# target_event_types: ["EventTypeString"], # required
|
5355
|
+
# tags: [
|
5356
|
+
# {
|
5357
|
+
# key: "TagKey", # required
|
5358
|
+
# value: "TagValue",
|
5359
|
+
# },
|
5360
|
+
# ],
|
5172
5361
|
# }
|
5173
5362
|
#
|
5174
5363
|
# @!attribute [rw] input_data_config
|
@@ -5205,6 +5394,13 @@ module Aws::Comprehend
|
|
5205
5394
|
# The types of events to detect in the input documents.
|
5206
5395
|
# @return [Array<String>]
|
5207
5396
|
#
|
5397
|
+
# @!attribute [rw] tags
|
5398
|
+
# Tags to be associated with the events detection job. A tag is a
|
5399
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5400
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5401
|
+
# added to a resource to indicate its use by the sales department.
|
5402
|
+
# @return [Array<Types::Tag>]
|
5403
|
+
#
|
5208
5404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5209
5405
|
#
|
5210
5406
|
class StartEventsDetectionJobRequest < Struct.new(
|
@@ -5214,7 +5410,8 @@ module Aws::Comprehend
|
|
5214
5410
|
:job_name,
|
5215
5411
|
:language_code,
|
5216
5412
|
:client_request_token,
|
5217
|
-
:target_event_types
|
5413
|
+
:target_event_types,
|
5414
|
+
:tags)
|
5218
5415
|
SENSITIVE = []
|
5219
5416
|
include Aws::Structure
|
5220
5417
|
end
|
@@ -5224,6 +5421,19 @@ module Aws::Comprehend
|
|
5224
5421
|
# request token, Amazon Comprehend generates one.
|
5225
5422
|
# @return [String]
|
5226
5423
|
#
|
5424
|
+
# @!attribute [rw] job_arn
|
5425
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
5426
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
5427
|
+
# account, Region, and the job ID. The format of the ARN is as
|
5428
|
+
# follows:
|
5429
|
+
#
|
5430
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
5431
|
+
#
|
5432
|
+
# The following is an example job ARN:
|
5433
|
+
#
|
5434
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5435
|
+
# @return [String]
|
5436
|
+
#
|
5227
5437
|
# @!attribute [rw] job_status
|
5228
5438
|
# The status of the events detection job.
|
5229
5439
|
# @return [String]
|
@@ -5232,6 +5442,7 @@ module Aws::Comprehend
|
|
5232
5442
|
#
|
5233
5443
|
class StartEventsDetectionJobResponse < Struct.new(
|
5234
5444
|
:job_id,
|
5445
|
+
:job_arn,
|
5235
5446
|
:job_status)
|
5236
5447
|
SENSITIVE = []
|
5237
5448
|
include Aws::Structure
|
@@ -5258,6 +5469,12 @@ module Aws::Comprehend
|
|
5258
5469
|
# security_group_ids: ["SecurityGroupId"], # required
|
5259
5470
|
# subnets: ["SubnetId"], # required
|
5260
5471
|
# },
|
5472
|
+
# tags: [
|
5473
|
+
# {
|
5474
|
+
# key: "TagKey", # required
|
5475
|
+
# value: "TagValue",
|
5476
|
+
# },
|
5477
|
+
# ],
|
5261
5478
|
# }
|
5262
5479
|
#
|
5263
5480
|
# @!attribute [rw] input_data_config
|
@@ -5319,6 +5536,13 @@ module Aws::Comprehend
|
|
5319
5536
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5320
5537
|
# @return [Types::VpcConfig]
|
5321
5538
|
#
|
5539
|
+
# @!attribute [rw] tags
|
5540
|
+
# Tags to be associated with the key phrases detection job. A tag is a
|
5541
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5542
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5543
|
+
# added to a resource to indicate its use by the sales department.
|
5544
|
+
# @return [Array<Types::Tag>]
|
5545
|
+
#
|
5322
5546
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJobRequest AWS API Documentation
|
5323
5547
|
#
|
5324
5548
|
class StartKeyPhrasesDetectionJobRequest < Struct.new(
|
@@ -5329,7 +5553,8 @@ module Aws::Comprehend
|
|
5329
5553
|
:language_code,
|
5330
5554
|
:client_request_token,
|
5331
5555
|
:volume_kms_key_id,
|
5332
|
-
:vpc_config
|
5556
|
+
:vpc_config,
|
5557
|
+
:tags)
|
5333
5558
|
SENSITIVE = []
|
5334
5559
|
include Aws::Structure
|
5335
5560
|
end
|
@@ -5339,6 +5564,19 @@ module Aws::Comprehend
|
|
5339
5564
|
# use this identifier with the operation.
|
5340
5565
|
# @return [String]
|
5341
5566
|
#
|
5567
|
+
# @!attribute [rw] job_arn
|
5568
|
+
# The Amazon Resource Name (ARN) of the key phrase detection job. It
|
5569
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
5570
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5571
|
+
# follows:
|
5572
|
+
#
|
5573
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
5574
|
+
#
|
5575
|
+
# The following is an example job ARN:
|
5576
|
+
#
|
5577
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5578
|
+
# @return [String]
|
5579
|
+
#
|
5342
5580
|
# @!attribute [rw] job_status
|
5343
5581
|
# The status of the job.
|
5344
5582
|
#
|
@@ -5358,6 +5596,7 @@ module Aws::Comprehend
|
|
5358
5596
|
#
|
5359
5597
|
class StartKeyPhrasesDetectionJobResponse < Struct.new(
|
5360
5598
|
:job_id,
|
5599
|
+
:job_arn,
|
5361
5600
|
:job_status)
|
5362
5601
|
SENSITIVE = []
|
5363
5602
|
include Aws::Structure
|
@@ -5385,6 +5624,12 @@ module Aws::Comprehend
|
|
5385
5624
|
# job_name: "JobName",
|
5386
5625
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5387
5626
|
# client_request_token: "ClientRequestTokenString",
|
5627
|
+
# tags: [
|
5628
|
+
# {
|
5629
|
+
# key: "TagKey", # required
|
5630
|
+
# value: "TagValue",
|
5631
|
+
# },
|
5632
|
+
# ],
|
5388
5633
|
# }
|
5389
5634
|
#
|
5390
5635
|
# @!attribute [rw] input_data_config
|
@@ -5431,6 +5676,13 @@ module Aws::Comprehend
|
|
5431
5676
|
# not need to pass this option.
|
5432
5677
|
# @return [String]
|
5433
5678
|
#
|
5679
|
+
# @!attribute [rw] tags
|
5680
|
+
# Tags to be associated with the PII entities detection job. A tag is
|
5681
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
5682
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5683
|
+
# added to a resource to indicate its use by the sales department.
|
5684
|
+
# @return [Array<Types::Tag>]
|
5685
|
+
#
|
5434
5686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
5435
5687
|
#
|
5436
5688
|
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
@@ -5441,7 +5693,8 @@ module Aws::Comprehend
|
|
5441
5693
|
:data_access_role_arn,
|
5442
5694
|
:job_name,
|
5443
5695
|
:language_code,
|
5444
|
-
:client_request_token
|
5696
|
+
:client_request_token,
|
5697
|
+
:tags)
|
5445
5698
|
SENSITIVE = []
|
5446
5699
|
include Aws::Structure
|
5447
5700
|
end
|
@@ -5450,6 +5703,19 @@ module Aws::Comprehend
|
|
5450
5703
|
# The identifier generated for the job.
|
5451
5704
|
# @return [String]
|
5452
5705
|
#
|
5706
|
+
# @!attribute [rw] job_arn
|
5707
|
+
# The Amazon Resource Name (ARN) of the PII entity detection job. It
|
5708
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
5709
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5710
|
+
# follows:
|
5711
|
+
#
|
5712
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
5713
|
+
#
|
5714
|
+
# The following is an example job ARN:
|
5715
|
+
#
|
5716
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5717
|
+
# @return [String]
|
5718
|
+
#
|
5453
5719
|
# @!attribute [rw] job_status
|
5454
5720
|
# The status of the job.
|
5455
5721
|
# @return [String]
|
@@ -5458,6 +5724,7 @@ module Aws::Comprehend
|
|
5458
5724
|
#
|
5459
5725
|
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
5460
5726
|
:job_id,
|
5727
|
+
:job_arn,
|
5461
5728
|
:job_status)
|
5462
5729
|
SENSITIVE = []
|
5463
5730
|
include Aws::Structure
|
@@ -5484,6 +5751,12 @@ module Aws::Comprehend
|
|
5484
5751
|
# security_group_ids: ["SecurityGroupId"], # required
|
5485
5752
|
# subnets: ["SubnetId"], # required
|
5486
5753
|
# },
|
5754
|
+
# tags: [
|
5755
|
+
# {
|
5756
|
+
# key: "TagKey", # required
|
5757
|
+
# value: "TagValue",
|
5758
|
+
# },
|
5759
|
+
# ],
|
5487
5760
|
# }
|
5488
5761
|
#
|
5489
5762
|
# @!attribute [rw] input_data_config
|
@@ -5545,6 +5818,13 @@ module Aws::Comprehend
|
|
5545
5818
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5546
5819
|
# @return [Types::VpcConfig]
|
5547
5820
|
#
|
5821
|
+
# @!attribute [rw] tags
|
5822
|
+
# Tags to be associated with the sentiment detection job. A tag is a
|
5823
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5824
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5825
|
+
# added to a resource to indicate its use by the sales department.
|
5826
|
+
# @return [Array<Types::Tag>]
|
5827
|
+
#
|
5548
5828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJobRequest AWS API Documentation
|
5549
5829
|
#
|
5550
5830
|
class StartSentimentDetectionJobRequest < Struct.new(
|
@@ -5555,7 +5835,8 @@ module Aws::Comprehend
|
|
5555
5835
|
:language_code,
|
5556
5836
|
:client_request_token,
|
5557
5837
|
:volume_kms_key_id,
|
5558
|
-
:vpc_config
|
5838
|
+
:vpc_config,
|
5839
|
+
:tags)
|
5559
5840
|
SENSITIVE = []
|
5560
5841
|
include Aws::Structure
|
5561
5842
|
end
|
@@ -5565,6 +5846,19 @@ module Aws::Comprehend
|
|
5565
5846
|
# use this identifier with the operation.
|
5566
5847
|
# @return [String]
|
5567
5848
|
#
|
5849
|
+
# @!attribute [rw] job_arn
|
5850
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
5851
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5852
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5853
|
+
# follows:
|
5854
|
+
#
|
5855
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
5856
|
+
#
|
5857
|
+
# The following is an example job ARN:
|
5858
|
+
#
|
5859
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5860
|
+
# @return [String]
|
5861
|
+
#
|
5568
5862
|
# @!attribute [rw] job_status
|
5569
5863
|
# The status of the job.
|
5570
5864
|
#
|
@@ -5584,6 +5878,7 @@ module Aws::Comprehend
|
|
5584
5878
|
#
|
5585
5879
|
class StartSentimentDetectionJobResponse < Struct.new(
|
5586
5880
|
:job_id,
|
5881
|
+
:job_arn,
|
5587
5882
|
:job_status)
|
5588
5883
|
SENSITIVE = []
|
5589
5884
|
include Aws::Structure
|
@@ -5610,6 +5905,12 @@ module Aws::Comprehend
|
|
5610
5905
|
# security_group_ids: ["SecurityGroupId"], # required
|
5611
5906
|
# subnets: ["SubnetId"], # required
|
5612
5907
|
# },
|
5908
|
+
# tags: [
|
5909
|
+
# {
|
5910
|
+
# key: "TagKey", # required
|
5911
|
+
# value: "TagValue",
|
5912
|
+
# },
|
5913
|
+
# ],
|
5613
5914
|
# }
|
5614
5915
|
#
|
5615
5916
|
# @!attribute [rw] input_data_config
|
@@ -5672,6 +5973,13 @@ module Aws::Comprehend
|
|
5672
5973
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5673
5974
|
# @return [Types::VpcConfig]
|
5674
5975
|
#
|
5976
|
+
# @!attribute [rw] tags
|
5977
|
+
# Tags to be associated with the topics detection job. A tag is a
|
5978
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5979
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5980
|
+
# added to a resource to indicate its use by the sales department.
|
5981
|
+
# @return [Array<Types::Tag>]
|
5982
|
+
#
|
5675
5983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJobRequest AWS API Documentation
|
5676
5984
|
#
|
5677
5985
|
class StartTopicsDetectionJobRequest < Struct.new(
|
@@ -5682,7 +5990,8 @@ module Aws::Comprehend
|
|
5682
5990
|
:number_of_topics,
|
5683
5991
|
:client_request_token,
|
5684
5992
|
:volume_kms_key_id,
|
5685
|
-
:vpc_config
|
5993
|
+
:vpc_config,
|
5994
|
+
:tags)
|
5686
5995
|
SENSITIVE = []
|
5687
5996
|
include Aws::Structure
|
5688
5997
|
end
|
@@ -5692,6 +6001,19 @@ module Aws::Comprehend
|
|
5692
6001
|
# use this identifier with the `DescribeTopicDetectionJob` operation.
|
5693
6002
|
# @return [String]
|
5694
6003
|
#
|
6004
|
+
# @!attribute [rw] job_arn
|
6005
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6006
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6007
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6008
|
+
# follows:
|
6009
|
+
#
|
6010
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6011
|
+
#
|
6012
|
+
# The following is an example job ARN:
|
6013
|
+
#
|
6014
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
6015
|
+
# @return [String]
|
6016
|
+
#
|
5695
6017
|
# @!attribute [rw] job_status
|
5696
6018
|
# The status of the job:
|
5697
6019
|
#
|
@@ -5711,6 +6033,7 @@ module Aws::Comprehend
|
|
5711
6033
|
#
|
5712
6034
|
class StartTopicsDetectionJobResponse < Struct.new(
|
5713
6035
|
:job_id,
|
6036
|
+
:job_arn,
|
5714
6037
|
:job_status)
|
5715
6038
|
SENSITIVE = []
|
5716
6039
|
include Aws::Structure
|
@@ -6210,6 +6533,19 @@ module Aws::Comprehend
|
|
6210
6533
|
# The identifier assigned to the topic detection job.
|
6211
6534
|
# @return [String]
|
6212
6535
|
#
|
6536
|
+
# @!attribute [rw] job_arn
|
6537
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6538
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6539
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6540
|
+
# follows:
|
6541
|
+
#
|
6542
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6543
|
+
#
|
6544
|
+
# The following is an example job ARN:
|
6545
|
+
#
|
6546
|
+
# `arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
6547
|
+
# @return [String]
|
6548
|
+
#
|
6213
6549
|
# @!attribute [rw] job_name
|
6214
6550
|
# The name of the topic detection job.
|
6215
6551
|
# @return [String]
|
@@ -6279,6 +6615,7 @@ module Aws::Comprehend
|
|
6279
6615
|
#
|
6280
6616
|
class TopicsDetectionJobProperties < Struct.new(
|
6281
6617
|
:job_id,
|
6618
|
+
:job_arn,
|
6282
6619
|
:job_name,
|
6283
6620
|
:job_status,
|
6284
6621
|
:message,
|