aws-sdk-comprehend 1.66.0 → 1.68.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
@@ -862,6 +856,16 @@ module Aws::Comprehend
862
856
  # errors.
863
857
  # @return [Array<Types::ErrorsListItem>]
864
858
  #
859
+ # @!attribute [rw] warnings
860
+ # Warnings detected while processing the input document. The response
861
+ # includes a warning if there is a mismatch between the input document
862
+ # type and the model type associated with the endpoint that you
863
+ # specified. The response can also include warnings for individual
864
+ # pages that have a mismatch.
865
+ #
866
+ # The field is empty if the system generated no warnings.
867
+ # @return [Array<Types::WarningsListItem>]
868
+ #
865
869
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentResponse AWS API Documentation
866
870
  #
867
871
  class ClassifyDocumentResponse < Struct.new(
@@ -869,7 +873,8 @@ module Aws::Comprehend
869
873
  :labels,
870
874
  :document_metadata,
871
875
  :document_type,
872
- :errors)
876
+ :errors,
877
+ :warnings)
873
878
  SENSITIVE = []
874
879
  include Aws::Structure
875
880
  end
@@ -990,13 +995,12 @@ module Aws::Comprehend
990
995
  # names can have a maximum of 256 characters. Alphanumeric characters,
991
996
  # hyphens (-) and underscores (\_) are allowed. The version name must
992
997
  # be unique among all models with the same classifier name in the
993
- # account/AWS Region.
998
+ # Amazon Web Services account/Amazon Web Services Region.
994
999
  # @return [String]
995
1000
  #
996
1001
  # @!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.
1002
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1003
+ # Comprehend read access to your input data.
1000
1004
  # @return [String]
1001
1005
  #
1002
1006
  # @!attribute [rw] tags
@@ -1011,8 +1015,9 @@ module Aws::Comprehend
1011
1015
  # @return [Types::DocumentClassifierInputDataConfig]
1012
1016
  #
1013
1017
  # @!attribute [rw] output_data_config
1014
- # Enables the addition of output results configuration parameters for
1015
- # custom classifier jobs.
1018
+ # Specifies the location for the output files from a custom classifier
1019
+ # job. This parameter is required for a request that creates a native
1020
+ # classifier model.
1016
1021
  # @return [Types::DocumentClassifierOutputDataConfig]
1017
1022
  #
1018
1023
  # @!attribute [rw] client_request_token
@@ -1030,10 +1035,10 @@ module Aws::Comprehend
1030
1035
  # @return [String]
1031
1036
  #
1032
1037
  # @!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:
1038
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
1039
+ # Amazon Comprehend uses to encrypt data on the storage volume
1040
+ # attached to the ML compute instance(s) that process the analysis
1041
+ # job. The VolumeKmsKeyId can be either of the following formats:
1037
1042
  #
1038
1043
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1039
1044
  #
@@ -1061,9 +1066,9 @@ module Aws::Comprehend
1061
1066
  # @return [String]
1062
1067
  #
1063
1068
  # @!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:
1069
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1070
+ # custom models. The ModelKmsKeyId can be either of the following
1071
+ # formats:
1067
1072
  #
1068
1073
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1069
1074
  #
@@ -1073,8 +1078,8 @@ module Aws::Comprehend
1073
1078
  #
1074
1079
  # @!attribute [rw] model_policy
1075
1080
  # 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.
1081
+ # classifier model. You can use this policy to allow another Amazon
1082
+ # Web Services account to import your custom model.
1078
1083
  #
1079
1084
  # Provide your policy as a JSON body that you enter as a UTF-8 encoded
1080
1085
  # string without line breaks. To provide valid JSON, enclose the
@@ -1156,10 +1161,9 @@ module Aws::Comprehend
1156
1161
  # @return [Array<Types::Tag>]
1157
1162
  #
1158
1163
  # @!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).
1164
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1165
+ # Comprehend read access to trained custom models encrypted with a
1166
+ # customer managed key (ModelKmsKeyId).
1163
1167
  # @return [String]
1164
1168
  #
1165
1169
  # @!attribute [rw] flywheel_arn
@@ -1203,7 +1207,7 @@ module Aws::Comprehend
1203
1207
  # The name given to the newly created recognizer. Recognizer names can
1204
1208
  # be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
1205
1209
  # and underscores (\_) are allowed. The name must be unique in the
1206
- # account/region.
1210
+ # account/Region.
1207
1211
  # @return [String]
1208
1212
  #
1209
1213
  # @!attribute [rw] version_name
@@ -1211,13 +1215,12 @@ module Aws::Comprehend
1211
1215
  # names can be a maximum of 256 characters. Alphanumeric characters,
1212
1216
  # hyphens (-) and underscores (\_) are allowed. The version name must
1213
1217
  # be unique among all models with the same recognizer name in the
1214
- # account/ AWS Region.
1218
+ # account/Region.
1215
1219
  # @return [String]
1216
1220
  #
1217
1221
  # @!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.
1222
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1223
+ # Comprehend read access to your input data.
1221
1224
  # @return [String]
1222
1225
  #
1223
1226
  # @!attribute [rw] tags
@@ -1229,7 +1232,7 @@ module Aws::Comprehend
1229
1232
  #
1230
1233
  # @!attribute [rw] input_data_config
1231
1234
  # 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
1235
+ # containing the input data must be located in the same Region as the
1233
1236
  # entity recognizer being created.
1234
1237
  # @return [Types::EntityRecognizerInputDataConfig]
1235
1238
  #
@@ -1251,10 +1254,10 @@ module Aws::Comprehend
1251
1254
  # @return [String]
1252
1255
  #
1253
1256
  # @!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:
1257
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
1258
+ # Amazon Comprehend uses to encrypt data on the storage volume
1259
+ # attached to the ML compute instance(s) that process the analysis
1260
+ # job. The VolumeKmsKeyId can be either of the following formats:
1258
1261
  #
1259
1262
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1260
1263
  #
@@ -1273,9 +1276,9 @@ module Aws::Comprehend
1273
1276
  # @return [Types::VpcConfig]
1274
1277
  #
1275
1278
  # @!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:
1279
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1280
+ # custom models. The ModelKmsKeyId can be either of the following
1281
+ # formats:
1279
1282
  #
1280
1283
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1281
1284
  #
@@ -1285,8 +1288,8 @@ module Aws::Comprehend
1285
1288
  #
1286
1289
  # @!attribute [rw] model_policy
1287
1290
  # 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.
1291
+ # recognizer model. You can use this policy to allow another Amazon
1292
+ # Web Services account to import your custom model.
1290
1293
  #
1291
1294
  # Provide your JSON as a UTF-8 encoded string without line breaks. To
1292
1295
  # provide valid JSON for your policy, enclose the attribute names and
@@ -1343,9 +1346,9 @@ module Aws::Comprehend
1343
1346
  # @return [String]
1344
1347
  #
1345
1348
  # @!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.
1349
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1350
+ # Comprehend the permissions required to access the flywheel data in
1351
+ # the data lake.
1349
1352
  # @return [String]
1350
1353
  #
1351
1354
  # @!attribute [rw] task_config
@@ -1415,9 +1418,9 @@ module Aws::Comprehend
1415
1418
  # Data security configuration.
1416
1419
  #
1417
1420
  # @!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:
1421
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1422
+ # custom models. The ModelKmsKeyId can be either of the following
1423
+ # formats:
1421
1424
  #
1422
1425
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1423
1426
  #
@@ -1522,7 +1525,7 @@ module Aws::Comprehend
1522
1525
  #
1523
1526
  # @!attribute [rw] s3_uri
1524
1527
  # 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
1528
+ # same Region as the API endpoint that you are calling. The URI can
1526
1529
  # point to a single input file or it can provide the prefix for a
1527
1530
  # collection of input files.
1528
1531
  #
@@ -1558,7 +1561,7 @@ module Aws::Comprehend
1558
1561
  #
1559
1562
  # @!attribute [rw] s3_uri
1560
1563
  # 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
1564
+ # entity recognizer are located. The URI must be in the same Region as
1562
1565
  # the API endpoint that you are calling.
1563
1566
  # @return [String]
1564
1567
  #
@@ -1686,11 +1689,11 @@ module Aws::Comprehend
1686
1689
  # @return [Array<Types::DatasetAugmentedManifestsListItem>]
1687
1690
  #
1688
1691
  # @!attribute [rw] data_format
1689
- # `COMPREHEND_CSV`\: The data format is a two-column CSV file, where
1692
+ # `COMPREHEND_CSV`: The data format is a two-column CSV file, where
1690
1693
  # the first column contains labels and the second column contains
1691
1694
  # documents.
1692
1695
  #
1693
- # `AUGMENTED_MANIFEST`\: The data format
1696
+ # `AUGMENTED_MANIFEST`: The data format
1694
1697
  # @return [String]
1695
1698
  #
1696
1699
  # @!attribute [rw] document_classifier_input_data_config
@@ -2311,11 +2314,14 @@ module Aws::Comprehend
2311
2314
  end
2312
2315
 
2313
2316
  # @!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.
2317
+ # Array of languages that Amazon Comprehend detected in the input
2318
+ # text. The array is sorted in descending order of the score (the
2319
+ # dominant language is always the first element in the array).
2320
+ #
2321
+ # For each language, the response returns the RFC 5646 language code
2322
+ # and the level of confidence that Amazon Comprehend has in the
2323
+ # accuracy of its inference. For more information about RFC 5646, see
2324
+ # [Tags for Identifying Languages][1] on the *IETF Tools* web site.
2319
2325
  #
2320
2326
  #
2321
2327
  #
@@ -2537,12 +2543,6 @@ module Aws::Comprehend
2537
2543
 
2538
2544
  # @!attribute [rw] text
2539
2545
  # 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
2546
  # @return [String]
2547
2547
  #
2548
2548
  # @!attribute [rw] language_code
@@ -2743,8 +2743,8 @@ module Aws::Comprehend
2743
2743
  # @!attribute [rw] job_arn
2744
2744
  # The Amazon Resource Name (ARN) of the document classification job.
2745
2745
  # 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:
2746
+ # the Amazon Web Services account, Amazon Web Services Region, and the
2747
+ # job ID. The format of the ARN is as follows:
2748
2748
  #
2749
2749
  # `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
2750
2750
  #
@@ -2791,16 +2791,15 @@ module Aws::Comprehend
2791
2791
  # @return [Types::OutputDataConfig]
2792
2792
  #
2793
2793
  # @!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.
2794
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
2795
+ # Comprehend read access to your input data.
2797
2796
  # @return [String]
2798
2797
  #
2799
2798
  # @!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:
2799
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
2800
+ # Amazon Comprehend uses to encrypt data on the storage volume
2801
+ # attached to the ML compute instance(s) that process the analysis
2802
+ # job. The VolumeKmsKeyId can be either of the following formats:
2804
2803
  #
2805
2804
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2806
2805
  #
@@ -2843,6 +2842,29 @@ module Aws::Comprehend
2843
2842
  include Aws::Structure
2844
2843
  end
2845
2844
 
2845
+ # The location of the training documents. This parameter is required in
2846
+ # a request to create a native classifier model.
2847
+ #
2848
+ # @!attribute [rw] s3_uri
2849
+ # The S3 URI location of the training documents specified in the S3Uri
2850
+ # CSV file.
2851
+ # @return [String]
2852
+ #
2853
+ # @!attribute [rw] test_s3_uri
2854
+ # The S3 URI location of the test documents included in the TestS3Uri
2855
+ # CSV file. This field is not required if you do not specify a test
2856
+ # CSV file.
2857
+ # @return [String]
2858
+ #
2859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierDocuments AWS API Documentation
2860
+ #
2861
+ class DocumentClassifierDocuments < Struct.new(
2862
+ :s3_uri,
2863
+ :test_s3_uri)
2864
+ SENSITIVE = []
2865
+ include Aws::Structure
2866
+ end
2867
+
2846
2868
  # Provides information for filtering a list of document classifiers. You
2847
2869
  # can only specify one filtering parameter in a request. For more
2848
2870
  # information, see the `ListDocumentClassifiers` operation.
@@ -2892,15 +2914,15 @@ module Aws::Comprehend
2892
2914
  # @!attribute [rw] data_format
2893
2915
  # The format of your training data:
2894
2916
  #
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.
2917
+ # * `COMPREHEND_CSV`: A two-column CSV file, where labels are provided
2918
+ # in the first column, and documents are provided in the second. If
2919
+ # you use this value, you must provide the `S3Uri` parameter in your
2920
+ # request.
2899
2921
  #
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.
2922
+ # * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
2923
+ # SageMaker Ground Truth. This file is in JSON lines format. Each
2924
+ # line is a complete JSON object that contains a training document
2925
+ # and its associated labels.
2904
2926
  #
2905
2927
  # If you use this value, you must provide the `AugmentedManifests`
2906
2928
  # parameter in your request.
@@ -2911,7 +2933,7 @@ module Aws::Comprehend
2911
2933
  #
2912
2934
  # @!attribute [rw] s3_uri
2913
2935
  # 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
2936
+ # same Region as the API endpoint that you are calling. The URI can
2915
2937
  # point to a single input file or it can provide the prefix for a
2916
2938
  # collection of input files.
2917
2939
  #
@@ -2926,8 +2948,8 @@ module Aws::Comprehend
2926
2948
  #
2927
2949
  # @!attribute [rw] test_s3_uri
2928
2950
  # 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.
2951
+ # an entity recognizer are located. The URI must be in the same Amazon
2952
+ # Web Services Region as the API endpoint that you are calling.
2931
2953
  # @return [String]
2932
2954
  #
2933
2955
  # @!attribute [rw] label_delimiter
@@ -2949,6 +2971,45 @@ module Aws::Comprehend
2949
2971
  # `AUGMENTED_MANIFEST`.
2950
2972
  # @return [Array<Types::AugmentedManifestsListItem>]
2951
2973
  #
2974
+ # @!attribute [rw] document_type
2975
+ # The type of input documents for training the model. Provide
2976
+ # plain-text documents to create a plain-text model, and provide
2977
+ # semi-structured documents to create a native model.
2978
+ # @return [String]
2979
+ #
2980
+ # @!attribute [rw] documents
2981
+ # The S3 location of the training documents. This parameter is
2982
+ # required in a request to create a native classifier model.
2983
+ # @return [Types::DocumentClassifierDocuments]
2984
+ #
2985
+ # @!attribute [rw] document_reader_config
2986
+ # Provides configuration parameters to override the default actions
2987
+ # for extracting text from PDF documents and image files.
2988
+ #
2989
+ # By default, Amazon Comprehend performs the following actions to
2990
+ # extract text from files, based on the input file type:
2991
+ #
2992
+ # * **Word files** - Amazon Comprehend parser extracts the text.
2993
+ #
2994
+ # * **Digital PDF files** - Amazon Comprehend parser extracts the
2995
+ # text.
2996
+ #
2997
+ # * **Image files and scanned PDF files** - Amazon Comprehend uses the
2998
+ # Amazon Textract `DetectDocumentText` API to extract the text.
2999
+ #
3000
+ # `DocumentReaderConfig` does not apply to plain text files or Word
3001
+ # files.
3002
+ #
3003
+ # For image files and PDF documents, you can override these default
3004
+ # actions using the fields listed below. For more information, see [
3005
+ # Setting text extraction options][1] in the Comprehend Developer
3006
+ # Guide.
3007
+ #
3008
+ #
3009
+ #
3010
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html
3011
+ # @return [Types::DocumentReaderConfig]
3012
+ #
2952
3013
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
2953
3014
  #
2954
3015
  class DocumentClassifierInputDataConfig < Struct.new(
@@ -2956,20 +3017,24 @@ module Aws::Comprehend
2956
3017
  :s3_uri,
2957
3018
  :test_s3_uri,
2958
3019
  :label_delimiter,
2959
- :augmented_manifests)
3020
+ :augmented_manifests,
3021
+ :document_type,
3022
+ :documents,
3023
+ :document_reader_config)
2960
3024
  SENSITIVE = []
2961
3025
  include Aws::Structure
2962
3026
  end
2963
3027
 
2964
- # Provides output results configuration parameters for custom classifier
2965
- # jobs.
3028
+ # Provide the location for output data from a custom classifier job.
3029
+ # This field is mandatory if you are training a native classifier model.
2966
3030
  #
2967
3031
  # @!attribute [rw] s3_uri
2968
3032
  # When you use the `OutputDataConfig` object while creating a custom
2969
3033
  # 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
2971
- # the API endpoint that you are calling. The location is used as the
2972
- # prefix for the actual location of this output file.
3034
+ # write the confusion matrix and other output files. The URI must be
3035
+ # in the same Region as the API endpoint that you are calling. The
3036
+ # location is used as the prefix for the actual location of this
3037
+ # output file.
2973
3038
  #
2974
3039
  # When the custom classifier job is finished, the service creates the
2975
3040
  # output file in a directory specific to the job. The `S3Uri` field
@@ -2978,9 +3043,9 @@ module Aws::Comprehend
2978
3043
  # @return [String]
2979
3044
  #
2980
3045
  # @!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:
3046
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3047
+ # Amazon Comprehend uses to encrypt the output results from an
3048
+ # analysis job. The KmsKeyId can be one of the following formats:
2984
3049
  #
2985
3050
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2986
3051
  #
@@ -3022,9 +3087,13 @@ module Aws::Comprehend
3022
3087
  #
3023
3088
  # @!attribute [rw] status
3024
3089
  # The status of the document classifier. If the status is `TRAINED`
3025
- # the classifier is ready to use. If the status is `FAILED` you can
3026
- # see additional information about why the classifier wasn't trained
3027
- # in the `Message` field.
3090
+ # the classifier is ready to use. If the status is
3091
+ # `TRAINED_WITH_WARNINGS` the classifier training succeeded, but you
3092
+ # should review the warnings returned in the
3093
+ # `CreateDocumentClassifier` response.
3094
+ #
3095
+ # If the status is `FAILED` you can see additional information about
3096
+ # why the classifier wasn't trained in the `Message` field.
3028
3097
  # @return [String]
3029
3098
  #
3030
3099
  # @!attribute [rw] message
@@ -3069,16 +3138,15 @@ module Aws::Comprehend
3069
3138
  # @return [Types::ClassifierMetadata]
3070
3139
  #
3071
3140
  # @!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.
3141
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3142
+ # Comprehend read access to your input data.
3075
3143
  # @return [String]
3076
3144
  #
3077
3145
  # @!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:
3146
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3147
+ # Amazon Comprehend uses to encrypt data on the storage volume
3148
+ # attached to the ML compute instance(s) that process the analysis
3149
+ # job. The VolumeKmsKeyId can be either of the following formats:
3082
3150
  #
3083
3151
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3084
3152
  #
@@ -3104,9 +3172,9 @@ module Aws::Comprehend
3104
3172
  # @return [String]
3105
3173
  #
3106
3174
  # @!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:
3175
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
3176
+ # custom models. The ModelKmsKeyId can be either of the following
3177
+ # formats:
3110
3178
  #
3111
3179
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3112
3180
  #
@@ -3120,8 +3188,8 @@ module Aws::Comprehend
3120
3188
  #
3121
3189
  # @!attribute [rw] source_model_arn
3122
3190
  # 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.
3191
+ # imported from a different Amazon Web Services account to create the
3192
+ # document classifier model in your Amazon Web Services account.
3125
3193
  # @return [String]
3126
3194
  #
3127
3195
  # @!attribute [rw] flywheel_arn
@@ -3255,11 +3323,11 @@ module Aws::Comprehend
3255
3323
  #
3256
3324
  # For image files and PDF documents, you can override these default
3257
3325
  # actions using the fields listed below. For more information, see [
3258
- # Setting text extraction options][1].
3326
+ # Setting text extraction options][1] in the Comprehend Developer Guide.
3259
3327
  #
3260
3328
  #
3261
3329
  #
3262
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf
3330
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html
3263
3331
  #
3264
3332
  # @!attribute [rw] document_read_action
3265
3333
  # This field defines the Amazon Textract API operation that Amazon
@@ -3400,8 +3468,8 @@ module Aws::Comprehend
3400
3468
  # @!attribute [rw] job_arn
3401
3469
  # The Amazon Resource Name (ARN) of the dominant language detection
3402
3470
  # 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:
3471
+ # includes the Amazon Web Services account, Amazon Web Services
3472
+ # Region, and the job ID. The format of the ARN is as follows:
3405
3473
  #
3406
3474
  # `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
3407
3475
  #
@@ -3444,16 +3512,15 @@ module Aws::Comprehend
3444
3512
  # @return [Types::OutputDataConfig]
3445
3513
  #
3446
3514
  # @!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.
3515
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3516
+ # Comprehend read access to your input data.
3450
3517
  # @return [String]
3451
3518
  #
3452
3519
  # @!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:
3520
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3521
+ # Amazon Comprehend uses to encrypt data on the storage volume
3522
+ # attached to the ML compute instance(s) that process the analysis
3523
+ # job. The VolumeKmsKeyId can be either of the following formats:
3457
3524
  #
3458
3525
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3459
3526
  #
@@ -3577,10 +3644,9 @@ module Aws::Comprehend
3577
3644
  # @return [Time]
3578
3645
  #
3579
3646
  # @!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).
3647
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3648
+ # Comprehend read access to trained custom models encrypted with a
3649
+ # customer managed key (ModelKmsKeyId).
3584
3650
  # @return [String]
3585
3651
  #
3586
3652
  # @!attribute [rw] desired_data_access_role_arn
@@ -3657,8 +3723,8 @@ module Aws::Comprehend
3657
3723
  # @!attribute [rw] job_arn
3658
3724
  # The Amazon Resource Name (ARN) of the entities detection job. It is
3659
3725
  # 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:
3726
+ # Amazon Web Services account, Amazon Web Services Region, and the job
3727
+ # ID. The format of the ARN is as follows:
3662
3728
  #
3663
3729
  # `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
3664
3730
  #
@@ -3709,16 +3775,15 @@ module Aws::Comprehend
3709
3775
  # @return [String]
3710
3776
  #
3711
3777
  # @!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.
3778
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
3779
+ # Comprehend read access to your input data.
3715
3780
  # @return [String]
3716
3781
  #
3717
3782
  # @!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:
3783
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
3784
+ # Amazon Comprehend uses to encrypt data on the storage volume
3785
+ # attached to the ML compute instance(s) that process the analysis
3786
+ # job. The VolumeKmsKeyId can be either of the following formats:
3722
3787
  #
3723
3788
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
3724
3789
  #
@@ -3736,6 +3801,11 @@ module Aws::Comprehend
3736
3801
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
3737
3802
  # @return [Types::VpcConfig]
3738
3803
  #
3804
+ # @!attribute [rw] flywheel_arn
3805
+ # The Amazon Resource Name (ARN) of the flywheel associated with this
3806
+ # job.
3807
+ # @return [String]
3808
+ #
3739
3809
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties AWS API Documentation
3740
3810
  #
3741
3811
  class EntitiesDetectionJobProperties < Struct.new(
@@ -3752,7 +3822,8 @@ module Aws::Comprehend
3752
3822
  :language_code,
3753
3823
  :data_access_role_arn,
3754
3824
  :volume_kms_key_id,
3755
- :vpc_config)
3825
+ :vpc_config,
3826
+ :flywheel_arn)
3756
3827
  SENSITIVE = []
3757
3828
  include Aws::Structure
3758
3829
  end
@@ -3847,13 +3918,13 @@ module Aws::Comprehend
3847
3918
  #
3848
3919
  # @!attribute [rw] s3_uri
3849
3920
  # 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
3921
+ # recognizer are located. The URI must be in the same Region as the
3851
3922
  # API endpoint that you are calling.
3852
3923
  # @return [String]
3853
3924
  #
3854
3925
  # @!attribute [rw] test_s3_uri
3855
3926
  # 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
3927
+ # entity recognizer are located. The URI must be in the same Region as
3857
3928
  # the API endpoint that you are calling.
3858
3929
  # @return [String]
3859
3930
  #
@@ -3870,14 +3941,14 @@ module Aws::Comprehend
3870
3941
  #
3871
3942
  # @!attribute [rw] s3_uri
3872
3943
  # 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
3944
+ # entity recognizer are located. The URI must be in the same Region as
3874
3945
  # the API endpoint that you are calling.
3875
3946
  # @return [String]
3876
3947
  #
3877
3948
  # @!attribute [rw] test_s3_uri
3878
3949
  # 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.
3950
+ # entity recognizer are located. The URI must be in the same Amazon
3951
+ # Web Services Region as the API endpoint that you are calling.
3881
3952
  # @return [String]
3882
3953
  #
3883
3954
  # @!attribute [rw] input_format
@@ -3904,7 +3975,7 @@ module Aws::Comprehend
3904
3975
  #
3905
3976
  # @!attribute [rw] s3_uri
3906
3977
  # 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
3978
+ # The URI must be in the same Region as the API endpoint that you are
3908
3979
  # calling.
3909
3980
  # @return [String]
3910
3981
  #
@@ -3991,7 +4062,7 @@ module Aws::Comprehend
3991
4062
  # @!attribute [rw] data_format
3992
4063
  # The format of your training data:
3993
4064
  #
3994
- # * `COMPREHEND_CSV`\: A CSV file that supplements your training
4065
+ # * `COMPREHEND_CSV`: A CSV file that supplements your training
3995
4066
  # documents. The CSV file contains information about the custom
3996
4067
  # entities that your trained model will detect. The required format
3997
4068
  # of the file depends on whether you are providing annotations or an
@@ -4002,11 +4073,11 @@ module Aws::Comprehend
4002
4073
  # provide your training documents by using the `Documents`
4003
4074
  # parameter.
4004
4075
  #
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.
4076
+ # * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
4077
+ # SageMaker Ground Truth. This file is in JSON lines format. Each
4078
+ # line is a complete JSON object that contains a training document
4079
+ # and its labels. Each label annotates a named entity in the
4080
+ # training document.
4010
4081
  #
4011
4082
  # If you use this value, you must provide the `AugmentedManifests`
4012
4083
  # parameter in your request.
@@ -4188,16 +4259,15 @@ module Aws::Comprehend
4188
4259
  # @return [Types::EntityRecognizerMetadata]
4189
4260
  #
4190
4261
  # @!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.
4262
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4263
+ # Comprehend read access to your input data.
4194
4264
  # @return [String]
4195
4265
  #
4196
4266
  # @!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:
4267
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4268
+ # Amazon Comprehend uses to encrypt data on the storage volume
4269
+ # attached to the ML compute instance(s) that process the analysis
4270
+ # job. The VolumeKmsKeyId can be either of the following formats:
4201
4271
  #
4202
4272
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4203
4273
  #
@@ -4216,9 +4286,9 @@ module Aws::Comprehend
4216
4286
  # @return [Types::VpcConfig]
4217
4287
  #
4218
4288
  # @!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:
4289
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
4290
+ # custom models. The ModelKmsKeyId can be either of the following
4291
+ # formats:
4222
4292
  #
4223
4293
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4224
4294
  #
@@ -4232,8 +4302,8 @@ module Aws::Comprehend
4232
4302
  #
4233
4303
  # @!attribute [rw] source_model_arn
4234
4304
  # 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.
4305
+ # imported from a different Amazon Web Services account to create the
4306
+ # entity recognizer model in your Amazon Web Services account.
4237
4307
  # @return [String]
4238
4308
  #
4239
4309
  # @!attribute [rw] flywheel_arn
@@ -4452,9 +4522,9 @@ module Aws::Comprehend
4452
4522
  #
4453
4523
  # @!attribute [rw] job_arn
4454
4524
  # 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:
4525
+ # unique, fully qualified identifier for the job. It includes the
4526
+ # Amazon Web Services account, Amazon Web Services Region, and the job
4527
+ # ID. The format of the ARN is as follows:
4458
4528
  #
4459
4529
  # `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
4460
4530
  #
@@ -4498,9 +4568,8 @@ module Aws::Comprehend
4498
4568
  # @return [String]
4499
4569
  #
4500
4570
  # @!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.
4571
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4572
+ # Comprehend read access to your input data.
4504
4573
  # @return [String]
4505
4574
  #
4506
4575
  # @!attribute [rw] target_event_types
@@ -4695,9 +4764,8 @@ module Aws::Comprehend
4695
4764
  # @return [String]
4696
4765
  #
4697
4766
  # @!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.
4767
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4768
+ # Comprehend permission to access the flywheel data.
4701
4769
  # @return [String]
4702
4770
  #
4703
4771
  # @!attribute [rw] task_config
@@ -4852,13 +4920,13 @@ module Aws::Comprehend
4852
4920
  # import. Version names can have a maximum of 256 characters.
4853
4921
  # Alphanumeric characters, hyphens (-) and underscores (\_) are
4854
4922
  # allowed. The version name must be unique among all models with the
4855
- # same classifier name in the account/AWS Region.
4923
+ # same classifier name in the account/Region.
4856
4924
  # @return [String]
4857
4925
  #
4858
4926
  # @!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:
4927
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
4928
+ # custom models. The ModelKmsKeyId can be either of the following
4929
+ # formats:
4862
4930
  #
4863
4931
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4864
4932
  #
@@ -4867,10 +4935,9 @@ module Aws::Comprehend
4867
4935
  # @return [String]
4868
4936
  #
4869
4937
  # @!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.
4938
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4939
+ # Comprehend permission to use Amazon Key Management Service (KMS) to
4940
+ # encrypt or decrypt the custom model.
4874
4941
  # @return [String]
4875
4942
  #
4876
4943
  # @!attribute [rw] tags
@@ -4910,7 +4977,7 @@ module Aws::Comprehend
4910
4977
  # field applies only to non-text inputs for custom analysis.
4911
4978
  #
4912
4979
  # @!attribute [rw] s3_uri
4913
- # The Amazon S3 URI for the input data. The URI must be in same region
4980
+ # The Amazon S3 URI for the input data. The URI must be in same Region
4914
4981
  # as the API endpoint that you are calling. The URI can point to a
4915
4982
  # single input file or it can provide the prefix for a collection of
4916
4983
  # data files.
@@ -5128,8 +5195,8 @@ module Aws::Comprehend
5128
5195
  # @!attribute [rw] job_arn
5129
5196
  # The Amazon Resource Name (ARN) of the key phrases detection job. It
5130
5197
  # 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:
5198
+ # Amazon Web Services account, Amazon Web Services Region, and the job
5199
+ # ID. The format of the ARN is as follows:
5133
5200
  #
5134
5201
  # `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
5135
5202
  #
@@ -5175,16 +5242,15 @@ module Aws::Comprehend
5175
5242
  # @return [String]
5176
5243
  #
5177
5244
  # @!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.
5245
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
5246
+ # Comprehend read access to your input data.
5181
5247
  # @return [String]
5182
5248
  #
5183
5249
  # @!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:
5250
+ # ID for the KMS key that Amazon Comprehend uses to encrypt data on
5251
+ # the storage volume attached to the ML compute instance(s) that
5252
+ # process the analysis job. The VolumeKmsKeyId can be either of the
5253
+ # following formats:
5188
5254
  #
5189
5255
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
5190
5256
  #
@@ -6009,7 +6075,7 @@ module Aws::Comprehend
6009
6075
  # @!attribute [rw] s3_uri
6010
6076
  # When you use the `OutputDataConfig` object with asynchronous
6011
6077
  # 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
6078
+ # write the output data. The URI must be in the same Region as the API
6013
6079
  # endpoint that you are calling. The location is used as the prefix
6014
6080
  # for the actual location of the output file.
6015
6081
  #
@@ -6024,9 +6090,9 @@ module Aws::Comprehend
6024
6090
  # @return [String]
6025
6091
  #
6026
6092
  # @!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:
6093
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6094
+ # Amazon Comprehend uses to encrypt the output results from an
6095
+ # analysis job. The KmsKeyId can be one of the following formats:
6030
6096
  #
6031
6097
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6032
6098
  #
@@ -6122,8 +6188,8 @@ module Aws::Comprehend
6122
6188
  # @!attribute [rw] job_arn
6123
6189
  # The Amazon Resource Name (ARN) of the PII entities detection job. It
6124
6190
  # 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:
6191
+ # Amazon Web Services account, Amazon Web Services Region, and the job
6192
+ # ID. The format of the ARN is as follows:
6127
6193
  #
6128
6194
  # `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
6129
6195
  #
@@ -6176,9 +6242,8 @@ module Aws::Comprehend
6176
6242
  # @return [String]
6177
6243
  #
6178
6244
  # @!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.
6245
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6246
+ # Comprehend read access to your input data.
6182
6247
  # @return [String]
6183
6248
  #
6184
6249
  # @!attribute [rw] mode
@@ -6252,8 +6317,9 @@ module Aws::Comprehend
6252
6317
  # @return [String]
6253
6318
  #
6254
6319
  # @!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.
6320
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6321
+ # Amazon Comprehend uses to encrypt the output results from an
6322
+ # analysis job.
6257
6323
  # @return [String]
6258
6324
  #
6259
6325
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
@@ -6490,8 +6556,8 @@ module Aws::Comprehend
6490
6556
  # @!attribute [rw] job_arn
6491
6557
  # The Amazon Resource Name (ARN) of the sentiment detection job. It is
6492
6558
  # 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:
6559
+ # Amazon Web Services account, Amazon Web Services Region, and the job
6560
+ # ID. The format of the ARN is as follows:
6495
6561
  #
6496
6562
  # `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
6497
6563
  #
@@ -6537,16 +6603,15 @@ module Aws::Comprehend
6537
6603
  # @return [String]
6538
6604
  #
6539
6605
  # @!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.
6606
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6607
+ # Comprehend read access to your input data.
6543
6608
  # @return [String]
6544
6609
  #
6545
6610
  # @!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:
6611
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6612
+ # Amazon Comprehend uses to encrypt data on the storage volume
6613
+ # attached to the ML compute instance(s) that process the analysis
6614
+ # job. The VolumeKmsKeyId can be either of the following formats:
6550
6615
  #
6551
6616
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6552
6617
  #
@@ -6636,9 +6701,8 @@ module Aws::Comprehend
6636
6701
  # @return [Types::OutputDataConfig]
6637
6702
  #
6638
6703
  # @!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.
6704
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6705
+ # Comprehend read access to your input data.
6642
6706
  # @return [String]
6643
6707
  #
6644
6708
  # @!attribute [rw] client_request_token
@@ -6650,10 +6714,10 @@ module Aws::Comprehend
6650
6714
  # @return [String]
6651
6715
  #
6652
6716
  # @!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:
6717
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6718
+ # Amazon Comprehend uses to encrypt data on the storage volume
6719
+ # attached to the ML compute instance(s) that process the analysis
6720
+ # job. The VolumeKmsKeyId can be either of the following formats:
6657
6721
  #
6658
6722
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6659
6723
  #
@@ -6709,8 +6773,8 @@ module Aws::Comprehend
6709
6773
  # @!attribute [rw] job_arn
6710
6774
  # The Amazon Resource Name (ARN) of the document classification job.
6711
6775
  # 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:
6776
+ # the Amazon Web Services account, Amazon Web Services Region, and the
6777
+ # job ID. The format of the ARN is as follows:
6714
6778
  #
6715
6779
  # `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
6716
6780
  #
@@ -6762,14 +6826,13 @@ module Aws::Comprehend
6762
6826
  # @return [Types::OutputDataConfig]
6763
6827
  #
6764
6828
  # @!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].
6829
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6830
+ # Comprehend read access to your input data. For more information, see
6831
+ # [Role-based permissions][1].
6769
6832
  #
6770
6833
  #
6771
6834
  #
6772
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6835
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
6773
6836
  # @return [String]
6774
6837
  #
6775
6838
  # @!attribute [rw] job_name
@@ -6785,10 +6848,10 @@ module Aws::Comprehend
6785
6848
  # @return [String]
6786
6849
  #
6787
6850
  # @!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:
6851
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6852
+ # Amazon Comprehend uses to encrypt data on the storage volume
6853
+ # attached to the ML compute instance(s) that process the analysis
6854
+ # job. The VolumeKmsKeyId can be either of the following formats:
6792
6855
  #
6793
6856
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6794
6857
  #
@@ -6836,8 +6899,8 @@ module Aws::Comprehend
6836
6899
  # @!attribute [rw] job_arn
6837
6900
  # The Amazon Resource Name (ARN) of the dominant language detection
6838
6901
  # 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:
6902
+ # includes the Amazon Web Services account, Amazon Web Services
6903
+ # Region, and the job ID. The format of the ARN is as follows:
6841
6904
  #
6842
6905
  # `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
6843
6906
  #
@@ -6880,14 +6943,13 @@ module Aws::Comprehend
6880
6943
  # @return [Types::OutputDataConfig]
6881
6944
  #
6882
6945
  # @!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].
6946
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
6947
+ # Comprehend read access to your input data. For more information, see
6948
+ # [Role-based permissions][1].
6887
6949
  #
6888
6950
  #
6889
6951
  #
6890
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
6952
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
6891
6953
  # @return [String]
6892
6954
  #
6893
6955
  # @!attribute [rw] job_name
@@ -6917,10 +6979,10 @@ module Aws::Comprehend
6917
6979
  # @return [String]
6918
6980
  #
6919
6981
  # @!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:
6982
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
6983
+ # Amazon Comprehend uses to encrypt data on the storage volume
6984
+ # attached to the ML compute instance(s) that process the analysis
6985
+ # job. The VolumeKmsKeyId can be either of the following formats:
6924
6986
  #
6925
6987
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
6926
6988
  #
@@ -6976,8 +7038,8 @@ module Aws::Comprehend
6976
7038
  # @!attribute [rw] job_arn
6977
7039
  # The Amazon Resource Name (ARN) of the entities detection job. It is
6978
7040
  # 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:
7041
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7042
+ # ID. The format of the ARN is as follows:
6981
7043
  #
6982
7044
  # `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
6983
7045
  #
@@ -7030,9 +7092,8 @@ module Aws::Comprehend
7030
7092
  # @return [Types::OutputDataConfig]
7031
7093
  #
7032
7094
  # @!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.
7095
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7096
+ # Comprehend read access to your input data.
7036
7097
  # @return [String]
7037
7098
  #
7038
7099
  # @!attribute [rw] job_name
@@ -7084,9 +7145,9 @@ module Aws::Comprehend
7084
7145
  #
7085
7146
  # @!attribute [rw] job_arn
7086
7147
  # 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:
7148
+ # unique, fully qualified identifier for the job. It includes the
7149
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7150
+ # ID. The format of the ARN is as follows:
7090
7151
  #
7091
7152
  # `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
7092
7153
  #
@@ -7151,14 +7212,13 @@ module Aws::Comprehend
7151
7212
  # @return [Types::OutputDataConfig]
7152
7213
  #
7153
7214
  # @!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].
7215
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7216
+ # Comprehend read access to your input data. For more information, see
7217
+ # [Role-based permissions][1].
7158
7218
  #
7159
7219
  #
7160
7220
  #
7161
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7221
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7162
7222
  # @return [String]
7163
7223
  #
7164
7224
  # @!attribute [rw] job_name
@@ -7180,10 +7240,10 @@ module Aws::Comprehend
7180
7240
  # @return [String]
7181
7241
  #
7182
7242
  # @!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:
7243
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7244
+ # Amazon Comprehend uses to encrypt data on the storage volume
7245
+ # attached to the ML compute instance(s) that process the analysis
7246
+ # job. The VolumeKmsKeyId can be either of the following formats:
7187
7247
  #
7188
7248
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7189
7249
  #
@@ -7232,8 +7292,8 @@ module Aws::Comprehend
7232
7292
  # @!attribute [rw] job_arn
7233
7293
  # The Amazon Resource Name (ARN) of the key phrase detection job. It
7234
7294
  # 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:
7295
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7296
+ # ID. The format of the ARN is as follows:
7237
7297
  #
7238
7298
  # `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
7239
7299
  #
@@ -7290,9 +7350,8 @@ module Aws::Comprehend
7290
7350
  # @return [Types::RedactionConfig]
7291
7351
  #
7292
7352
  # @!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.
7353
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7354
+ # Comprehend read access to your input data.
7296
7355
  # @return [String]
7297
7356
  #
7298
7357
  # @!attribute [rw] job_name
@@ -7342,8 +7401,8 @@ module Aws::Comprehend
7342
7401
  # @!attribute [rw] job_arn
7343
7402
  # The Amazon Resource Name (ARN) of the PII entity detection job. It
7344
7403
  # 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:
7404
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7405
+ # ID. The format of the ARN is as follows:
7347
7406
  #
7348
7407
  # `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
7349
7408
  #
@@ -7375,14 +7434,13 @@ module Aws::Comprehend
7375
7434
  # @return [Types::OutputDataConfig]
7376
7435
  #
7377
7436
  # @!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].
7437
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7438
+ # Comprehend read access to your input data. For more information, see
7439
+ # [Role-based permissions][1].
7382
7440
  #
7383
7441
  #
7384
7442
  #
7385
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7443
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7386
7444
  # @return [String]
7387
7445
  #
7388
7446
  # @!attribute [rw] job_name
@@ -7404,10 +7462,10 @@ module Aws::Comprehend
7404
7462
  # @return [String]
7405
7463
  #
7406
7464
  # @!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:
7465
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7466
+ # Amazon Comprehend uses to encrypt data on the storage volume
7467
+ # attached to the ML compute instance(s) that process the analysis
7468
+ # job. The VolumeKmsKeyId can be either of the following formats:
7411
7469
  #
7412
7470
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7413
7471
  #
@@ -7456,8 +7514,8 @@ module Aws::Comprehend
7456
7514
  # @!attribute [rw] job_arn
7457
7515
  # The Amazon Resource Name (ARN) of the sentiment detection job. It is
7458
7516
  # 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:
7517
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7518
+ # ID. The format of the ARN is as follows:
7461
7519
  #
7462
7520
  # `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
7463
7521
  #
@@ -7501,10 +7559,9 @@ module Aws::Comprehend
7501
7559
  # @return [Types::OutputDataConfig]
7502
7560
  #
7503
7561
  # @!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].
7562
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7563
+ # Comprehend read access to your input data. For more information, see
7564
+ # [Role-based permissions][1].
7508
7565
  #
7509
7566
  #
7510
7567
  #
@@ -7582,8 +7639,8 @@ module Aws::Comprehend
7582
7639
  # @!attribute [rw] job_arn
7583
7640
  # The Amazon Resource Name (ARN) of the targeted sentiment detection
7584
7641
  # 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:
7642
+ # includes the Amazon Web Services account, Amazon Web Services
7643
+ # Region, and the job ID. The format of the ARN is as follows:
7587
7644
  #
7588
7645
  # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
7589
7646
  #
@@ -7629,14 +7686,13 @@ module Aws::Comprehend
7629
7686
  # @return [Types::OutputDataConfig]
7630
7687
  #
7631
7688
  # @!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].
7689
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
7690
+ # Comprehend read access to your input data. For more information, see
7691
+ # [Role-based permissions][1].
7636
7692
  #
7637
7693
  #
7638
7694
  #
7639
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
7695
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
7640
7696
  # @return [String]
7641
7697
  #
7642
7698
  # @!attribute [rw] job_name
@@ -7656,10 +7712,10 @@ module Aws::Comprehend
7656
7712
  # @return [String]
7657
7713
  #
7658
7714
  # @!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:
7715
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
7716
+ # Amazon Comprehend uses to encrypt data on the storage volume
7717
+ # attached to the ML compute instance(s) that process the analysis
7718
+ # job. The VolumeKmsKeyId can be either of the following formats:
7663
7719
  #
7664
7720
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7665
7721
  #
@@ -7707,9 +7763,9 @@ module Aws::Comprehend
7707
7763
  #
7708
7764
  # @!attribute [rw] job_arn
7709
7765
  # 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:
7766
+ # unique, fully qualified identifier for the job. It includes the
7767
+ # Amazon Web Services account, Amazon Web Services Region, and the job
7768
+ # ID. The format of the ARN is as follows:
7713
7769
  #
7714
7770
  # `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
7715
7771
  #
@@ -8136,8 +8192,8 @@ module Aws::Comprehend
8136
8192
  # @!attribute [rw] job_arn
8137
8193
  # The Amazon Resource Name (ARN) of the targeted sentiment detection
8138
8194
  # 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:
8195
+ # includes the Amazon Web Services account, Amazon Web Services
8196
+ # Region, and the job ID. The format of the ARN is as follows:
8141
8197
  #
8142
8198
  # `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
8143
8199
  #
@@ -8183,9 +8239,8 @@ module Aws::Comprehend
8183
8239
  # @return [String]
8184
8240
  #
8185
8241
  # @!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.
8242
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8243
+ # Comprehend read access to your input data.
8189
8244
  # @return [String]
8190
8245
  #
8191
8246
  # @!attribute [rw] volume_kms_key_id
@@ -8448,9 +8503,9 @@ module Aws::Comprehend
8448
8503
  #
8449
8504
  # @!attribute [rw] job_arn
8450
8505
  # 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:
8506
+ # unique, fully qualified identifier for the job. It includes the
8507
+ # Amazon Web Services account, Amazon Web Services Region, and the job
8508
+ # ID. The format of the ARN is as follows:
8454
8509
  #
8455
8510
  # `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
8456
8511
  #
@@ -8497,16 +8552,15 @@ module Aws::Comprehend
8497
8552
  # @return [Integer]
8498
8553
  #
8499
8554
  # @!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.
8555
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8556
+ # Comprehend read access to your job data.
8503
8557
  # @return [String]
8504
8558
  #
8505
8559
  # @!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:
8560
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
8561
+ # Amazon Comprehend uses to encrypt data on the storage volume
8562
+ # attached to the ML compute instance(s) that process the analysis
8563
+ # job. The VolumeKmsKeyId can be either of the following formats:
8510
8564
  #
8511
8565
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
8512
8566
  #
@@ -8593,9 +8647,9 @@ module Aws::Comprehend
8593
8647
  # Data security configuration.
8594
8648
  #
8595
8649
  # @!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:
8650
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
8651
+ # custom models. The ModelKmsKeyId can be either of the following
8652
+ # formats:
8599
8653
  #
8600
8654
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
8601
8655
  #
@@ -8684,9 +8738,8 @@ module Aws::Comprehend
8684
8738
  # @return [String]
8685
8739
  #
8686
8740
  # @!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.
8741
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
8742
+ # Comprehend permission to access the flywheel data.
8690
8743
  # @return [String]
8691
8744
  #
8692
8745
  # @!attribute [rw] data_security_config
@@ -8741,7 +8794,7 @@ module Aws::Comprehend
8741
8794
  # @!attribute [rw] subnets
8742
8795
  # The ID for each subnet being used in your private VPC. This subnet
8743
8796
  # 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
8797
+ # specific to a given availability zone in the VPC’s Region. This ID
8745
8798
  # number is preceded by "subnet-", for instance:
8746
8799
  # "subnet-04ccf456919e69055". For more information, see [VPCs and
8747
8800
  # Subnets][1].
@@ -8760,5 +8813,36 @@ module Aws::Comprehend
8760
8813
  include Aws::Structure
8761
8814
  end
8762
8815
 
8816
+ # The system identified one of the following warnings while processing
8817
+ # the input document:
8818
+ #
8819
+ # * The document to classify is plain text, but the classifier is a
8820
+ # native model.
8821
+ #
8822
+ # * The document to classify is semi-structured, but the classifier is a
8823
+ # plain-text model.
8824
+ #
8825
+ # @!attribute [rw] page
8826
+ # Page number in the input document.
8827
+ # @return [Integer]
8828
+ #
8829
+ # @!attribute [rw] warn_code
8830
+ # The type of warning.
8831
+ # @return [String]
8832
+ #
8833
+ # @!attribute [rw] warn_message
8834
+ # Text message associated with the warning.
8835
+ # @return [String]
8836
+ #
8837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/WarningsListItem AWS API Documentation
8838
+ #
8839
+ class WarningsListItem < Struct.new(
8840
+ :page,
8841
+ :warn_code,
8842
+ :warn_message)
8843
+ SENSITIVE = []
8844
+ include Aws::Structure
8845
+ end
8846
+
8763
8847
  end
8764
8848
  end