aws-sdk-comprehend 1.66.0 → 1.67.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -304,12 +304,6 @@ module Aws::Comprehend
304
304
  # A list containing the UTF-8 encoded text of the input documents. The
305
305
  # list can contain a maximum of 25 documents. The maximum size of each
306
306
  # document is 5 KB.
307
- #
308
- # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
309
- # 500 characters of the input text and ignores any additional text in
310
- # the input.
311
- #
312
- # </note>
313
307
  # @return [Array<String>]
314
308
  #
315
309
  # @!attribute [rw] language_code
@@ -990,13 +984,12 @@ module Aws::Comprehend
990
984
  # names can have a maximum of 256 characters. Alphanumeric characters,
991
985
  # hyphens (-) and underscores (\_) are allowed. The version name must
992
986
  # be unique among all models with the same classifier name in the
993
- # account/AWS Region.
987
+ # Amazon Web Services account/Amazon Web Services Region.
994
988
  # @return [String]
995
989
  #
996
990
  # @!attribute [rw] data_access_role_arn
997
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
998
- # Management (IAM) role that grants Amazon Comprehend read access to
999
- # your input data.
991
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
992
+ # Comprehend read access to your input data.
1000
993
  # @return [String]
1001
994
  #
1002
995
  # @!attribute [rw] tags
@@ -1030,10 +1023,10 @@ module Aws::Comprehend
1030
1023
  # @return [String]
1031
1024
  #
1032
1025
  # @!attribute [rw] volume_kms_key_id
1033
- # ID for the AWS Key Management Service (KMS) key that Amazon
1034
- # Comprehend uses to encrypt data on the storage volume attached to
1035
- # the ML compute instance(s) that process the analysis job. The
1036
- # VolumeKmsKeyId can be either of the following formats:
1026
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
1027
+ # Amazon Comprehend uses to encrypt data on the storage volume
1028
+ # attached to the ML compute instance(s) that process the analysis
1029
+ # job. The VolumeKmsKeyId can be either of the following formats:
1037
1030
  #
1038
1031
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1039
1032
  #
@@ -1061,9 +1054,9 @@ module Aws::Comprehend
1061
1054
  # @return [String]
1062
1055
  #
1063
1056
  # @!attribute [rw] model_kms_key_id
1064
- # ID for the AWS Key Management Service (KMS) key that Amazon
1065
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1066
- # can be either of the following formats:
1057
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1058
+ # custom models. The ModelKmsKeyId can be either of the following
1059
+ # formats:
1067
1060
  #
1068
1061
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1069
1062
  #
@@ -1073,8 +1066,8 @@ module Aws::Comprehend
1073
1066
  #
1074
1067
  # @!attribute [rw] model_policy
1075
1068
  # The resource-based policy to attach to your custom document
1076
- # classifier model. You can use this policy to allow another AWS
1077
- # account to import your custom model.
1069
+ # classifier model. You can use this policy to allow another Amazon
1070
+ # Web Services account to import your custom model.
1078
1071
  #
1079
1072
  # Provide your policy as a JSON body that you enter as a UTF-8 encoded
1080
1073
  # string without line breaks. To provide valid JSON, enclose the
@@ -1156,10 +1149,9 @@ module Aws::Comprehend
1156
1149
  # @return [Array<Types::Tag>]
1157
1150
  #
1158
1151
  # @!attribute [rw] data_access_role_arn
1159
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
1160
- # Management (IAM) role that grants Amazon Comprehend read access to
1161
- # trained custom models encrypted with a customer managed key
1162
- # (ModelKmsKeyId).
1152
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1153
+ # Comprehend read access to trained custom models encrypted with a
1154
+ # customer managed key (ModelKmsKeyId).
1163
1155
  # @return [String]
1164
1156
  #
1165
1157
  # @!attribute [rw] flywheel_arn
@@ -1203,7 +1195,7 @@ module Aws::Comprehend
1203
1195
  # The name given to the newly created recognizer. Recognizer names can
1204
1196
  # be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
1205
1197
  # and underscores (\_) are allowed. The name must be unique in the
1206
- # account/region.
1198
+ # account/Region.
1207
1199
  # @return [String]
1208
1200
  #
1209
1201
  # @!attribute [rw] version_name
@@ -1211,13 +1203,12 @@ module Aws::Comprehend
1211
1203
  # names can be a maximum of 256 characters. Alphanumeric characters,
1212
1204
  # hyphens (-) and underscores (\_) are allowed. The version name must
1213
1205
  # be unique among all models with the same recognizer name in the
1214
- # account/ AWS Region.
1206
+ # account/Region.
1215
1207
  # @return [String]
1216
1208
  #
1217
1209
  # @!attribute [rw] data_access_role_arn
1218
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
1219
- # Management (IAM) role that grants Amazon Comprehend read access to
1220
- # your input data.
1210
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1211
+ # Comprehend read access to your input data.
1221
1212
  # @return [String]
1222
1213
  #
1223
1214
  # @!attribute [rw] tags
@@ -1229,7 +1220,7 @@ module Aws::Comprehend
1229
1220
  #
1230
1221
  # @!attribute [rw] input_data_config
1231
1222
  # Specifies the format and location of the input data. The S3 bucket
1232
- # containing the input data must be located in the same region as the
1223
+ # containing the input data must be located in the same Region as the
1233
1224
  # entity recognizer being created.
1234
1225
  # @return [Types::EntityRecognizerInputDataConfig]
1235
1226
  #
@@ -1251,10 +1242,10 @@ module Aws::Comprehend
1251
1242
  # @return [String]
1252
1243
  #
1253
1244
  # @!attribute [rw] volume_kms_key_id
1254
- # ID for the AWS Key Management Service (KMS) key that Amazon
1255
- # Comprehend uses to encrypt data on the storage volume attached to
1256
- # the ML compute instance(s) that process the analysis job. The
1257
- # VolumeKmsKeyId can be either of the following formats:
1245
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
1246
+ # Amazon Comprehend uses to encrypt data on the storage volume
1247
+ # attached to the ML compute instance(s) that process the analysis
1248
+ # job. The VolumeKmsKeyId can be either of the following formats:
1258
1249
  #
1259
1250
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1260
1251
  #
@@ -1273,9 +1264,9 @@ module Aws::Comprehend
1273
1264
  # @return [Types::VpcConfig]
1274
1265
  #
1275
1266
  # @!attribute [rw] model_kms_key_id
1276
- # ID for the AWS Key Management Service (KMS) key that Amazon
1277
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1278
- # can be either of the following formats:
1267
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1268
+ # custom models. The ModelKmsKeyId can be either of the following
1269
+ # formats:
1279
1270
  #
1280
1271
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1281
1272
  #
@@ -1285,8 +1276,8 @@ module Aws::Comprehend
1285
1276
  #
1286
1277
  # @!attribute [rw] model_policy
1287
1278
  # The JSON resource-based policy to attach to your custom entity
1288
- # recognizer model. You can use this policy to allow another AWS
1289
- # account to import your custom model.
1279
+ # recognizer model. You can use this policy to allow another Amazon
1280
+ # Web Services account to import your custom model.
1290
1281
  #
1291
1282
  # Provide your JSON as a UTF-8 encoded string without line breaks. To
1292
1283
  # provide valid JSON for your policy, enclose the attribute names and
@@ -1343,9 +1334,9 @@ module Aws::Comprehend
1343
1334
  # @return [String]
1344
1335
  #
1345
1336
  # @!attribute [rw] data_access_role_arn
1346
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
1347
- # Management (IAM) role that grants Amazon Comprehend the permissions
1348
- # required to access the flywheel data in the data lake.
1337
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1338
+ # Comprehend the permissions required to access the flywheel data in
1339
+ # the data lake.
1349
1340
  # @return [String]
1350
1341
  #
1351
1342
  # @!attribute [rw] task_config
@@ -1415,9 +1406,9 @@ module Aws::Comprehend
1415
1406
  # Data security configuration.
1416
1407
  #
1417
1408
  # @!attribute [rw] model_kms_key_id
1418
- # ID for the AWS Key Management Service (KMS) key that Amazon
1419
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1420
- # can be either of the following formats:
1409
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1410
+ # custom models. The ModelKmsKeyId can be either of the following
1411
+ # formats:
1421
1412
  #
1422
1413
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1423
1414
  #
@@ -1522,7 +1513,7 @@ module Aws::Comprehend
1522
1513
  #
1523
1514
  # @!attribute [rw] s3_uri
1524
1515
  # The Amazon S3 URI for the input data. The S3 bucket must be in the
1525
- # same region as the API endpoint that you are calling. The URI can
1516
+ # same Region as the API endpoint that you are calling. The URI can
1526
1517
  # point to a single input file or it can provide the prefix for a
1527
1518
  # collection of input files.
1528
1519
  #
@@ -1558,7 +1549,7 @@ module Aws::Comprehend
1558
1549
  #
1559
1550
  # @!attribute [rw] s3_uri
1560
1551
  # Specifies the Amazon S3 location where the training documents for an
1561
- # entity recognizer are located. The URI must be in the same region as
1552
+ # entity recognizer are located. The URI must be in the same Region as
1562
1553
  # the API endpoint that you are calling.
1563
1554
  # @return [String]
1564
1555
  #
@@ -1686,11 +1677,11 @@ module Aws::Comprehend
1686
1677
  # @return [Array<Types::DatasetAugmentedManifestsListItem>]
1687
1678
  #
1688
1679
  # @!attribute [rw] data_format
1689
- # `COMPREHEND_CSV`\: The data format is a two-column CSV file, where
1680
+ # `COMPREHEND_CSV`: The data format is a two-column CSV file, where
1690
1681
  # the first column contains labels and the second column contains
1691
1682
  # documents.
1692
1683
  #
1693
- # `AUGMENTED_MANIFEST`\: The data format
1684
+ # `AUGMENTED_MANIFEST`: The data format
1694
1685
  # @return [String]
1695
1686
  #
1696
1687
  # @!attribute [rw] document_classifier_input_data_config
@@ -2311,11 +2302,14 @@ module Aws::Comprehend
2311
2302
  end
2312
2303
 
2313
2304
  # @!attribute [rw] languages
2314
- # The languages that Amazon Comprehend detected in the input text. For
2315
- # each language, the response returns the RFC 5646 language code and
2316
- # the level of confidence that Amazon Comprehend has in the accuracy
2317
- # of its inference. For more information about RFC 5646, see [Tags for
2318
- # Identifying Languages][1] on the *IETF Tools* web site.
2305
+ # Array of languages that Amazon Comprehend detected in the input
2306
+ # text. The array is sorted in descending order of the score (the
2307
+ # dominant language is always the first element in the array).
2308
+ #
2309
+ # For each language, the response returns the RFC 5646 language code
2310
+ # and the level of confidence that Amazon Comprehend has in the
2311
+ # accuracy of its inference. For more information about RFC 5646, see
2312
+ # [Tags for Identifying Languages][1] on the *IETF Tools* web site.
2319
2313
  #
2320
2314
  #
2321
2315
  #
@@ -2537,12 +2531,6 @@ module Aws::Comprehend
2537
2531
 
2538
2532
  # @!attribute [rw] text
2539
2533
  # A UTF-8 text string. The maximum string size is 5 KB.
2540
- #
2541
- # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
2542
- # 500 characters of the input text and ignores any additional text in
2543
- # the input.
2544
- #
2545
- # </note>
2546
2534
  # @return [String]
2547
2535
  #
2548
2536
  # @!attribute [rw] language_code
@@ -2743,8 +2731,8 @@ module Aws::Comprehend
2743
2731
  # @!attribute [rw] job_arn
2744
2732
  # The Amazon Resource Name (ARN) of the document classification job.
2745
2733
  # It is a unique, fully qualified identifier for the job. It includes
2746
- # the AWS account, Region, and the job ID. The format of the ARN is as
2747
- # follows:
2734
+ # the Amazon Web Services account, Amazon Web Services Region, and the
2735
+ # job ID. The format of the ARN is as follows:
2748
2736
  #
2749
2737
  # `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
2750
2738
  #
@@ -2791,16 +2779,15 @@ module Aws::Comprehend
2791
2779
  # @return [Types::OutputDataConfig]
2792
2780
  #
2793
2781
  # @!attribute [rw] data_access_role_arn
2794
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
2795
- # Management (IAM) role that grants Amazon Comprehend read access to
2796
- # your input data.
2782
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
2783
+ # Comprehend read access to your input data.
2797
2784
  # @return [String]
2798
2785
  #
2799
2786
  # @!attribute [rw] volume_kms_key_id
2800
- # ID for the AWS Key Management Service (KMS) key that Amazon
2801
- # Comprehend uses to encrypt data on the storage volume attached to
2802
- # the ML compute instance(s) that process the analysis job. The
2803
- # VolumeKmsKeyId can be either of the following formats:
2787
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
2788
+ # Amazon Comprehend uses to encrypt data on the storage volume
2789
+ # attached to the ML compute instance(s) that process the analysis
2790
+ # job. The VolumeKmsKeyId can be either of the following formats:
2804
2791
  #
2805
2792
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2806
2793
  #
@@ -2892,15 +2879,15 @@ module Aws::Comprehend
2892
2879
  # @!attribute [rw] data_format
2893
2880
  # The format of your training data:
2894
2881
  #
2895
- # * `COMPREHEND_CSV`\: A two-column CSV file, where labels are
2896
- # provided in the first column, and documents are provided in the
2897
- # second. If you use this value, you must provide the `S3Uri`
2898
- # parameter in your request.
2882
+ # * `COMPREHEND_CSV`: A two-column CSV file, where labels are provided
2883
+ # in the first column, and documents are provided in the second. If
2884
+ # you use this value, you must provide the `S3Uri` parameter in your
2885
+ # request.
2899
2886
  #
2900
- # * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
2901
- # Amazon SageMaker Ground Truth. This file is in JSON lines format.
2902
- # Each line is a complete JSON object that contains a training
2903
- # document and its associated labels.
2887
+ # * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
2888
+ # SageMaker Ground Truth. This file is in JSON lines format. Each
2889
+ # line is a complete JSON object that contains a training document
2890
+ # and its associated labels.
2904
2891
  #
2905
2892
  # If you use this value, you must provide the `AugmentedManifests`
2906
2893
  # parameter in your request.
@@ -2911,7 +2898,7 @@ module Aws::Comprehend
2911
2898
  #
2912
2899
  # @!attribute [rw] s3_uri
2913
2900
  # The Amazon S3 URI for the input data. The S3 bucket must be in the
2914
- # same region as the API endpoint that you are calling. The URI can
2901
+ # same Region as the API endpoint that you are calling. The URI can
2915
2902
  # point to a single input file or it can provide the prefix for a
2916
2903
  # collection of input files.
2917
2904
  #
@@ -2926,8 +2913,8 @@ module Aws::Comprehend
2926
2913
  #
2927
2914
  # @!attribute [rw] test_s3_uri
2928
2915
  # This specifies the Amazon S3 location where the test annotations for
2929
- # an entity recognizer are located. The URI must be in the same AWS
2930
- # Region as the API endpoint that you are calling.
2916
+ # an entity recognizer are located. The URI must be in the same Amazon
2917
+ # Web Services Region as the API endpoint that you are calling.
2931
2918
  # @return [String]
2932
2919
  #
2933
2920
  # @!attribute [rw] label_delimiter
@@ -2967,7 +2954,7 @@ module Aws::Comprehend
2967
2954
  # @!attribute [rw] s3_uri
2968
2955
  # When you use the `OutputDataConfig` object while creating a custom
2969
2956
  # classifier, you specify the Amazon S3 location where you want to
2970
- # write the confusion matrix. The URI must be in the same region as
2957
+ # write the confusion matrix. The URI must be in the same Region as
2971
2958
  # the API endpoint that you are calling. The location is used as the
2972
2959
  # prefix for the actual location of this output file.
2973
2960
  #
@@ -2978,9 +2965,9 @@ module Aws::Comprehend
2978
2965
  # @return [String]
2979
2966
  #
2980
2967
  # @!attribute [rw] kms_key_id
2981
- # ID for the AWS Key Management Service (KMS) key that Amazon
2982
- # Comprehend uses to encrypt the output results from an analysis job.
2983
- # The KmsKeyId can be one of the following formats:
2968
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
2969
+ # Amazon Comprehend uses to encrypt the output results from an
2970
+ # analysis job. The KmsKeyId can be one of the following formats:
2984
2971
  #
2985
2972
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2986
2973
  #
@@ -3069,16 +3056,15 @@ module Aws::Comprehend
3069
3056
  # @return [Types::ClassifierMetadata]
3070
3057
  #
3071
3058
  # @!attribute [rw] data_access_role_arn
3072
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
3073
- # Management (IAM) role that grants Amazon Comprehend read access to
3074
- # your input data.
3059
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3060
+ # Comprehend read access to your input data.
3075
3061
  # @return [String]
3076
3062
  #
3077
3063
  # @!attribute [rw] volume_kms_key_id
3078
- # ID for the AWS Key Management Service (KMS) key that Amazon
3079
- # Comprehend uses to encrypt data on the storage volume attached to
3080
- # the ML compute instance(s) that process the analysis job. The
3081
- # VolumeKmsKeyId can be either of the following formats:
3064
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3065
+ # Amazon Comprehend uses to encrypt data on the storage volume
3066
+ # attached to the ML compute instance(s) that process the analysis
3067
+ # job. The VolumeKmsKeyId can be either of the following formats:
3082
3068
  #
3083
3069
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3084
3070
  #
@@ -3104,9 +3090,9 @@ module Aws::Comprehend
3104
3090
  # @return [String]
3105
3091
  #
3106
3092
  # @!attribute [rw] model_kms_key_id
3107
- # ID for the AWS Key Management Service (KMS) key that Amazon
3108
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
3109
- # can be either of the following formats:
3093
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
3094
+ # custom models. The ModelKmsKeyId can be either of the following
3095
+ # formats:
3110
3096
  #
3111
3097
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3112
3098
  #
@@ -3120,8 +3106,8 @@ module Aws::Comprehend
3120
3106
  #
3121
3107
  # @!attribute [rw] source_model_arn
3122
3108
  # The Amazon Resource Name (ARN) of the source model. This model was
3123
- # imported from a different AWS account to create the document
3124
- # classifier model in your AWS account.
3109
+ # imported from a different Amazon Web Services account to create the
3110
+ # document classifier model in your Amazon Web Services account.
3125
3111
  # @return [String]
3126
3112
  #
3127
3113
  # @!attribute [rw] flywheel_arn
@@ -3400,8 +3386,8 @@ module Aws::Comprehend
3400
3386
  # @!attribute [rw] job_arn
3401
3387
  # The Amazon Resource Name (ARN) of the dominant language detection
3402
3388
  # job. It is a unique, fully qualified identifier for the job. It
3403
- # includes the AWS account, Region, and the job ID. The format of the
3404
- # ARN is as follows:
3389
+ # includes the Amazon Web Services account, Amazon Web Services
3390
+ # Region, and the job ID. The format of the ARN is as follows:
3405
3391
  #
3406
3392
  # `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
3407
3393
  #
@@ -3444,16 +3430,15 @@ module Aws::Comprehend
3444
3430
  # @return [Types::OutputDataConfig]
3445
3431
  #
3446
3432
  # @!attribute [rw] data_access_role_arn
3447
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
3448
- # Management (IAM) role that grants Amazon Comprehend read access to
3449
- # your input data.
3433
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3434
+ # Comprehend read access to your input data.
3450
3435
  # @return [String]
3451
3436
  #
3452
3437
  # @!attribute [rw] volume_kms_key_id
3453
- # ID for the AWS Key Management Service (KMS) key that Amazon
3454
- # Comprehend uses to encrypt data on the storage volume attached to
3455
- # the ML compute instance(s) that process the analysis job. The
3456
- # VolumeKmsKeyId can be either of the following formats:
3438
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3439
+ # Amazon Comprehend uses to encrypt data on the storage volume
3440
+ # attached to the ML compute instance(s) that process the analysis
3441
+ # job. The VolumeKmsKeyId can be either of the following formats:
3457
3442
  #
3458
3443
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3459
3444
  #
@@ -3577,10 +3562,9 @@ module Aws::Comprehend
3577
3562
  # @return [Time]
3578
3563
  #
3579
3564
  # @!attribute [rw] data_access_role_arn
3580
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
3581
- # Management (IAM) role that grants Amazon Comprehend read access to
3582
- # trained custom models encrypted with a customer managed key
3583
- # (ModelKmsKeyId).
3565
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3566
+ # Comprehend read access to trained custom models encrypted with a
3567
+ # customer managed key (ModelKmsKeyId).
3584
3568
  # @return [String]
3585
3569
  #
3586
3570
  # @!attribute [rw] desired_data_access_role_arn
@@ -3657,8 +3641,8 @@ module Aws::Comprehend
3657
3641
  # @!attribute [rw] job_arn
3658
3642
  # The Amazon Resource Name (ARN) of the entities detection job. It is
3659
3643
  # a unique, fully qualified identifier for the job. It includes the
3660
- # AWS account, Region, and the job ID. The format of the ARN is as
3661
- # follows:
3644
+ # Amazon Web Services account, Amazon Web Services Region, and the job
3645
+ # ID. The format of the ARN is as follows:
3662
3646
  #
3663
3647
  # `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
3664
3648
  #
@@ -3709,16 +3693,15 @@ module Aws::Comprehend
3709
3693
  # @return [String]
3710
3694
  #
3711
3695
  # @!attribute [rw] data_access_role_arn
3712
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
3713
- # Management (IAM) role that grants Amazon Comprehend read access to
3714
- # your input data.
3696
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3697
+ # Comprehend read access to your input data.
3715
3698
  # @return [String]
3716
3699
  #
3717
3700
  # @!attribute [rw] volume_kms_key_id
3718
- # ID for the AWS Key Management Service (KMS) key that Amazon
3719
- # Comprehend uses to encrypt data on the storage volume attached to
3720
- # the ML compute instance(s) that process the analysis job. The
3721
- # VolumeKmsKeyId can be either of the following formats:
3701
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3702
+ # Amazon Comprehend uses to encrypt data on the storage volume
3703
+ # attached to the ML compute instance(s) that process the analysis
3704
+ # job. The VolumeKmsKeyId can be either of the following formats:
3722
3705
  #
3723
3706
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3724
3707
  #
@@ -3736,6 +3719,11 @@ module Aws::Comprehend
3736
3719
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
3737
3720
  # @return [Types::VpcConfig]
3738
3721
  #
3722
+ # @!attribute [rw] flywheel_arn
3723
+ # The Amazon Resource Name (ARN) of the flywheel associated with this
3724
+ # job.
3725
+ # @return [String]
3726
+ #
3739
3727
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties AWS API Documentation
3740
3728
  #
3741
3729
  class EntitiesDetectionJobProperties < Struct.new(
@@ -3752,7 +3740,8 @@ module Aws::Comprehend
3752
3740
  :language_code,
3753
3741
  :data_access_role_arn,
3754
3742
  :volume_kms_key_id,
3755
- :vpc_config)
3743
+ :vpc_config,
3744
+ :flywheel_arn)
3756
3745
  SENSITIVE = []
3757
3746
  include Aws::Structure
3758
3747
  end
@@ -3847,13 +3836,13 @@ module Aws::Comprehend
3847
3836
  #
3848
3837
  # @!attribute [rw] s3_uri
3849
3838
  # Specifies the Amazon S3 location where the annotations for an entity
3850
- # recognizer are located. The URI must be in the same region as the
3839
+ # recognizer are located. The URI must be in the same Region as the
3851
3840
  # API endpoint that you are calling.
3852
3841
  # @return [String]
3853
3842
  #
3854
3843
  # @!attribute [rw] test_s3_uri
3855
3844
  # Specifies the Amazon S3 location where the test annotations for an
3856
- # entity recognizer are located. The URI must be in the same region as
3845
+ # entity recognizer are located. The URI must be in the same Region as
3857
3846
  # the API endpoint that you are calling.
3858
3847
  # @return [String]
3859
3848
  #
@@ -3870,14 +3859,14 @@ module Aws::Comprehend
3870
3859
  #
3871
3860
  # @!attribute [rw] s3_uri
3872
3861
  # Specifies the Amazon S3 location where the training documents for an
3873
- # entity recognizer are located. The URI must be in the same region as
3862
+ # entity recognizer are located. The URI must be in the same Region as
3874
3863
  # the API endpoint that you are calling.
3875
3864
  # @return [String]
3876
3865
  #
3877
3866
  # @!attribute [rw] test_s3_uri
3878
3867
  # Specifies the Amazon S3 location where the test documents for an
3879
- # entity recognizer are located. The URI must be in the same AWS
3880
- # Region as the API endpoint that you are calling.
3868
+ # entity recognizer are located. The URI must be in the same Amazon
3869
+ # Web Services Region as the API endpoint that you are calling.
3881
3870
  # @return [String]
3882
3871
  #
3883
3872
  # @!attribute [rw] input_format
@@ -3904,7 +3893,7 @@ module Aws::Comprehend
3904
3893
  #
3905
3894
  # @!attribute [rw] s3_uri
3906
3895
  # Specifies the Amazon S3 location where the entity list is located.
3907
- # The URI must be in the same region as the API endpoint that you are
3896
+ # The URI must be in the same Region as the API endpoint that you are
3908
3897
  # calling.
3909
3898
  # @return [String]
3910
3899
  #
@@ -3991,7 +3980,7 @@ module Aws::Comprehend
3991
3980
  # @!attribute [rw] data_format
3992
3981
  # The format of your training data:
3993
3982
  #
3994
- # * `COMPREHEND_CSV`\: A CSV file that supplements your training
3983
+ # * `COMPREHEND_CSV`: A CSV file that supplements your training
3995
3984
  # documents. The CSV file contains information about the custom
3996
3985
  # entities that your trained model will detect. The required format
3997
3986
  # of the file depends on whether you are providing annotations or an
@@ -4002,11 +3991,11 @@ module Aws::Comprehend
4002
3991
  # provide your training documents by using the `Documents`
4003
3992
  # parameter.
4004
3993
  #
4005
- # * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
4006
- # Amazon SageMaker Ground Truth. This file is in JSON lines format.
4007
- # Each line is a complete JSON object that contains a training
4008
- # document and its labels. Each label annotates a named entity in
4009
- # the training document.
3994
+ # * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
3995
+ # SageMaker Ground Truth. This file is in JSON lines format. Each
3996
+ # line is a complete JSON object that contains a training document
3997
+ # and its labels. Each label annotates a named entity in the
3998
+ # training document.
4010
3999
  #
4011
4000
  # If you use this value, you must provide the `AugmentedManifests`
4012
4001
  # parameter in your request.
@@ -4188,16 +4177,15 @@ module Aws::Comprehend
4188
4177
  # @return [Types::EntityRecognizerMetadata]
4189
4178
  #
4190
4179
  # @!attribute [rw] data_access_role_arn
4191
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4192
- # Management (IAM) role that grants Amazon Comprehend read access to
4193
- # your input data.
4180
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4181
+ # Comprehend read access to your input data.
4194
4182
  # @return [String]
4195
4183
  #
4196
4184
  # @!attribute [rw] volume_kms_key_id
4197
- # ID for the AWS Key Management Service (KMS) key that Amazon
4198
- # Comprehend uses to encrypt data on the storage volume attached to
4199
- # the ML compute instance(s) that process the analysis job. The
4200
- # VolumeKmsKeyId can be either of the following formats:
4185
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4186
+ # Amazon Comprehend uses to encrypt data on the storage volume
4187
+ # attached to the ML compute instance(s) that process the analysis
4188
+ # job. The VolumeKmsKeyId can be either of the following formats:
4201
4189
  #
4202
4190
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4203
4191
  #
@@ -4216,9 +4204,9 @@ module Aws::Comprehend
4216
4204
  # @return [Types::VpcConfig]
4217
4205
  #
4218
4206
  # @!attribute [rw] model_kms_key_id
4219
- # ID for the AWS Key Management Service (KMS) key that Amazon
4220
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
4221
- # can be either of the following formats:
4207
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
4208
+ # custom models. The ModelKmsKeyId can be either of the following
4209
+ # formats:
4222
4210
  #
4223
4211
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4224
4212
  #
@@ -4232,8 +4220,8 @@ module Aws::Comprehend
4232
4220
  #
4233
4221
  # @!attribute [rw] source_model_arn
4234
4222
  # The Amazon Resource Name (ARN) of the source model. This model was
4235
- # imported from a different AWS account to create the entity
4236
- # recognizer model in your AWS account.
4223
+ # imported from a different Amazon Web Services account to create the
4224
+ # entity recognizer model in your Amazon Web Services account.
4237
4225
  # @return [String]
4238
4226
  #
4239
4227
  # @!attribute [rw] flywheel_arn
@@ -4452,9 +4440,9 @@ module Aws::Comprehend
4452
4440
  #
4453
4441
  # @!attribute [rw] job_arn
4454
4442
  # The Amazon Resource Name (ARN) of the events detection job. It is a
4455
- # unique, fully qualified identifier for the job. It includes the AWS
4456
- # account, Region, and the job ID. The format of the ARN is as
4457
- # follows:
4443
+ # unique, fully qualified identifier for the job. It includes the
4444
+ # Amazon Web Services account, Amazon Web Services Region, and the job
4445
+ # ID. The format of the ARN is as follows:
4458
4446
  #
4459
4447
  # `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
4460
4448
  #
@@ -4498,9 +4486,8 @@ module Aws::Comprehend
4498
4486
  # @return [String]
4499
4487
  #
4500
4488
  # @!attribute [rw] data_access_role_arn
4501
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4502
- # Management (IAM) role that grants Amazon Comprehend read access to
4503
- # your input data.
4489
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4490
+ # Comprehend read access to your input data.
4504
4491
  # @return [String]
4505
4492
  #
4506
4493
  # @!attribute [rw] target_event_types
@@ -4695,9 +4682,8 @@ module Aws::Comprehend
4695
4682
  # @return [String]
4696
4683
  #
4697
4684
  # @!attribute [rw] data_access_role_arn
4698
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4699
- # Management (IAM) role that grants Amazon Comprehend permission to
4700
- # access the flywheel data.
4685
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4686
+ # Comprehend permission to access the flywheel data.
4701
4687
  # @return [String]
4702
4688
  #
4703
4689
  # @!attribute [rw] task_config
@@ -4852,13 +4838,13 @@ module Aws::Comprehend
4852
4838
  # import. Version names can have a maximum of 256 characters.
4853
4839
  # Alphanumeric characters, hyphens (-) and underscores (\_) are
4854
4840
  # allowed. The version name must be unique among all models with the
4855
- # same classifier name in the account/AWS Region.
4841
+ # same classifier name in the account/Region.
4856
4842
  # @return [String]
4857
4843
  #
4858
4844
  # @!attribute [rw] model_kms_key_id
4859
- # ID for the AWS Key Management Service (KMS) key that Amazon
4860
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
4861
- # can be either of the following formats:
4845
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
4846
+ # custom models. The ModelKmsKeyId can be either of the following
4847
+ # formats:
4862
4848
  #
4863
4849
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4864
4850
  #
@@ -4867,10 +4853,9 @@ module Aws::Comprehend
4867
4853
  # @return [String]
4868
4854
  #
4869
4855
  # @!attribute [rw] data_access_role_arn
4870
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4871
- # Management (IAM) role that grants Amazon Comprehend permission to
4872
- # use Amazon Key Management Service (KMS) to encrypt or decrypt the
4873
- # custom model.
4856
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4857
+ # Comprehend permission to use Amazon Key Management Service (KMS) to
4858
+ # encrypt or decrypt the custom model.
4874
4859
  # @return [String]
4875
4860
  #
4876
4861
  # @!attribute [rw] tags
@@ -4910,7 +4895,7 @@ module Aws::Comprehend
4910
4895
  # field applies only to non-text inputs for custom analysis.
4911
4896
  #
4912
4897
  # @!attribute [rw] s3_uri
4913
- # The Amazon S3 URI for the input data. The URI must be in same region
4898
+ # The Amazon S3 URI for the input data. The URI must be in same Region
4914
4899
  # as the API endpoint that you are calling. The URI can point to a
4915
4900
  # single input file or it can provide the prefix for a collection of
4916
4901
  # data files.
@@ -5128,8 +5113,8 @@ module Aws::Comprehend
5128
5113
  # @!attribute [rw] job_arn
5129
5114
  # The Amazon Resource Name (ARN) of the key phrases detection job. It
5130
5115
  # is a unique, fully qualified identifier for the job. It includes the
5131
- # AWS account, Region, and the job ID. The format of the ARN is as
5132
- # follows:
5116
+ # Amazon Web Services account, Amazon Web Services Region, and the job
5117
+ # ID. The format of the ARN is as follows:
5133
5118
  #
5134
5119
  # `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
5135
5120
  #
@@ -5175,16 +5160,15 @@ module Aws::Comprehend
5175
5160
  # @return [String]
5176
5161
  #
5177
5162
  # @!attribute [rw] data_access_role_arn
5178
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
5179
- # Management (IAM) role that grants Amazon Comprehend read access to
5180
- # your input data.
5163
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
5164
+ # Comprehend read access to your input data.
5181
5165
  # @return [String]
5182
5166
  #
5183
5167
  # @!attribute [rw] volume_kms_key_id
5184
- # ID for the AWS Key Management Service (KMS) key that Amazon
5185
- # Comprehend uses to encrypt data on the storage volume attached to
5186
- # the ML compute instance(s) that process the analysis job. The
5187
- # VolumeKmsKeyId can be either of the following formats:
5168
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on
5169
+ # the storage volume attached to the ML compute instance(s) that
5170
+ # process the analysis job. The VolumeKmsKeyId can be either of the
5171
+ # following formats:
5188
5172
  #
5189
5173
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
5190
5174
  #
@@ -6009,7 +5993,7 @@ module Aws::Comprehend
6009
5993
  # @!attribute [rw] s3_uri
6010
5994
  # When you use the `OutputDataConfig` object with asynchronous
6011
5995
  # operations, you specify the Amazon S3 location where you want to
6012
- # write the output data. The URI must be in the same region as the API
5996
+ # write the output data. The URI must be in the same Region as the API
6013
5997
  # endpoint that you are calling. The location is used as the prefix
6014
5998
  # for the actual location of the output file.
6015
5999
  #
@@ -6024,9 +6008,9 @@ module Aws::Comprehend
6024
6008
  # @return [String]
6025
6009
  #
6026
6010
  # @!attribute [rw] kms_key_id
6027
- # ID for the AWS Key Management Service (KMS) key that Amazon
6028
- # Comprehend uses to encrypt the output results from an analysis job.
6029
- # The KmsKeyId can be one of the following formats:
6011
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6012
+ # Amazon Comprehend uses to encrypt the output results from an
6013
+ # analysis job. The KmsKeyId can be one of the following formats:
6030
6014
  #
6031
6015
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6032
6016
  #
@@ -6122,8 +6106,8 @@ module Aws::Comprehend
6122
6106
  # @!attribute [rw] job_arn
6123
6107
  # The Amazon Resource Name (ARN) of the PII entities detection job. It
6124
6108
  # is a unique, fully qualified identifier for the job. It includes the
6125
- # AWS account, Region, and the job ID. The format of the ARN is as
6126
- # follows:
6109
+ # Amazon Web Services account, Amazon Web Services Region, and the job
6110
+ # ID. The format of the ARN is as follows:
6127
6111
  #
6128
6112
  # `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
6129
6113
  #
@@ -6176,9 +6160,8 @@ module Aws::Comprehend
6176
6160
  # @return [String]
6177
6161
  #
6178
6162
  # @!attribute [rw] data_access_role_arn
6179
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
6180
- # Management (IAM) role that grants Amazon Comprehend read access to
6181
- # your input data.
6163
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6164
+ # Comprehend read access to your input data.
6182
6165
  # @return [String]
6183
6166
  #
6184
6167
  # @!attribute [rw] mode
@@ -6252,8 +6235,9 @@ module Aws::Comprehend
6252
6235
  # @return [String]
6253
6236
  #
6254
6237
  # @!attribute [rw] kms_key_id
6255
- # ID for the AWS Key Management Service (KMS) key that Amazon
6256
- # Comprehend uses to encrypt the output results from an analysis job.
6238
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6239
+ # Amazon Comprehend uses to encrypt the output results from an
6240
+ # analysis job.
6257
6241
  # @return [String]
6258
6242
  #
6259
6243
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
@@ -6490,8 +6474,8 @@ module Aws::Comprehend
6490
6474
  # @!attribute [rw] job_arn
6491
6475
  # The Amazon Resource Name (ARN) of the sentiment detection job. It is
6492
6476
  # a unique, fully qualified identifier for the job. It includes the
6493
- # AWS account, Region, and the job ID. The format of the ARN is as
6494
- # follows:
6477
+ # Amazon Web Services account, Amazon Web Services Region, and the job
6478
+ # ID. The format of the ARN is as follows:
6495
6479
  #
6496
6480
  # `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
6497
6481
  #
@@ -6537,16 +6521,15 @@ module Aws::Comprehend
6537
6521
  # @return [String]
6538
6522
  #
6539
6523
  # @!attribute [rw] data_access_role_arn
6540
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
6541
- # Management (IAM) role that grants Amazon Comprehend read access to
6542
- # your input data.
6524
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6525
+ # Comprehend read access to your input data.
6543
6526
  # @return [String]
6544
6527
  #
6545
6528
  # @!attribute [rw] volume_kms_key_id
6546
- # ID for the AWS Key Management Service (KMS) key that Amazon
6547
- # Comprehend uses to encrypt data on the storage volume attached to
6548
- # the ML compute instance(s) that process the analysis job. The
6549
- # VolumeKmsKeyId can be either of the following formats:
6529
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6530
+ # Amazon Comprehend uses to encrypt data on the storage volume
6531
+ # attached to the ML compute instance(s) that process the analysis
6532
+ # job. The VolumeKmsKeyId can be either of the following formats:
6550
6533
  #
6551
6534
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6552
6535
  #
@@ -6636,9 +6619,8 @@ module Aws::Comprehend
6636
6619
  # @return [Types::OutputDataConfig]
6637
6620
  #
6638
6621
  # @!attribute [rw] data_access_role_arn
6639
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
6640
- # Management (IAM) role that grants Amazon Comprehend read access to
6641
- # your input data.
6622
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6623
+ # Comprehend read access to your input data.
6642
6624
  # @return [String]
6643
6625
  #
6644
6626
  # @!attribute [rw] client_request_token
@@ -6650,10 +6632,10 @@ module Aws::Comprehend
6650
6632
  # @return [String]
6651
6633
  #
6652
6634
  # @!attribute [rw] volume_kms_key_id
6653
- # ID for the AWS Key Management Service (KMS) key that Amazon
6654
- # Comprehend uses to encrypt data on the storage volume attached to
6655
- # the ML compute instance(s) that process the analysis job. The
6656
- # VolumeKmsKeyId can be either of the following formats:
6635
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6636
+ # Amazon Comprehend uses to encrypt data on the storage volume
6637
+ # attached to the ML compute instance(s) that process the analysis
6638
+ # job. The VolumeKmsKeyId can be either of the following formats:
6657
6639
  #
6658
6640
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6659
6641
  #
@@ -6709,8 +6691,8 @@ module Aws::Comprehend
6709
6691
  # @!attribute [rw] job_arn
6710
6692
  # The Amazon Resource Name (ARN) of the document classification job.
6711
6693
  # It is a unique, fully qualified identifier for the job. It includes
6712
- # the AWS account, Region, and the job ID. The format of the ARN is as
6713
- # follows:
6694
+ # the Amazon Web Services account, Amazon Web Services Region, and the
6695
+ # job ID. The format of the ARN is as follows:
6714
6696
  #
6715
6697
  # `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
6716
6698
  #
@@ -6762,14 +6744,13 @@ module Aws::Comprehend
6762
6744
  # @return [Types::OutputDataConfig]
6763
6745
  #
6764
6746
  # @!attribute [rw] data_access_role_arn
6765
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
6766
- # Management (IAM) role that grants Amazon Comprehend read access to
6767
- # your input data. For more information, see
6768
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
6747
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6748
+ # Comprehend read access to your input data. For more information, see
6749
+ # [Role-based permissions][1].
6769
6750
  #
6770
6751
  #
6771
6752
  #
6772
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6753
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
6773
6754
  # @return [String]
6774
6755
  #
6775
6756
  # @!attribute [rw] job_name
@@ -6785,10 +6766,10 @@ module Aws::Comprehend
6785
6766
  # @return [String]
6786
6767
  #
6787
6768
  # @!attribute [rw] volume_kms_key_id
6788
- # ID for the AWS Key Management Service (KMS) key that Amazon
6789
- # Comprehend uses to encrypt data on the storage volume attached to
6790
- # the ML compute instance(s) that process the analysis job. The
6791
- # VolumeKmsKeyId can be either of the following formats:
6769
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6770
+ # Amazon Comprehend uses to encrypt data on the storage volume
6771
+ # attached to the ML compute instance(s) that process the analysis
6772
+ # job. The VolumeKmsKeyId can be either of the following formats:
6792
6773
  #
6793
6774
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6794
6775
  #
@@ -6836,8 +6817,8 @@ module Aws::Comprehend
6836
6817
  # @!attribute [rw] job_arn
6837
6818
  # The Amazon Resource Name (ARN) of the dominant language detection
6838
6819
  # job. It is a unique, fully qualified identifier for the job. It
6839
- # includes the AWS account, Region, and the job ID. The format of the
6840
- # ARN is as follows:
6820
+ # includes the Amazon Web Services account, Amazon Web Services
6821
+ # Region, and the job ID. The format of the ARN is as follows:
6841
6822
  #
6842
6823
  # `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
6843
6824
  #
@@ -6880,14 +6861,13 @@ module Aws::Comprehend
6880
6861
  # @return [Types::OutputDataConfig]
6881
6862
  #
6882
6863
  # @!attribute [rw] data_access_role_arn
6883
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
6884
- # Management (IAM) role that grants Amazon Comprehend read access to
6885
- # your input data. For more information, see
6886
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
6864
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6865
+ # Comprehend read access to your input data. For more information, see
6866
+ # [Role-based permissions][1].
6887
6867
  #
6888
6868
  #
6889
6869
  #
6890
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6870
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
6891
6871
  # @return [String]
6892
6872
  #
6893
6873
  # @!attribute [rw] job_name
@@ -6917,10 +6897,10 @@ module Aws::Comprehend
6917
6897
  # @return [String]
6918
6898
  #
6919
6899
  # @!attribute [rw] volume_kms_key_id
6920
- # ID for the AWS Key Management Service (KMS) key that Amazon
6921
- # Comprehend uses to encrypt data on the storage volume attached to
6922
- # the ML compute instance(s) that process the analysis job. The
6923
- # VolumeKmsKeyId can be either of the following formats:
6900
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6901
+ # Amazon Comprehend uses to encrypt data on the storage volume
6902
+ # attached to the ML compute instance(s) that process the analysis
6903
+ # job. The VolumeKmsKeyId can be either of the following formats:
6924
6904
  #
6925
6905
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6926
6906
  #
@@ -6976,8 +6956,8 @@ module Aws::Comprehend
6976
6956
  # @!attribute [rw] job_arn
6977
6957
  # The Amazon Resource Name (ARN) of the entities detection job. It is
6978
6958
  # a unique, fully qualified identifier for the job. It includes the
6979
- # AWS account, Region, and the job ID. The format of the ARN is as
6980
- # follows:
6959
+ # Amazon Web Services account, Amazon Web Services Region, and the job
6960
+ # ID. The format of the ARN is as follows:
6981
6961
  #
6982
6962
  # `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
6983
6963
  #
@@ -7030,9 +7010,8 @@ module Aws::Comprehend
7030
7010
  # @return [Types::OutputDataConfig]
7031
7011
  #
7032
7012
  # @!attribute [rw] data_access_role_arn
7033
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7034
- # Management (IAM) role that grants Amazon Comprehend read access to
7035
- # your input data.
7013
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7014
+ # Comprehend read access to your input data.
7036
7015
  # @return [String]
7037
7016
  #
7038
7017
  # @!attribute [rw] job_name
@@ -7084,9 +7063,9 @@ module Aws::Comprehend
7084
7063
  #
7085
7064
  # @!attribute [rw] job_arn
7086
7065
  # The Amazon Resource Name (ARN) of the events detection job. It is a
7087
- # unique, fully qualified identifier for the job. It includes the AWS
7088
- # account, Region, and the job ID. The format of the ARN is as
7089
- # follows:
7066
+ # unique, fully qualified identifier for the job. It includes the
7067
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7068
+ # ID. The format of the ARN is as follows:
7090
7069
  #
7091
7070
  # `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
7092
7071
  #
@@ -7151,14 +7130,13 @@ module Aws::Comprehend
7151
7130
  # @return [Types::OutputDataConfig]
7152
7131
  #
7153
7132
  # @!attribute [rw] data_access_role_arn
7154
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7155
- # Management (IAM) role that grants Amazon Comprehend read access to
7156
- # your input data. For more information, see
7157
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
7133
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7134
+ # Comprehend read access to your input data. For more information, see
7135
+ # [Role-based permissions][1].
7158
7136
  #
7159
7137
  #
7160
7138
  #
7161
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7139
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7162
7140
  # @return [String]
7163
7141
  #
7164
7142
  # @!attribute [rw] job_name
@@ -7180,10 +7158,10 @@ module Aws::Comprehend
7180
7158
  # @return [String]
7181
7159
  #
7182
7160
  # @!attribute [rw] volume_kms_key_id
7183
- # ID for the AWS Key Management Service (KMS) key that Amazon
7184
- # Comprehend uses to encrypt data on the storage volume attached to
7185
- # the ML compute instance(s) that process the analysis job. The
7186
- # VolumeKmsKeyId can be either of the following formats:
7161
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7162
+ # Amazon Comprehend uses to encrypt data on the storage volume
7163
+ # attached to the ML compute instance(s) that process the analysis
7164
+ # job. The VolumeKmsKeyId can be either of the following formats:
7187
7165
  #
7188
7166
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7189
7167
  #
@@ -7232,8 +7210,8 @@ module Aws::Comprehend
7232
7210
  # @!attribute [rw] job_arn
7233
7211
  # The Amazon Resource Name (ARN) of the key phrase detection job. It
7234
7212
  # is a unique, fully qualified identifier for the job. It includes the
7235
- # AWS account, Region, and the job ID. The format of the ARN is as
7236
- # follows:
7213
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7214
+ # ID. The format of the ARN is as follows:
7237
7215
  #
7238
7216
  # `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
7239
7217
  #
@@ -7290,9 +7268,8 @@ module Aws::Comprehend
7290
7268
  # @return [Types::RedactionConfig]
7291
7269
  #
7292
7270
  # @!attribute [rw] data_access_role_arn
7293
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7294
- # Management (IAM) role that grants Amazon Comprehend read access to
7295
- # your input data.
7271
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7272
+ # Comprehend read access to your input data.
7296
7273
  # @return [String]
7297
7274
  #
7298
7275
  # @!attribute [rw] job_name
@@ -7342,8 +7319,8 @@ module Aws::Comprehend
7342
7319
  # @!attribute [rw] job_arn
7343
7320
  # The Amazon Resource Name (ARN) of the PII entity detection job. It
7344
7321
  # is a unique, fully qualified identifier for the job. It includes the
7345
- # AWS account, Region, and the job ID. The format of the ARN is as
7346
- # follows:
7322
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7323
+ # ID. The format of the ARN is as follows:
7347
7324
  #
7348
7325
  # `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
7349
7326
  #
@@ -7375,14 +7352,13 @@ module Aws::Comprehend
7375
7352
  # @return [Types::OutputDataConfig]
7376
7353
  #
7377
7354
  # @!attribute [rw] data_access_role_arn
7378
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7379
- # Management (IAM) role that grants Amazon Comprehend read access to
7380
- # your input data. For more information, see
7381
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
7355
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7356
+ # Comprehend read access to your input data. For more information, see
7357
+ # [Role-based permissions][1].
7382
7358
  #
7383
7359
  #
7384
7360
  #
7385
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7361
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7386
7362
  # @return [String]
7387
7363
  #
7388
7364
  # @!attribute [rw] job_name
@@ -7404,10 +7380,10 @@ module Aws::Comprehend
7404
7380
  # @return [String]
7405
7381
  #
7406
7382
  # @!attribute [rw] volume_kms_key_id
7407
- # ID for the AWS Key Management Service (KMS) key that Amazon
7408
- # Comprehend uses to encrypt data on the storage volume attached to
7409
- # the ML compute instance(s) that process the analysis job. The
7410
- # VolumeKmsKeyId can be either of the following formats:
7383
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7384
+ # Amazon Comprehend uses to encrypt data on the storage volume
7385
+ # attached to the ML compute instance(s) that process the analysis
7386
+ # job. The VolumeKmsKeyId can be either of the following formats:
7411
7387
  #
7412
7388
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7413
7389
  #
@@ -7456,8 +7432,8 @@ module Aws::Comprehend
7456
7432
  # @!attribute [rw] job_arn
7457
7433
  # The Amazon Resource Name (ARN) of the sentiment detection job. It is
7458
7434
  # a unique, fully qualified identifier for the job. It includes the
7459
- # AWS account, Region, and the job ID. The format of the ARN is as
7460
- # follows:
7435
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7436
+ # ID. The format of the ARN is as follows:
7461
7437
  #
7462
7438
  # `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
7463
7439
  #
@@ -7501,10 +7477,9 @@ module Aws::Comprehend
7501
7477
  # @return [Types::OutputDataConfig]
7502
7478
  #
7503
7479
  # @!attribute [rw] data_access_role_arn
7504
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7505
- # Management (IAM) role that grants Amazon Comprehend read access to
7506
- # your input data. For more information, see [Role-based
7507
- # permissions][1].
7480
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7481
+ # Comprehend read access to your input data. For more information, see
7482
+ # [Role-based permissions][1].
7508
7483
  #
7509
7484
  #
7510
7485
  #
@@ -7582,8 +7557,8 @@ module Aws::Comprehend
7582
7557
  # @!attribute [rw] job_arn
7583
7558
  # The Amazon Resource Name (ARN) of the targeted sentiment detection
7584
7559
  # job. It is a unique, fully qualified identifier for the job. It
7585
- # includes the AWS account, Region, and the job ID. The format of the
7586
- # ARN is as follows:
7560
+ # includes the Amazon Web Services account, Amazon Web Services
7561
+ # Region, and the job ID. The format of the ARN is as follows:
7587
7562
  #
7588
7563
  # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
7589
7564
  #
@@ -7629,14 +7604,13 @@ module Aws::Comprehend
7629
7604
  # @return [Types::OutputDataConfig]
7630
7605
  #
7631
7606
  # @!attribute [rw] data_access_role_arn
7632
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
7633
- # Management (IAM) role that grants Amazon Comprehend read access to
7634
- # your input data. For more information, see
7635
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
7607
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7608
+ # Comprehend read access to your input data. For more information, see
7609
+ # [Role-based permissions][1].
7636
7610
  #
7637
7611
  #
7638
7612
  #
7639
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7613
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7640
7614
  # @return [String]
7641
7615
  #
7642
7616
  # @!attribute [rw] job_name
@@ -7656,10 +7630,10 @@ module Aws::Comprehend
7656
7630
  # @return [String]
7657
7631
  #
7658
7632
  # @!attribute [rw] volume_kms_key_id
7659
- # ID for the AWS Key Management Service (KMS) key that Amazon
7660
- # Comprehend uses to encrypt data on the storage volume attached to
7661
- # the ML compute instance(s) that process the analysis job. The
7662
- # VolumeKmsKeyId can be either of the following formats:
7633
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7634
+ # Amazon Comprehend uses to encrypt data on the storage volume
7635
+ # attached to the ML compute instance(s) that process the analysis
7636
+ # job. The VolumeKmsKeyId can be either of the following formats:
7663
7637
  #
7664
7638
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7665
7639
  #
@@ -7707,9 +7681,9 @@ module Aws::Comprehend
7707
7681
  #
7708
7682
  # @!attribute [rw] job_arn
7709
7683
  # The Amazon Resource Name (ARN) of the topics detection job. It is a
7710
- # unique, fully qualified identifier for the job. It includes the AWS
7711
- # account, Region, and the job ID. The format of the ARN is as
7712
- # follows:
7684
+ # unique, fully qualified identifier for the job. It includes the
7685
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7686
+ # ID. The format of the ARN is as follows:
7713
7687
  #
7714
7688
  # `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
7715
7689
  #
@@ -8136,8 +8110,8 @@ module Aws::Comprehend
8136
8110
  # @!attribute [rw] job_arn
8137
8111
  # The Amazon Resource Name (ARN) of the targeted sentiment detection
8138
8112
  # job. It is a unique, fully qualified identifier for the job. It
8139
- # includes the AWS account, Region, and the job ID. The format of the
8140
- # ARN is as follows:
8113
+ # includes the Amazon Web Services account, Amazon Web Services
8114
+ # Region, and the job ID. The format of the ARN is as follows:
8141
8115
  #
8142
8116
  # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
8143
8117
  #
@@ -8183,9 +8157,8 @@ module Aws::Comprehend
8183
8157
  # @return [String]
8184
8158
  #
8185
8159
  # @!attribute [rw] data_access_role_arn
8186
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
8187
- # Management (IAM) role that grants Amazon Comprehend read access to
8188
- # your input data.
8160
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8161
+ # Comprehend read access to your input data.
8189
8162
  # @return [String]
8190
8163
  #
8191
8164
  # @!attribute [rw] volume_kms_key_id
@@ -8448,9 +8421,9 @@ module Aws::Comprehend
8448
8421
  #
8449
8422
  # @!attribute [rw] job_arn
8450
8423
  # The Amazon Resource Name (ARN) of the topics detection job. It is a
8451
- # unique, fully qualified identifier for the job. It includes the AWS
8452
- # account, Region, and the job ID. The format of the ARN is as
8453
- # follows:
8424
+ # unique, fully qualified identifier for the job. It includes the
8425
+ # Amazon Web Services account, Amazon Web Services Region, and the job
8426
+ # ID. The format of the ARN is as follows:
8454
8427
  #
8455
8428
  # `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
8456
8429
  #
@@ -8497,16 +8470,15 @@ module Aws::Comprehend
8497
8470
  # @return [Integer]
8498
8471
  #
8499
8472
  # @!attribute [rw] data_access_role_arn
8500
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
8501
- # Management (IAM) role that grants Amazon Comprehend read access to
8502
- # your job data.
8473
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8474
+ # Comprehend read access to your job data.
8503
8475
  # @return [String]
8504
8476
  #
8505
8477
  # @!attribute [rw] volume_kms_key_id
8506
- # ID for the AWS Key Management Service (KMS) key that Amazon
8507
- # Comprehend uses to encrypt data on the storage volume attached to
8508
- # the ML compute instance(s) that process the analysis job. The
8509
- # VolumeKmsKeyId can be either of the following formats:
8478
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
8479
+ # Amazon Comprehend uses to encrypt data on the storage volume
8480
+ # attached to the ML compute instance(s) that process the analysis
8481
+ # job. The VolumeKmsKeyId can be either of the following formats:
8510
8482
  #
8511
8483
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
8512
8484
  #
@@ -8593,9 +8565,9 @@ module Aws::Comprehend
8593
8565
  # Data security configuration.
8594
8566
  #
8595
8567
  # @!attribute [rw] model_kms_key_id
8596
- # ID for the AWS Key Management Service (KMS) key that Amazon
8597
- # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
8598
- # can be either of the following formats:
8568
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
8569
+ # custom models. The ModelKmsKeyId can be either of the following
8570
+ # formats:
8599
8571
  #
8600
8572
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
8601
8573
  #
@@ -8684,9 +8656,8 @@ module Aws::Comprehend
8684
8656
  # @return [String]
8685
8657
  #
8686
8658
  # @!attribute [rw] data_access_role_arn
8687
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
8688
- # Management (IAM) role that grants Amazon Comprehend permission to
8689
- # access the flywheel data.
8659
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8660
+ # Comprehend permission to access the flywheel data.
8690
8661
  # @return [String]
8691
8662
  #
8692
8663
  # @!attribute [rw] data_security_config
@@ -8741,7 +8712,7 @@ module Aws::Comprehend
8741
8712
  # @!attribute [rw] subnets
8742
8713
  # The ID for each subnet being used in your private VPC. This subnet
8743
8714
  # is a subset of the a range of IPv4 addresses used by the VPC and is
8744
- # specific to a given availability zone in the VPC’s region. This ID
8715
+ # specific to a given availability zone in the VPC’s Region. This ID
8745
8716
  # number is preceded by "subnet-", for instance:
8746
8717
  # "subnet-04ccf456919e69055". For more information, see [VPCs and
8747
8718
  # Subnets][1].