aws-sdk-comprehend 1.66.0 → 1.68.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -542,12 +542,6 @@ module Aws::Comprehend
542
542
  # list can contain a maximum of 25 documents. The maximum size of each
543
543
  # document is 5 KB.
544
544
  #
545
- # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
546
- # 500 characters of the input text and ignores any additional text in
547
- # the input.
548
- #
549
- # </note>
550
- #
551
545
  # @option params [required, String] :language_code
552
546
  # The language of the input documents. You can specify any of the
553
547
  # primary languages supported by Amazon Comprehend. All documents must
@@ -771,6 +765,7 @@ module Aws::Comprehend
771
765
  # * {Types::ClassifyDocumentResponse#document_metadata #document_metadata} => Types::DocumentMetadata
772
766
  # * {Types::ClassifyDocumentResponse#document_type #document_type} => Array&lt;Types::DocumentTypeListItem&gt;
773
767
  # * {Types::ClassifyDocumentResponse#errors #errors} => Array&lt;Types::ErrorsListItem&gt;
768
+ # * {Types::ClassifyDocumentResponse#warnings #warnings} => Array&lt;Types::WarningsListItem&gt;
774
769
  #
775
770
  # @example Request syntax with placeholder values
776
771
  #
@@ -806,6 +801,10 @@ module Aws::Comprehend
806
801
  # resp.errors[0].page #=> Integer
807
802
  # resp.errors[0].error_code #=> String, one of "TEXTRACT_BAD_PAGE", "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED", "PAGE_CHARACTERS_EXCEEDED", "PAGE_SIZE_EXCEEDED", "INTERNAL_SERVER_ERROR"
808
803
  # resp.errors[0].error_message #=> String
804
+ # resp.warnings #=> Array
805
+ # resp.warnings[0].page #=> Integer
806
+ # resp.warnings[0].warn_code #=> String, one of "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL", "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL"
807
+ # resp.warnings[0].warn_message #=> String
809
808
  #
810
809
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument AWS API Documentation
811
810
  #
@@ -953,14 +952,13 @@ module Aws::Comprehend
953
952
 
954
953
  # Creates a new document classifier that you can use to categorize
955
954
  # documents. To create a classifier, you provide a set of training
956
- # documents that labeled with the categories that you want to use. After
957
- # the classifier is trained you can use it to categorize a set of
958
- # labeled documents into the categories. For more information, see
959
- # [Document Classification][1] in the Comprehend Developer Guide.
955
+ # documents that are labeled with the categories that you want to use.
956
+ # For more information, see [Training classifier models][1] in the
957
+ # Comprehend Developer Guide.
960
958
  #
961
959
  #
962
960
  #
963
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html
961
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html
964
962
  #
965
963
  # @option params [required, String] :document_classifier_name
966
964
  # The name of the document classifier.
@@ -969,13 +967,12 @@ module Aws::Comprehend
969
967
  # The version name given to the newly created classifier. Version names
970
968
  # can have a maximum of 256 characters. Alphanumeric characters, hyphens
971
969
  # (-) and underscores (\_) are allowed. The version name must be unique
972
- # among all models with the same classifier name in the account/AWS
973
- # Region.
970
+ # among all models with the same classifier name in the Amazon Web
971
+ # Services account/Amazon Web Services Region.
974
972
  #
975
973
  # @option params [required, String] :data_access_role_arn
976
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
977
- # Management (IAM) role that grants Amazon Comprehend read access to
978
- # your input data.
974
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
975
+ # Comprehend read access to your input data.
979
976
  #
980
977
  # @option params [Array<Types::Tag>] :tags
981
978
  # Tags to associate with the document classifier. A tag is a key-value
@@ -987,8 +984,9 @@ module Aws::Comprehend
987
984
  # Specifies the format and location of the input data for the job.
988
985
  #
989
986
  # @option params [Types::DocumentClassifierOutputDataConfig] :output_data_config
990
- # Enables the addition of output results configuration parameters for
991
- # custom classifier jobs.
987
+ # Specifies the location for the output files from a custom classifier
988
+ # job. This parameter is required for a request that creates a native
989
+ # classifier model.
992
990
  #
993
991
  # @option params [String] :client_request_token
994
992
  # A unique identifier for the request. If you don't set the client
@@ -1003,10 +1001,10 @@ module Aws::Comprehend
1003
1001
  # same language.
1004
1002
  #
1005
1003
  # @option params [String] :volume_kms_key_id
1006
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
1007
- # uses to encrypt data on the storage volume attached to the ML compute
1008
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
1009
- # either of the following formats:
1004
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
1005
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
1006
+ # to the ML compute instance(s) that process the analysis job. The
1007
+ # VolumeKmsKeyId can be either of the following formats:
1010
1008
  #
1011
1009
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1012
1010
  #
@@ -1031,9 +1029,9 @@ module Aws::Comprehend
1031
1029
  # delimiter. The default delimiter between labels is a pipe (\|).
1032
1030
  #
1033
1031
  # @option params [String] :model_kms_key_id
1034
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
1035
- # uses to encrypt trained custom models. The ModelKmsKeyId can be either
1036
- # of the following formats:
1032
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1033
+ # custom models. The ModelKmsKeyId can be either of the following
1034
+ # formats:
1037
1035
  #
1038
1036
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1039
1037
  #
@@ -1042,8 +1040,8 @@ module Aws::Comprehend
1042
1040
  #
1043
1041
  # @option params [String] :model_policy
1044
1042
  # The resource-based policy to attach to your custom document classifier
1045
- # model. You can use this policy to allow another AWS account to import
1046
- # your custom model.
1043
+ # model. You can use this policy to allow another Amazon Web Services
1044
+ # account to import your custom model.
1047
1045
  #
1048
1046
  # Provide your policy as a JSON body that you enter as a UTF-8 encoded
1049
1047
  # string without line breaks. To provide valid JSON, enclose the
@@ -1089,6 +1087,16 @@ module Aws::Comprehend
1089
1087
  # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
1090
1088
  # },
1091
1089
  # ],
1090
+ # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
1091
+ # documents: {
1092
+ # s3_uri: "S3Uri", # required
1093
+ # test_s3_uri: "S3Uri",
1094
+ # },
1095
+ # document_reader_config: {
1096
+ # document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
1097
+ # document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
1098
+ # feature_types: ["TABLES"], # accepts TABLES, FORMS
1099
+ # },
1092
1100
  # },
1093
1101
  # output_data_config: {
1094
1102
  # s3_uri: "S3Uri",
@@ -1156,10 +1164,9 @@ module Aws::Comprehend
1156
1164
  # department.
1157
1165
  #
1158
1166
  # @option params [String] :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).
1167
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1168
+ # Comprehend read access to trained custom models encrypted with a
1169
+ # customer managed key (ModelKmsKeyId).
1163
1170
  #
1164
1171
  # @option params [String] :flywheel_arn
1165
1172
  # The Amazon Resource Number (ARN) of the flywheel to which the endpoint
@@ -1209,19 +1216,17 @@ module Aws::Comprehend
1209
1216
  # The name given to the newly created recognizer. Recognizer names can
1210
1217
  # be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
1211
1218
  # and underscores (\_) are allowed. The name must be unique in the
1212
- # account/region.
1219
+ # account/Region.
1213
1220
  #
1214
1221
  # @option params [String] :version_name
1215
1222
  # The version name given to the newly created recognizer. Version names
1216
1223
  # can be a maximum of 256 characters. Alphanumeric characters, hyphens
1217
1224
  # (-) and underscores (\_) are allowed. The version name must be unique
1218
- # among all models with the same recognizer name in the account/ AWS
1219
- # Region.
1225
+ # among all models with the same recognizer name in the account/Region.
1220
1226
  #
1221
1227
  # @option params [required, String] :data_access_role_arn
1222
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
1223
- # Management (IAM) role that grants Amazon Comprehend read access to
1224
- # your input data.
1228
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1229
+ # Comprehend read access to your input data.
1225
1230
  #
1226
1231
  # @option params [Array<Types::Tag>] :tags
1227
1232
  # Tags to associate with the entity recognizer. A tag is a key-value
@@ -1231,7 +1236,7 @@ module Aws::Comprehend
1231
1236
  #
1232
1237
  # @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
1233
1238
  # Specifies the format and location of the input data. The S3 bucket
1234
- # containing the input data must be located in the same region as the
1239
+ # containing the input data must be located in the same Region as the
1235
1240
  # entity recognizer being created.
1236
1241
  #
1237
1242
  # @option params [String] :client_request_token
@@ -1249,10 +1254,10 @@ module Aws::Comprehend
1249
1254
  # language. All training documents must be in the same language.
1250
1255
  #
1251
1256
  # @option params [String] :volume_kms_key_id
1252
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
1253
- # uses to encrypt data on the storage volume attached to the ML compute
1254
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
1255
- # 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 attached
1259
+ # to the ML compute instance(s) that process the analysis job. The
1260
+ # VolumeKmsKeyId can be either of the following formats:
1256
1261
  #
1257
1262
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1258
1263
  #
@@ -1269,9 +1274,9 @@ module Aws::Comprehend
1269
1274
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
1270
1275
  #
1271
1276
  # @option params [String] :model_kms_key_id
1272
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
1273
- # uses to encrypt trained custom models. The ModelKmsKeyId can be either
1274
- # of the following formats:
1277
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
1278
+ # custom models. The ModelKmsKeyId can be either of the following
1279
+ # formats:
1275
1280
  #
1276
1281
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1277
1282
  #
@@ -1280,8 +1285,8 @@ module Aws::Comprehend
1280
1285
  #
1281
1286
  # @option params [String] :model_policy
1282
1287
  # The JSON resource-based policy to attach to your custom entity
1283
- # recognizer model. You can use this policy to allow another AWS account
1284
- # to import your custom model.
1288
+ # recognizer model. You can use this policy to allow another Amazon Web
1289
+ # Services account to import your custom model.
1285
1290
  #
1286
1291
  # Provide your JSON as a UTF-8 encoded string without line breaks. To
1287
1292
  # provide valid JSON for your policy, enclose the attribute names and
@@ -1366,10 +1371,10 @@ module Aws::Comprehend
1366
1371
  req.send_request(options)
1367
1372
  end
1368
1373
 
1369
- # A flywheel is an AWS resource that orchestrates the ongoing training
1370
- # of a model for custom classification or custom entity recognition. You
1371
- # can create a flywheel to start with an existing trained model, or
1372
- # Comprehend can create and train a new model.
1374
+ # A flywheel is an Amazon Web Services resource that orchestrates the
1375
+ # ongoing training of a model for custom classification or custom entity
1376
+ # recognition. You can create a flywheel to start with an existing
1377
+ # trained model, or Comprehend can create and train a new model.
1373
1378
  #
1374
1379
  # When you create the flywheel, Comprehend creates a data lake in your
1375
1380
  # account. The data lake holds the training data and test data for all
@@ -1398,9 +1403,9 @@ module Aws::Comprehend
1398
1403
  # Resource Number (ARN) of the model version.
1399
1404
  #
1400
1405
  # @option params [required, String] :data_access_role_arn
1401
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
1402
- # Management (IAM) role that grants Amazon Comprehend the permissions
1403
- # required to access the flywheel data in the data lake.
1406
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
1407
+ # Comprehend the permissions required to access the flywheel data in the
1408
+ # data lake.
1404
1409
  #
1405
1410
  # @option params [Types::TaskConfig] :task_config
1406
1411
  # Configuration about the custom classifier associated with the
@@ -1752,7 +1757,7 @@ module Aws::Comprehend
1752
1757
  #
1753
1758
  # resp.document_classifier_properties.document_classifier_arn #=> String
1754
1759
  # resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
1755
- # resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
1760
+ # resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
1756
1761
  # resp.document_classifier_properties.message #=> String
1757
1762
  # resp.document_classifier_properties.submit_time #=> Time
1758
1763
  # resp.document_classifier_properties.end_time #=> Time
@@ -1770,6 +1775,13 @@ module Aws::Comprehend
1770
1775
  # resp.document_classifier_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
1771
1776
  # resp.document_classifier_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
1772
1777
  # resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
1778
+ # resp.document_classifier_properties.input_data_config.document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
1779
+ # resp.document_classifier_properties.input_data_config.documents.s3_uri #=> String
1780
+ # resp.document_classifier_properties.input_data_config.documents.test_s3_uri #=> String
1781
+ # resp.document_classifier_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
1782
+ # resp.document_classifier_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
1783
+ # resp.document_classifier_properties.input_data_config.document_reader_config.feature_types #=> Array
1784
+ # resp.document_classifier_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
1773
1785
  # resp.document_classifier_properties.output_data_config.s3_uri #=> String
1774
1786
  # resp.document_classifier_properties.output_data_config.kms_key_id #=> String
1775
1787
  # resp.document_classifier_properties.output_data_config.flywheel_stats_s3_prefix #=> String
@@ -1944,6 +1956,7 @@ module Aws::Comprehend
1944
1956
  # resp.entities_detection_job_properties.vpc_config.security_group_ids[0] #=> String
1945
1957
  # resp.entities_detection_job_properties.vpc_config.subnets #=> Array
1946
1958
  # resp.entities_detection_job_properties.vpc_config.subnets[0] #=> String
1959
+ # resp.entities_detection_job_properties.flywheel_arn #=> String
1947
1960
  #
1948
1961
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob AWS API Documentation
1949
1962
  #
@@ -1975,7 +1988,7 @@ module Aws::Comprehend
1975
1988
  #
1976
1989
  # resp.entity_recognizer_properties.entity_recognizer_arn #=> String
1977
1990
  # resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
1978
- # resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
1991
+ # resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
1979
1992
  # resp.entity_recognizer_properties.message #=> String
1980
1993
  # resp.entity_recognizer_properties.submit_time #=> Time
1981
1994
  # resp.entity_recognizer_properties.end_time #=> Time
@@ -2757,12 +2770,6 @@ module Aws::Comprehend
2757
2770
  # @option params [required, String] :text
2758
2771
  # A UTF-8 text string. The maximum string size is 5 KB.
2759
2772
  #
2760
- # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
2761
- # 500 characters of the input text and ignores any additional text in
2762
- # the input.
2763
- #
2764
- # </note>
2765
- #
2766
2773
  # @option params [required, String] :language_code
2767
2774
  # The language of the input documents. You can specify any of the
2768
2775
  # primary languages supported by Amazon Comprehend. All documents must
@@ -2900,15 +2907,15 @@ module Aws::Comprehend
2900
2907
  end
2901
2908
 
2902
2909
  # Creates a new custom model that replicates a source custom model that
2903
- # you import. The source model can be in your AWS account or another
2904
- # one.
2910
+ # you import. The source model can be in your Amazon Web Services
2911
+ # account or another one.
2905
2912
  #
2906
- # If the source model is in another AWS account, then it must have a
2907
- # resource-based policy that authorizes you to import it.
2913
+ # If the source model is in another Amazon Web Services account, then it
2914
+ # must have a resource-based policy that authorizes you to import it.
2908
2915
  #
2909
- # The source model must be in the same AWS region that you're using
2910
- # when you import. You can't import a model that's in a different
2911
- # region.
2916
+ # The source model must be in the same Amazon Web Services Region that
2917
+ # you're using when you import. You can't import a model that's in a
2918
+ # different Region.
2912
2919
  #
2913
2920
  # @option params [required, String] :source_model_arn
2914
2921
  # The Amazon Resource Name (ARN) of the custom model to import.
@@ -2922,12 +2929,12 @@ module Aws::Comprehend
2922
2929
  # import. Version names can have a maximum of 256 characters.
2923
2930
  # Alphanumeric characters, hyphens (-) and underscores (\_) are allowed.
2924
2931
  # The version name must be unique among all models with the same
2925
- # classifier name in the account/AWS Region.
2932
+ # classifier name in the account/Region.
2926
2933
  #
2927
2934
  # @option params [String] :model_kms_key_id
2928
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
2929
- # uses to encrypt trained custom models. The ModelKmsKeyId can be either
2930
- # of the following formats:
2935
+ # ID for the KMS key that Amazon Comprehend uses to encrypt trained
2936
+ # custom models. The ModelKmsKeyId can be either of the following
2937
+ # formats:
2931
2938
  #
2932
2939
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
2933
2940
  #
@@ -2935,10 +2942,9 @@ module Aws::Comprehend
2935
2942
  # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
2936
2943
  #
2937
2944
  # @option params [String] :data_access_role_arn
2938
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
2939
- # Management (IAM) role that grants Amazon Comprehend permission to use
2940
- # Amazon Key Management Service (KMS) to encrypt or decrypt the custom
2941
- # model.
2945
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
2946
+ # Comprehend permission to use Amazon Key Management Service (KMS) to
2947
+ # encrypt or decrypt the custom model.
2942
2948
  #
2943
2949
  # @option params [Array<Types::Tag>] :tags
2944
2950
  # Tags to associate with the custom model that is created by this
@@ -2980,7 +2986,7 @@ module Aws::Comprehend
2980
2986
  req.send_request(options)
2981
2987
  end
2982
2988
 
2983
- # List the datasets that you have configured in this region. For more
2989
+ # List the datasets that you have configured in this Region. For more
2984
2990
  # information about datasets, see [ Flywheel overview][1] in the *Amazon
2985
2991
  # Comprehend Developer Guide*.
2986
2992
  #
@@ -3148,7 +3154,7 @@ module Aws::Comprehend
3148
3154
  # resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
3149
3155
  # resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
3150
3156
  # resp.document_classifier_summaries_list[0].latest_version_name #=> String
3151
- # resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
3157
+ # resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
3152
3158
  # resp.next_token #=> String
3153
3159
  #
3154
3160
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries AWS API Documentation
@@ -3185,7 +3191,7 @@ module Aws::Comprehend
3185
3191
  #
3186
3192
  # resp = client.list_document_classifiers({
3187
3193
  # filter: {
3188
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
3194
+ # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
3189
3195
  # document_classifier_name: "ComprehendArnName",
3190
3196
  # submit_time_before: Time.now,
3191
3197
  # submit_time_after: Time.now,
@@ -3199,7 +3205,7 @@ module Aws::Comprehend
3199
3205
  # resp.document_classifier_properties_list #=> Array
3200
3206
  # resp.document_classifier_properties_list[0].document_classifier_arn #=> String
3201
3207
  # resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
3202
- # resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
3208
+ # resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
3203
3209
  # resp.document_classifier_properties_list[0].message #=> String
3204
3210
  # resp.document_classifier_properties_list[0].submit_time #=> Time
3205
3211
  # resp.document_classifier_properties_list[0].end_time #=> Time
@@ -3217,6 +3223,13 @@ module Aws::Comprehend
3217
3223
  # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
3218
3224
  # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
3219
3225
  # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
3226
+ # resp.document_classifier_properties_list[0].input_data_config.document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
3227
+ # resp.document_classifier_properties_list[0].input_data_config.documents.s3_uri #=> String
3228
+ # resp.document_classifier_properties_list[0].input_data_config.documents.test_s3_uri #=> String
3229
+ # resp.document_classifier_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
3230
+ # resp.document_classifier_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
3231
+ # resp.document_classifier_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
3232
+ # resp.document_classifier_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
3220
3233
  # resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
3221
3234
  # resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
3222
3235
  # resp.document_classifier_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
@@ -3448,6 +3461,7 @@ module Aws::Comprehend
3448
3461
  # resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
3449
3462
  # resp.entities_detection_job_properties_list[0].vpc_config.subnets #=> Array
3450
3463
  # resp.entities_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
3464
+ # resp.entities_detection_job_properties_list[0].flywheel_arn #=> String
3451
3465
  # resp.next_token #=> String
3452
3466
  #
3453
3467
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs AWS API Documentation
@@ -3490,7 +3504,7 @@ module Aws::Comprehend
3490
3504
  # resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
3491
3505
  # resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
3492
3506
  # resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
3493
- # resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
3507
+ # resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
3494
3508
  # resp.next_token #=> String
3495
3509
  #
3496
3510
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries AWS API Documentation
@@ -3534,7 +3548,7 @@ module Aws::Comprehend
3534
3548
  #
3535
3549
  # resp = client.list_entity_recognizers({
3536
3550
  # filter: {
3537
- # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
3551
+ # status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
3538
3552
  # recognizer_name: "ComprehendArnName",
3539
3553
  # submit_time_before: Time.now,
3540
3554
  # submit_time_after: Time.now,
@@ -3548,7 +3562,7 @@ module Aws::Comprehend
3548
3562
  # resp.entity_recognizer_properties_list #=> Array
3549
3563
  # resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
3550
3564
  # resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
3551
- # resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
3565
+ # resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
3552
3566
  # resp.entity_recognizer_properties_list[0].message #=> String
3553
3567
  # resp.entity_recognizer_properties_list[0].submit_time #=> Time
3554
3568
  # resp.entity_recognizer_properties_list[0].end_time #=> Time
@@ -4179,9 +4193,9 @@ module Aws::Comprehend
4179
4193
  end
4180
4194
 
4181
4195
  # Attaches a resource-based policy to a custom model. You can use this
4182
- # policy to authorize an entity in another AWS account to import the
4183
- # custom model, which replicates it in Amazon Comprehend in their
4184
- # account.
4196
+ # policy to authorize an entity in another Amazon Web Services account
4197
+ # to import the custom model, which replicates it in Amazon Comprehend
4198
+ # in their account.
4185
4199
  #
4186
4200
  # @option params [required, String] :resource_arn
4187
4201
  # The Amazon Resource Name (ARN) of the custom model to attach the
@@ -4250,9 +4264,8 @@ module Aws::Comprehend
4250
4264
  # Specifies where to send the output files.
4251
4265
  #
4252
4266
  # @option params [required, String] :data_access_role_arn
4253
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4254
- # Management (IAM) role that grants Amazon Comprehend read access to
4255
- # your input data.
4267
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4268
+ # Comprehend read access to your input data.
4256
4269
  #
4257
4270
  # @option params [String] :client_request_token
4258
4271
  # A unique identifier for the request. If you do not set the client
@@ -4262,10 +4275,10 @@ module Aws::Comprehend
4262
4275
  # not need to pass this option.**
4263
4276
  #
4264
4277
  # @option params [String] :volume_kms_key_id
4265
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
4266
- # uses to encrypt data on the storage volume attached to the ML compute
4267
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
4268
- # either of the following formats:
4278
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4279
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
4280
+ # to the ML compute instance(s) that process the analysis job. The
4281
+ # VolumeKmsKeyId can be either of the following formats:
4269
4282
  #
4270
4283
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4271
4284
  #
@@ -4359,14 +4372,13 @@ module Aws::Comprehend
4359
4372
  # Specifies where to send the output files.
4360
4373
  #
4361
4374
  # @option params [required, String] :data_access_role_arn
4362
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4363
- # Management (IAM) role that grants Amazon Comprehend read access to
4364
- # your input data. For more information, see
4365
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
4375
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4376
+ # Comprehend read access to your input data. For more information, see
4377
+ # [Role-based permissions][1].
4366
4378
  #
4367
4379
  #
4368
4380
  #
4369
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4381
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
4370
4382
  #
4371
4383
  # @option params [String] :job_name
4372
4384
  # An identifier for the job.
@@ -4379,10 +4391,10 @@ module Aws::Comprehend
4379
4391
  # not need to pass this option.**
4380
4392
  #
4381
4393
  # @option params [String] :volume_kms_key_id
4382
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
4383
- # uses to encrypt data on the storage volume attached to the ML compute
4384
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
4385
- # either of the following formats:
4394
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4395
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
4396
+ # to the ML compute instance(s) that process the analysis job. The
4397
+ # VolumeKmsKeyId can be either of the following formats:
4386
4398
  #
4387
4399
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4388
4400
  #
@@ -4472,14 +4484,13 @@ module Aws::Comprehend
4472
4484
  # Specifies where to send the output files.
4473
4485
  #
4474
4486
  # @option params [required, String] :data_access_role_arn
4475
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4476
- # Management (IAM) role that grants Amazon Comprehend read access to
4477
- # your input data. For more information, see
4478
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
4487
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4488
+ # Comprehend read access to your input data. For more information, see
4489
+ # [Role-based permissions][1].
4479
4490
  #
4480
4491
  #
4481
4492
  #
4482
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4493
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
4483
4494
  #
4484
4495
  # @option params [String] :job_name
4485
4496
  # The identifier of the job.
@@ -4503,10 +4514,10 @@ module Aws::Comprehend
4503
4514
  # not need to pass this option.**
4504
4515
  #
4505
4516
  # @option params [String] :volume_kms_key_id
4506
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
4507
- # uses to encrypt data on the storage volume attached to the ML compute
4508
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
4509
- # either of the following formats:
4517
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4518
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
4519
+ # to the ML compute instance(s) that process the analysis job. The
4520
+ # VolumeKmsKeyId can be either of the following formats:
4510
4521
  #
4511
4522
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4512
4523
  #
@@ -4600,9 +4611,8 @@ module Aws::Comprehend
4600
4611
  # Specifies where to send the output files.
4601
4612
  #
4602
4613
  # @option params [required, String] :data_access_role_arn
4603
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4604
- # Management (IAM) role that grants Amazon Comprehend read access to
4605
- # your input data.
4614
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4615
+ # Comprehend read access to your input data.
4606
4616
  #
4607
4617
  # @option params [String] :job_name
4608
4618
  # The identifier of the events detection job.
@@ -4727,14 +4737,13 @@ module Aws::Comprehend
4727
4737
  # Specifies where to send the output files.
4728
4738
  #
4729
4739
  # @option params [required, String] :data_access_role_arn
4730
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4731
- # Management (IAM) role that grants Amazon Comprehend read access to
4732
- # your input data. For more information, see
4733
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
4740
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4741
+ # Comprehend read access to your input data. For more information, see
4742
+ # [Role-based permissions][1].
4734
4743
  #
4735
4744
  #
4736
4745
  #
4737
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4746
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
4738
4747
  #
4739
4748
  # @option params [String] :job_name
4740
4749
  # The identifier of the job.
@@ -4752,10 +4761,10 @@ module Aws::Comprehend
4752
4761
  # not need to pass this option.**
4753
4762
  #
4754
4763
  # @option params [String] :volume_kms_key_id
4755
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
4756
- # uses to encrypt data on the storage volume attached to the ML compute
4757
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
4758
- # either of the following formats:
4764
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4765
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
4766
+ # to the ML compute instance(s) that process the analysis job. The
4767
+ # VolumeKmsKeyId can be either of the following formats:
4759
4768
  #
4760
4769
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4761
4770
  #
@@ -4853,9 +4862,8 @@ module Aws::Comprehend
4853
4862
  # definition that includes the `PiiEntityTypes` parameter.
4854
4863
  #
4855
4864
  # @option params [required, String] :data_access_role_arn
4856
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4857
- # Management (IAM) role that grants Amazon Comprehend read access to
4858
- # your input data.
4865
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4866
+ # Comprehend read access to your input data.
4859
4867
  #
4860
4868
  # @option params [String] :job_name
4861
4869
  # The identifier of the job.
@@ -4942,14 +4950,13 @@ module Aws::Comprehend
4942
4950
  # Specifies where to send the output files.
4943
4951
  #
4944
4952
  # @option params [required, String] :data_access_role_arn
4945
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
4946
- # Management (IAM) role that grants Amazon Comprehend read access to
4947
- # your input data. For more information, see
4948
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
4953
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
4954
+ # Comprehend read access to your input data. For more information, see
4955
+ # [Role-based permissions][1].
4949
4956
  #
4950
4957
  #
4951
4958
  #
4952
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
4959
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
4953
4960
  #
4954
4961
  # @option params [String] :job_name
4955
4962
  # The identifier of the job.
@@ -4967,10 +4974,10 @@ module Aws::Comprehend
4967
4974
  # not need to pass this option.**
4968
4975
  #
4969
4976
  # @option params [String] :volume_kms_key_id
4970
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
4971
- # uses to encrypt data on the storage volume attached to the ML compute
4972
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
4973
- # either of the following formats:
4977
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
4978
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
4979
+ # to the ML compute instance(s) that process the analysis job. The
4980
+ # VolumeKmsKeyId can be either of the following formats:
4974
4981
  #
4975
4982
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
4976
4983
  #
@@ -5059,10 +5066,9 @@ module Aws::Comprehend
5059
5066
  # Specifies where to send the output files.
5060
5067
  #
5061
5068
  # @option params [required, String] :data_access_role_arn
5062
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
5063
- # Management (IAM) role that grants Amazon Comprehend read access to
5064
- # your input data. For more information, see [Role-based
5065
- # permissions][1].
5069
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
5070
+ # Comprehend read access to your input data. For more information, see
5071
+ # [Role-based permissions][1].
5066
5072
  #
5067
5073
  #
5068
5074
  #
@@ -5175,14 +5181,13 @@ module Aws::Comprehend
5175
5181
  # documents associated with each topic
5176
5182
  #
5177
5183
  # @option params [required, String] :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. For more information, see
5181
- # [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
5184
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
5185
+ # Comprehend read access to your input data. For more information, see
5186
+ # [Role-based permissions][1].
5182
5187
  #
5183
5188
  #
5184
5189
  #
5185
- # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
5190
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
5186
5191
  #
5187
5192
  # @option params [String] :job_name
5188
5193
  # The identifier of the job.
@@ -5198,10 +5203,10 @@ module Aws::Comprehend
5198
5203
  # not need to pass this option.**
5199
5204
  #
5200
5205
  # @option params [String] :volume_kms_key_id
5201
- # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
5202
- # uses to encrypt data on the storage volume attached to the ML compute
5203
- # instance(s) that process the analysis job. The VolumeKmsKeyId can be
5204
- # either of the following formats:
5206
+ # ID for the Amazon Web Services Key Management Service (KMS) key that
5207
+ # Amazon Comprehend uses to encrypt data on the storage volume attached
5208
+ # to the ML compute instance(s) that process the analysis job. The
5209
+ # VolumeKmsKeyId can be either of the following formats:
5205
5210
  #
5206
5211
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
5207
5212
  #
@@ -5736,9 +5741,8 @@ module Aws::Comprehend
5736
5741
  # The Amazon Resource Number (ARN) of the active model version.
5737
5742
  #
5738
5743
  # @option params [String] :data_access_role_arn
5739
- # The Amazon Resource Name (ARN) of the AWS Identity and Access
5740
- # Management (IAM) role that grants Amazon Comprehend permission to
5741
- # access the flywheel data.
5744
+ # The Amazon Resource Name (ARN) of the IAM role that grants Amazon
5745
+ # Comprehend permission to access the flywheel data.
5742
5746
  #
5743
5747
  # @option params [Types::UpdateDataSecurityConfig] :data_security_config
5744
5748
  # Flywheel data security configuration.
@@ -5811,7 +5815,7 @@ module Aws::Comprehend
5811
5815
  params: params,
5812
5816
  config: config)
5813
5817
  context[:gem_name] = 'aws-sdk-comprehend'
5814
- context[:gem_version] = '1.66.0'
5818
+ context[:gem_version] = '1.68.0'
5815
5819
  Seahorse::Client::Request.new(handlers, context)
5816
5820
  end
5817
5821