aws-sdk-comprehend 1.65.0 → 1.67.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend/client.rb +912 -183
- data/lib/aws-sdk-comprehend/client_api.rb +479 -2
- data/lib/aws-sdk-comprehend/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-comprehend/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-comprehend/endpoints.rb +154 -0
- data/lib/aws-sdk-comprehend/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-comprehend/types.rb +1599 -356
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +2 -2
@@ -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
|
@@ -919,6 +913,68 @@ module Aws::Comprehend
|
|
919
913
|
include Aws::Structure
|
920
914
|
end
|
921
915
|
|
916
|
+
# @!attribute [rw] flywheel_arn
|
917
|
+
# The Amazon Resource Number (ARN) of the flywheel of the flywheel to
|
918
|
+
# receive the data.
|
919
|
+
# @return [String]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] dataset_name
|
922
|
+
# Name of the dataset.
|
923
|
+
# @return [String]
|
924
|
+
#
|
925
|
+
# @!attribute [rw] dataset_type
|
926
|
+
# The dataset type. You can specify that the data in a dataset is for
|
927
|
+
# training the model or for testing the model.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] description
|
931
|
+
# Description of the dataset.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] input_data_config
|
935
|
+
# Information about the input data configuration. The type of input
|
936
|
+
# data varies based on the format of the input and whether the data is
|
937
|
+
# for a classifier model or an entity recognition model.
|
938
|
+
# @return [Types::DatasetInputDataConfig]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] client_request_token
|
941
|
+
# A unique identifier for the request. If you don't set the client
|
942
|
+
# request token, Amazon Comprehend generates one.
|
943
|
+
#
|
944
|
+
# **A suitable default value is auto-generated.** You should normally
|
945
|
+
# not need to pass this option.
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] tags
|
949
|
+
# Tags for the dataset.
|
950
|
+
# @return [Array<Types::Tag>]
|
951
|
+
#
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDatasetRequest AWS API Documentation
|
953
|
+
#
|
954
|
+
class CreateDatasetRequest < Struct.new(
|
955
|
+
:flywheel_arn,
|
956
|
+
:dataset_name,
|
957
|
+
:dataset_type,
|
958
|
+
:description,
|
959
|
+
:input_data_config,
|
960
|
+
:client_request_token,
|
961
|
+
:tags)
|
962
|
+
SENSITIVE = []
|
963
|
+
include Aws::Structure
|
964
|
+
end
|
965
|
+
|
966
|
+
# @!attribute [rw] dataset_arn
|
967
|
+
# The ARN of the dataset.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDatasetResponse AWS API Documentation
|
971
|
+
#
|
972
|
+
class CreateDatasetResponse < Struct.new(
|
973
|
+
:dataset_arn)
|
974
|
+
SENSITIVE = []
|
975
|
+
include Aws::Structure
|
976
|
+
end
|
977
|
+
|
922
978
|
# @!attribute [rw] document_classifier_name
|
923
979
|
# The name of the document classifier.
|
924
980
|
# @return [String]
|
@@ -928,21 +984,19 @@ module Aws::Comprehend
|
|
928
984
|
# names can have a maximum of 256 characters. Alphanumeric characters,
|
929
985
|
# hyphens (-) and underscores (\_) are allowed. The version name must
|
930
986
|
# be unique among all models with the same classifier name in the
|
931
|
-
# account/
|
987
|
+
# Amazon Web Services account/Amazon Web Services Region.
|
932
988
|
# @return [String]
|
933
989
|
#
|
934
990
|
# @!attribute [rw] data_access_role_arn
|
935
|
-
# The Amazon Resource Name (ARN) of the
|
936
|
-
#
|
937
|
-
# data.
|
991
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
992
|
+
# Comprehend read access to your input data.
|
938
993
|
# @return [String]
|
939
994
|
#
|
940
995
|
# @!attribute [rw] tags
|
941
|
-
# Tags to
|
942
|
-
#
|
943
|
-
#
|
944
|
-
#
|
945
|
-
# department.
|
996
|
+
# Tags to associate with the document classifier. A tag is a key-value
|
997
|
+
# pair that adds as a metadata to a resource used by Amazon
|
998
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
999
|
+
# added to a resource to indicate its use by the sales department.
|
946
1000
|
# @return [Array<Types::Tag>]
|
947
1001
|
#
|
948
1002
|
# @!attribute [rw] input_data_config
|
@@ -964,17 +1018,15 @@ module Aws::Comprehend
|
|
964
1018
|
#
|
965
1019
|
# @!attribute [rw] language_code
|
966
1020
|
# The language of the input documents. You can specify any of the
|
967
|
-
#
|
968
|
-
#
|
969
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
970
|
-
# language.
|
1021
|
+
# languages supported by Amazon Comprehend. All documents must be in
|
1022
|
+
# the same language.
|
971
1023
|
# @return [String]
|
972
1024
|
#
|
973
1025
|
# @!attribute [rw] volume_kms_key_id
|
974
|
-
# ID for the
|
975
|
-
# Comprehend uses to encrypt data on the storage volume
|
976
|
-
# the ML compute instance(s) that process the analysis
|
977
|
-
# VolumeKmsKeyId can be either of the following formats:
|
1026
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
1027
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
1028
|
+
# attached to the ML compute instance(s) that process the analysis
|
1029
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
978
1030
|
#
|
979
1031
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
980
1032
|
#
|
@@ -1002,9 +1054,9 @@ module Aws::Comprehend
|
|
1002
1054
|
# @return [String]
|
1003
1055
|
#
|
1004
1056
|
# @!attribute [rw] model_kms_key_id
|
1005
|
-
# ID for the
|
1006
|
-
#
|
1007
|
-
#
|
1057
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
1058
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
1059
|
+
# formats:
|
1008
1060
|
#
|
1009
1061
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1010
1062
|
#
|
@@ -1014,8 +1066,8 @@ module Aws::Comprehend
|
|
1014
1066
|
#
|
1015
1067
|
# @!attribute [rw] model_policy
|
1016
1068
|
# The resource-based policy to attach to your custom document
|
1017
|
-
# classifier model. You can use this policy to allow another
|
1018
|
-
# account to import your custom model.
|
1069
|
+
# classifier model. You can use this policy to allow another Amazon
|
1070
|
+
# Web Services account to import your custom model.
|
1019
1071
|
#
|
1020
1072
|
# Provide your policy as a JSON body that you enter as a UTF-8 encoded
|
1021
1073
|
# string without line breaks. To provide valid JSON, enclose the
|
@@ -1090,17 +1142,21 @@ module Aws::Comprehend
|
|
1090
1142
|
# @return [String]
|
1091
1143
|
#
|
1092
1144
|
# @!attribute [rw] tags
|
1093
|
-
# Tags
|
1094
|
-
#
|
1095
|
-
#
|
1096
|
-
#
|
1145
|
+
# Tags to associate with the endpoint. A tag is a key-value pair that
|
1146
|
+
# adds metadata to the endpoint. For example, a tag with "Sales" as
|
1147
|
+
# the key might be added to an endpoint to indicate its use by the
|
1148
|
+
# sales department.
|
1097
1149
|
# @return [Array<Types::Tag>]
|
1098
1150
|
#
|
1099
1151
|
# @!attribute [rw] data_access_role_arn
|
1100
|
-
# The Amazon Resource Name (ARN) of the
|
1101
|
-
#
|
1102
|
-
#
|
1103
|
-
#
|
1152
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1153
|
+
# Comprehend read access to trained custom models encrypted with a
|
1154
|
+
# customer managed key (ModelKmsKeyId).
|
1155
|
+
# @return [String]
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] flywheel_arn
|
1158
|
+
# The Amazon Resource Number (ARN) of the flywheel to which the
|
1159
|
+
# endpoint will be attached.
|
1104
1160
|
# @return [String]
|
1105
1161
|
#
|
1106
1162
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
|
@@ -1111,7 +1167,8 @@ module Aws::Comprehend
|
|
1111
1167
|
:desired_inference_units,
|
1112
1168
|
:client_request_token,
|
1113
1169
|
:tags,
|
1114
|
-
:data_access_role_arn
|
1170
|
+
:data_access_role_arn,
|
1171
|
+
:flywheel_arn)
|
1115
1172
|
SENSITIVE = []
|
1116
1173
|
include Aws::Structure
|
1117
1174
|
end
|
@@ -1120,10 +1177,16 @@ module Aws::Comprehend
|
|
1120
1177
|
# The Amazon Resource Number (ARN) of the endpoint being created.
|
1121
1178
|
# @return [String]
|
1122
1179
|
#
|
1180
|
+
# @!attribute [rw] model_arn
|
1181
|
+
# The Amazon Resource Number (ARN) of the model to which the endpoint
|
1182
|
+
# is attached.
|
1183
|
+
# @return [String]
|
1184
|
+
#
|
1123
1185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointResponse AWS API Documentation
|
1124
1186
|
#
|
1125
1187
|
class CreateEndpointResponse < Struct.new(
|
1126
|
-
:endpoint_arn
|
1188
|
+
:endpoint_arn,
|
1189
|
+
:model_arn)
|
1127
1190
|
SENSITIVE = []
|
1128
1191
|
include Aws::Structure
|
1129
1192
|
end
|
@@ -1132,7 +1195,7 @@ module Aws::Comprehend
|
|
1132
1195
|
# The name given to the newly created recognizer. Recognizer names can
|
1133
1196
|
# be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
|
1134
1197
|
# and underscores (\_) are allowed. The name must be unique in the
|
1135
|
-
# account/
|
1198
|
+
# account/Region.
|
1136
1199
|
# @return [String]
|
1137
1200
|
#
|
1138
1201
|
# @!attribute [rw] version_name
|
@@ -1140,26 +1203,24 @@ module Aws::Comprehend
|
|
1140
1203
|
# names can be a maximum of 256 characters. Alphanumeric characters,
|
1141
1204
|
# hyphens (-) and underscores (\_) are allowed. The version name must
|
1142
1205
|
# be unique among all models with the same recognizer name in the
|
1143
|
-
# account/
|
1206
|
+
# account/Region.
|
1144
1207
|
# @return [String]
|
1145
1208
|
#
|
1146
1209
|
# @!attribute [rw] data_access_role_arn
|
1147
|
-
# The Amazon Resource Name (ARN) of the
|
1148
|
-
#
|
1149
|
-
# data.
|
1210
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1211
|
+
# Comprehend read access to your input data.
|
1150
1212
|
# @return [String]
|
1151
1213
|
#
|
1152
1214
|
# @!attribute [rw] tags
|
1153
|
-
# Tags to
|
1154
|
-
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
# department.
|
1215
|
+
# Tags to associate with the entity recognizer. A tag is a key-value
|
1216
|
+
# pair that adds as a metadata to a resource used by Amazon
|
1217
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
1218
|
+
# added to a resource to indicate its use by the sales department.
|
1158
1219
|
# @return [Array<Types::Tag>]
|
1159
1220
|
#
|
1160
1221
|
# @!attribute [rw] input_data_config
|
1161
1222
|
# Specifies the format and location of the input data. The S3 bucket
|
1162
|
-
# containing the input data must be located in the same
|
1223
|
+
# containing the input data must be located in the same Region as the
|
1163
1224
|
# entity recognizer being created.
|
1164
1225
|
# @return [Types::EntityRecognizerInputDataConfig]
|
1165
1226
|
#
|
@@ -1181,10 +1242,10 @@ module Aws::Comprehend
|
|
1181
1242
|
# @return [String]
|
1182
1243
|
#
|
1183
1244
|
# @!attribute [rw] volume_kms_key_id
|
1184
|
-
# ID for the
|
1185
|
-
# Comprehend uses to encrypt data on the storage volume
|
1186
|
-
# the ML compute instance(s) that process the analysis
|
1187
|
-
# VolumeKmsKeyId can be either of the following formats:
|
1245
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
1246
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
1247
|
+
# attached to the ML compute instance(s) that process the analysis
|
1248
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
1188
1249
|
#
|
1189
1250
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1190
1251
|
#
|
@@ -1203,9 +1264,9 @@ module Aws::Comprehend
|
|
1203
1264
|
# @return [Types::VpcConfig]
|
1204
1265
|
#
|
1205
1266
|
# @!attribute [rw] model_kms_key_id
|
1206
|
-
# ID for the
|
1207
|
-
#
|
1208
|
-
#
|
1267
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
1268
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
1269
|
+
# formats:
|
1209
1270
|
#
|
1210
1271
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1211
1272
|
#
|
@@ -1215,8 +1276,8 @@ module Aws::Comprehend
|
|
1215
1276
|
#
|
1216
1277
|
# @!attribute [rw] model_policy
|
1217
1278
|
# The JSON resource-based policy to attach to your custom entity
|
1218
|
-
# recognizer model. You can use this policy to allow another
|
1219
|
-
# account to import your custom model.
|
1279
|
+
# recognizer model. You can use this policy to allow another Amazon
|
1280
|
+
# Web Services account to import your custom model.
|
1220
1281
|
#
|
1221
1282
|
# Provide your JSON as a UTF-8 encoded string without line breaks. To
|
1222
1283
|
# provide valid JSON for your policy, enclose the attribute names and
|
@@ -1263,6 +1324,454 @@ module Aws::Comprehend
|
|
1263
1324
|
include Aws::Structure
|
1264
1325
|
end
|
1265
1326
|
|
1327
|
+
# @!attribute [rw] flywheel_name
|
1328
|
+
# Name for the flywheel.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
1331
|
+
# @!attribute [rw] active_model_arn
|
1332
|
+
# To associate an existing model with the flywheel, specify the Amazon
|
1333
|
+
# Resource Number (ARN) of the model version.
|
1334
|
+
# @return [String]
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] data_access_role_arn
|
1337
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1338
|
+
# Comprehend the permissions required to access the flywheel data in
|
1339
|
+
# the data lake.
|
1340
|
+
# @return [String]
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] task_config
|
1343
|
+
# Configuration about the custom classifier associated with the
|
1344
|
+
# flywheel.
|
1345
|
+
# @return [Types::TaskConfig]
|
1346
|
+
#
|
1347
|
+
# @!attribute [rw] model_type
|
1348
|
+
# The model type.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] data_lake_s3_uri
|
1352
|
+
# Enter the S3 location for the data lake. You can specify a new S3
|
1353
|
+
# bucket or a new folder of an existing S3 bucket. The flywheel
|
1354
|
+
# creates the data lake at this location.
|
1355
|
+
# @return [String]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] data_security_config
|
1358
|
+
# Data security configurations.
|
1359
|
+
# @return [Types::DataSecurityConfig]
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] client_request_token
|
1362
|
+
# A unique identifier for the request. If you don't set the client
|
1363
|
+
# request token, Amazon Comprehend generates one.
|
1364
|
+
#
|
1365
|
+
# **A suitable default value is auto-generated.** You should normally
|
1366
|
+
# not need to pass this option.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] tags
|
1370
|
+
# The tags to associate with this flywheel.
|
1371
|
+
# @return [Array<Types::Tag>]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheelRequest AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class CreateFlywheelRequest < Struct.new(
|
1376
|
+
:flywheel_name,
|
1377
|
+
:active_model_arn,
|
1378
|
+
:data_access_role_arn,
|
1379
|
+
:task_config,
|
1380
|
+
:model_type,
|
1381
|
+
:data_lake_s3_uri,
|
1382
|
+
:data_security_config,
|
1383
|
+
:client_request_token,
|
1384
|
+
:tags)
|
1385
|
+
SENSITIVE = []
|
1386
|
+
include Aws::Structure
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
# @!attribute [rw] flywheel_arn
|
1390
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @!attribute [rw] active_model_arn
|
1394
|
+
# The Amazon Resource Number (ARN) of the active model version.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheelResponse AWS API Documentation
|
1398
|
+
#
|
1399
|
+
class CreateFlywheelResponse < Struct.new(
|
1400
|
+
:flywheel_arn,
|
1401
|
+
:active_model_arn)
|
1402
|
+
SENSITIVE = []
|
1403
|
+
include Aws::Structure
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
# Data security configuration.
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] model_kms_key_id
|
1409
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
1410
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
1411
|
+
# formats:
|
1412
|
+
#
|
1413
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1414
|
+
#
|
1415
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
1416
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] volume_kms_key_id
|
1420
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt the
|
1421
|
+
# volume.
|
1422
|
+
# @return [String]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] data_lake_kms_key_id
|
1425
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt the data
|
1426
|
+
# in the data lake.
|
1427
|
+
# @return [String]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] vpc_config
|
1430
|
+
# Configuration parameters for an optional private Virtual Private
|
1431
|
+
# Cloud (VPC) containing the resources you are using for the job. For
|
1432
|
+
# more information, see [Amazon VPC][1].
|
1433
|
+
#
|
1434
|
+
#
|
1435
|
+
#
|
1436
|
+
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
1437
|
+
# @return [Types::VpcConfig]
|
1438
|
+
#
|
1439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DataSecurityConfig AWS API Documentation
|
1440
|
+
#
|
1441
|
+
class DataSecurityConfig < Struct.new(
|
1442
|
+
:model_kms_key_id,
|
1443
|
+
:volume_kms_key_id,
|
1444
|
+
:data_lake_kms_key_id,
|
1445
|
+
:vpc_config)
|
1446
|
+
SENSITIVE = []
|
1447
|
+
include Aws::Structure
|
1448
|
+
end
|
1449
|
+
|
1450
|
+
# An augmented manifest file that provides training data for your custom
|
1451
|
+
# model. An augmented manifest file is a labeled dataset that is
|
1452
|
+
# produced by Amazon SageMaker Ground Truth.
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] attribute_names
|
1455
|
+
# The JSON attribute that contains the annotations for your training
|
1456
|
+
# documents. The number of attribute names that you specify depends on
|
1457
|
+
# whether your augmented manifest file is the output of a single
|
1458
|
+
# labeling job or a chained labeling job.
|
1459
|
+
#
|
1460
|
+
# If your file is the output of a single labeling job, specify the
|
1461
|
+
# LabelAttributeName key that was used when the job was created in
|
1462
|
+
# Ground Truth.
|
1463
|
+
#
|
1464
|
+
# If your file is the output of a chained labeling job, specify the
|
1465
|
+
# LabelAttributeName key for one or more jobs in the chain. Each
|
1466
|
+
# LabelAttributeName key provides the annotations from an individual
|
1467
|
+
# job.
|
1468
|
+
# @return [Array<String>]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] s3_uri
|
1471
|
+
# The Amazon S3 location of the augmented manifest file.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] annotation_data_s3_uri
|
1475
|
+
# The S3 prefix to the annotation files that are referred in the
|
1476
|
+
# augmented manifest file.
|
1477
|
+
# @return [String]
|
1478
|
+
#
|
1479
|
+
# @!attribute [rw] source_documents_s3_uri
|
1480
|
+
# The S3 prefix to the source files (PDFs) that are referred to in the
|
1481
|
+
# augmented manifest file.
|
1482
|
+
# @return [String]
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] document_type
|
1485
|
+
# The type of augmented manifest. If you don't specify, the default
|
1486
|
+
# is PlainTextDocument.
|
1487
|
+
#
|
1488
|
+
# `PLAIN_TEXT_DOCUMENT` A document type that represents any unicode
|
1489
|
+
# text that is encoded in UTF-8.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetAugmentedManifestsListItem AWS API Documentation
|
1493
|
+
#
|
1494
|
+
class DatasetAugmentedManifestsListItem < Struct.new(
|
1495
|
+
:attribute_names,
|
1496
|
+
:s3_uri,
|
1497
|
+
:annotation_data_s3_uri,
|
1498
|
+
:source_documents_s3_uri,
|
1499
|
+
:document_type)
|
1500
|
+
SENSITIVE = []
|
1501
|
+
include Aws::Structure
|
1502
|
+
end
|
1503
|
+
|
1504
|
+
# Describes the dataset input data configuration for a document
|
1505
|
+
# classifier model.
|
1506
|
+
#
|
1507
|
+
# For more information on how the input file is formatted, see
|
1508
|
+
# [Preparing training data][1] in the Comprehend Developer Guide.
|
1509
|
+
#
|
1510
|
+
#
|
1511
|
+
#
|
1512
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
|
1513
|
+
#
|
1514
|
+
# @!attribute [rw] s3_uri
|
1515
|
+
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
1516
|
+
# same Region as the API endpoint that you are calling. The URI can
|
1517
|
+
# point to a single input file or it can provide the prefix for a
|
1518
|
+
# collection of input files.
|
1519
|
+
#
|
1520
|
+
# For example, if you use the URI `S3://bucketName/prefix`, if the
|
1521
|
+
# prefix is a single file, Amazon Comprehend uses that file as input.
|
1522
|
+
# If more than one file begins with the prefix, Amazon Comprehend uses
|
1523
|
+
# all of them as input.
|
1524
|
+
#
|
1525
|
+
# This parameter is required if you set `DataFormat` to
|
1526
|
+
# `COMPREHEND_CSV`.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] label_delimiter
|
1530
|
+
# Indicates the delimiter used to separate each label for training a
|
1531
|
+
# multi-label classifier. The default delimiter between labels is a
|
1532
|
+
# pipe (\|). You can use a different character as a delimiter (if
|
1533
|
+
# it's an allowed character) by specifying it under Delimiter for
|
1534
|
+
# labels. If the training documents use a delimiter other than the
|
1535
|
+
# default or the delimiter you specify, the labels on that line will
|
1536
|
+
# be combined to make a single unique label, such as LABELLABELLABEL.
|
1537
|
+
# @return [String]
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetDocumentClassifierInputDataConfig AWS API Documentation
|
1540
|
+
#
|
1541
|
+
class DatasetDocumentClassifierInputDataConfig < Struct.new(
|
1542
|
+
:s3_uri,
|
1543
|
+
:label_delimiter)
|
1544
|
+
SENSITIVE = []
|
1545
|
+
include Aws::Structure
|
1546
|
+
end
|
1547
|
+
|
1548
|
+
# Describes the annotations associated with a entity recognizer.
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] s3_uri
|
1551
|
+
# Specifies the Amazon S3 location where the training documents for an
|
1552
|
+
# entity recognizer are located. The URI must be in the same Region as
|
1553
|
+
# the API endpoint that you are calling.
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerAnnotations AWS API Documentation
|
1557
|
+
#
|
1558
|
+
class DatasetEntityRecognizerAnnotations < Struct.new(
|
1559
|
+
:s3_uri)
|
1560
|
+
SENSITIVE = []
|
1561
|
+
include Aws::Structure
|
1562
|
+
end
|
1563
|
+
|
1564
|
+
# Describes the documents submitted with a dataset for an entity
|
1565
|
+
# recognizer model.
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] s3_uri
|
1568
|
+
# Specifies the Amazon S3 location where the documents for the dataset
|
1569
|
+
# are located.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] input_format
|
1573
|
+
# Specifies how the text in an input file should be processed. This is
|
1574
|
+
# optional, and the default is ONE\_DOC\_PER\_LINE.
|
1575
|
+
# ONE\_DOC\_PER\_FILE - Each file is considered a separate document.
|
1576
|
+
# Use this option when you are processing large documents, such as
|
1577
|
+
# newspaper articles or scientific papers. ONE\_DOC\_PER\_LINE - Each
|
1578
|
+
# line in a file is considered a separate document. Use this option
|
1579
|
+
# when you are processing many short documents, such as text messages.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerDocuments AWS API Documentation
|
1583
|
+
#
|
1584
|
+
class DatasetEntityRecognizerDocuments < Struct.new(
|
1585
|
+
:s3_uri,
|
1586
|
+
:input_format)
|
1587
|
+
SENSITIVE = []
|
1588
|
+
include Aws::Structure
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# Describes the dataset entity list for an entity recognizer model.
|
1592
|
+
#
|
1593
|
+
# For more information on how the input file is formatted, see
|
1594
|
+
# [Preparing training data][1] in the Comprehend Developer Guide.
|
1595
|
+
#
|
1596
|
+
#
|
1597
|
+
#
|
1598
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] s3_uri
|
1601
|
+
# Specifies the Amazon S3 location where the entity list is located.
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerEntityList AWS API Documentation
|
1605
|
+
#
|
1606
|
+
class DatasetEntityRecognizerEntityList < Struct.new(
|
1607
|
+
:s3_uri)
|
1608
|
+
SENSITIVE = []
|
1609
|
+
include Aws::Structure
|
1610
|
+
end
|
1611
|
+
|
1612
|
+
# Specifies the format and location of the input data. You must provide
|
1613
|
+
# either the `Annotations` parameter or the `EntityList` parameter.
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] annotations
|
1616
|
+
# The S3 location of the annotation documents for your custom entity
|
1617
|
+
# recognizer.
|
1618
|
+
# @return [Types::DatasetEntityRecognizerAnnotations]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] documents
|
1621
|
+
# The format and location of the training documents for your custom
|
1622
|
+
# entity recognizer.
|
1623
|
+
# @return [Types::DatasetEntityRecognizerDocuments]
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] entity_list
|
1626
|
+
# The S3 location of the entity list for your custom entity
|
1627
|
+
# recognizer.
|
1628
|
+
# @return [Types::DatasetEntityRecognizerEntityList]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerInputDataConfig AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class DatasetEntityRecognizerInputDataConfig < Struct.new(
|
1633
|
+
:annotations,
|
1634
|
+
:documents,
|
1635
|
+
:entity_list)
|
1636
|
+
SENSITIVE = []
|
1637
|
+
include Aws::Structure
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
# Filter the datasets based on creation time or dataset status.
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] status
|
1643
|
+
# Filter the datasets based on the dataset status.
|
1644
|
+
# @return [String]
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] dataset_type
|
1647
|
+
# Filter the datasets based on the dataset type.
|
1648
|
+
# @return [String]
|
1649
|
+
#
|
1650
|
+
# @!attribute [rw] creation_time_after
|
1651
|
+
# Filter the datasets to include datasets created after the specified
|
1652
|
+
# time.
|
1653
|
+
# @return [Time]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] creation_time_before
|
1656
|
+
# Filter the datasets to include datasets created before the specified
|
1657
|
+
# time.
|
1658
|
+
# @return [Time]
|
1659
|
+
#
|
1660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetFilter AWS API Documentation
|
1661
|
+
#
|
1662
|
+
class DatasetFilter < Struct.new(
|
1663
|
+
:status,
|
1664
|
+
:dataset_type,
|
1665
|
+
:creation_time_after,
|
1666
|
+
:creation_time_before)
|
1667
|
+
SENSITIVE = []
|
1668
|
+
include Aws::Structure
|
1669
|
+
end
|
1670
|
+
|
1671
|
+
# Specifies the format and location of the input data for the dataset.
|
1672
|
+
#
|
1673
|
+
# @!attribute [rw] augmented_manifests
|
1674
|
+
# A list of augmented manifest files that provide training data for
|
1675
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
1676
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
1677
|
+
# @return [Array<Types::DatasetAugmentedManifestsListItem>]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] data_format
|
1680
|
+
# `COMPREHEND_CSV`: The data format is a two-column CSV file, where
|
1681
|
+
# the first column contains labels and the second column contains
|
1682
|
+
# documents.
|
1683
|
+
#
|
1684
|
+
# `AUGMENTED_MANIFEST`: The data format
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] document_classifier_input_data_config
|
1688
|
+
# The input properties for training a document classifier model.
|
1689
|
+
#
|
1690
|
+
# For more information on how the input file is formatted, see
|
1691
|
+
# [Preparing training data][1] in the Comprehend Developer Guide.
|
1692
|
+
#
|
1693
|
+
#
|
1694
|
+
#
|
1695
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
|
1696
|
+
# @return [Types::DatasetDocumentClassifierInputDataConfig]
|
1697
|
+
#
|
1698
|
+
# @!attribute [rw] entity_recognizer_input_data_config
|
1699
|
+
# The input properties for training an entity recognizer model.
|
1700
|
+
# @return [Types::DatasetEntityRecognizerInputDataConfig]
|
1701
|
+
#
|
1702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetInputDataConfig AWS API Documentation
|
1703
|
+
#
|
1704
|
+
class DatasetInputDataConfig < Struct.new(
|
1705
|
+
:augmented_manifests,
|
1706
|
+
:data_format,
|
1707
|
+
:document_classifier_input_data_config,
|
1708
|
+
:entity_recognizer_input_data_config)
|
1709
|
+
SENSITIVE = []
|
1710
|
+
include Aws::Structure
|
1711
|
+
end
|
1712
|
+
|
1713
|
+
# Properties associated with the dataset.
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] dataset_arn
|
1716
|
+
# The ARN of the dataset.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] dataset_name
|
1720
|
+
# The name of the dataset.
|
1721
|
+
# @return [String]
|
1722
|
+
#
|
1723
|
+
# @!attribute [rw] dataset_type
|
1724
|
+
# The dataset type (training data or test data).
|
1725
|
+
# @return [String]
|
1726
|
+
#
|
1727
|
+
# @!attribute [rw] dataset_s3_uri
|
1728
|
+
# The S3 URI where the dataset is stored.
|
1729
|
+
# @return [String]
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] description
|
1732
|
+
# Description of the dataset.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] status
|
1736
|
+
# The dataset status. While the system creates the dataset, the status
|
1737
|
+
# is `CREATING`. When the dataset is ready to use, the status changes
|
1738
|
+
# to `COMPLETED`.
|
1739
|
+
# @return [String]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] message
|
1742
|
+
# A description of the status of the dataset.
|
1743
|
+
# @return [String]
|
1744
|
+
#
|
1745
|
+
# @!attribute [rw] number_of_documents
|
1746
|
+
# The number of documents in the dataset.
|
1747
|
+
# @return [Integer]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] creation_time
|
1750
|
+
# Creation time of the dataset.
|
1751
|
+
# @return [Time]
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] end_time
|
1754
|
+
# Time when the data from the dataset becomes available in the data
|
1755
|
+
# lake.
|
1756
|
+
# @return [Time]
|
1757
|
+
#
|
1758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetProperties AWS API Documentation
|
1759
|
+
#
|
1760
|
+
class DatasetProperties < Struct.new(
|
1761
|
+
:dataset_arn,
|
1762
|
+
:dataset_name,
|
1763
|
+
:dataset_type,
|
1764
|
+
:dataset_s3_uri,
|
1765
|
+
:description,
|
1766
|
+
:status,
|
1767
|
+
:message,
|
1768
|
+
:number_of_documents,
|
1769
|
+
:creation_time,
|
1770
|
+
:end_time)
|
1771
|
+
SENSITIVE = []
|
1772
|
+
include Aws::Structure
|
1773
|
+
end
|
1774
|
+
|
1266
1775
|
# @!attribute [rw] document_classifier_arn
|
1267
1776
|
# The Amazon Resource Name (ARN) that identifies the document
|
1268
1777
|
# classifier.
|
@@ -1296,22 +1805,38 @@ module Aws::Comprehend
|
|
1296
1805
|
#
|
1297
1806
|
class DeleteEndpointResponse < Aws::EmptyStructure; end
|
1298
1807
|
|
1299
|
-
# @!attribute [rw] entity_recognizer_arn
|
1300
|
-
# The Amazon Resource Name (ARN) that identifies the entity
|
1301
|
-
# recognizer.
|
1808
|
+
# @!attribute [rw] entity_recognizer_arn
|
1809
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
1810
|
+
# recognizer.
|
1811
|
+
# @return [String]
|
1812
|
+
#
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizerRequest AWS API Documentation
|
1814
|
+
#
|
1815
|
+
class DeleteEntityRecognizerRequest < Struct.new(
|
1816
|
+
:entity_recognizer_arn)
|
1817
|
+
SENSITIVE = []
|
1818
|
+
include Aws::Structure
|
1819
|
+
end
|
1820
|
+
|
1821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizerResponse AWS API Documentation
|
1822
|
+
#
|
1823
|
+
class DeleteEntityRecognizerResponse < Aws::EmptyStructure; end
|
1824
|
+
|
1825
|
+
# @!attribute [rw] flywheel_arn
|
1826
|
+
# The Amazon Resource Number (ARN) of the flywheel to delete.
|
1302
1827
|
# @return [String]
|
1303
1828
|
#
|
1304
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
1829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheelRequest AWS API Documentation
|
1305
1830
|
#
|
1306
|
-
class
|
1307
|
-
:
|
1831
|
+
class DeleteFlywheelRequest < Struct.new(
|
1832
|
+
:flywheel_arn)
|
1308
1833
|
SENSITIVE = []
|
1309
1834
|
include Aws::Structure
|
1310
1835
|
end
|
1311
1836
|
|
1312
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
1837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheelResponse AWS API Documentation
|
1313
1838
|
#
|
1314
|
-
class
|
1839
|
+
class DeleteFlywheelResponse < Aws::EmptyStructure; end
|
1315
1840
|
|
1316
1841
|
# @!attribute [rw] resource_arn
|
1317
1842
|
# The Amazon Resource Name (ARN) of the custom model version that has
|
@@ -1335,9 +1860,34 @@ module Aws::Comprehend
|
|
1335
1860
|
#
|
1336
1861
|
class DeleteResourcePolicyResponse < Aws::EmptyStructure; end
|
1337
1862
|
|
1863
|
+
# @!attribute [rw] dataset_arn
|
1864
|
+
# The ARN of the dataset.
|
1865
|
+
# @return [String]
|
1866
|
+
#
|
1867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDatasetRequest AWS API Documentation
|
1868
|
+
#
|
1869
|
+
class DescribeDatasetRequest < Struct.new(
|
1870
|
+
:dataset_arn)
|
1871
|
+
SENSITIVE = []
|
1872
|
+
include Aws::Structure
|
1873
|
+
end
|
1874
|
+
|
1875
|
+
# @!attribute [rw] dataset_properties
|
1876
|
+
# The dataset properties.
|
1877
|
+
# @return [Types::DatasetProperties]
|
1878
|
+
#
|
1879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDatasetResponse AWS API Documentation
|
1880
|
+
#
|
1881
|
+
class DescribeDatasetResponse < Struct.new(
|
1882
|
+
:dataset_properties)
|
1883
|
+
SENSITIVE = []
|
1884
|
+
include Aws::Structure
|
1885
|
+
end
|
1886
|
+
|
1338
1887
|
# @!attribute [rw] job_id
|
1339
1888
|
# The identifier that Amazon Comprehend generated for the job. The
|
1340
|
-
# operation returns this identifier
|
1889
|
+
# `StartDocumentClassificationJob` operation returns this identifier
|
1890
|
+
# in its response.
|
1341
1891
|
# @return [String]
|
1342
1892
|
#
|
1343
1893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJobRequest AWS API Documentation
|
@@ -1363,7 +1913,8 @@ module Aws::Comprehend
|
|
1363
1913
|
|
1364
1914
|
# @!attribute [rw] document_classifier_arn
|
1365
1915
|
# The Amazon Resource Name (ARN) that identifies the document
|
1366
|
-
# classifier. The operation returns this
|
1916
|
+
# classifier. The `CreateDocumentClassifier` operation returns this
|
1917
|
+
# identifier in its response.
|
1367
1918
|
# @return [String]
|
1368
1919
|
#
|
1369
1920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifierRequest AWS API Documentation
|
@@ -1389,7 +1940,8 @@ module Aws::Comprehend
|
|
1389
1940
|
|
1390
1941
|
# @!attribute [rw] job_id
|
1391
1942
|
# The identifier that Amazon Comprehend generated for the job. The
|
1392
|
-
# operation returns this
|
1943
|
+
# `StartDominantLanguageDetectionJob` operation returns this
|
1944
|
+
# identifier in its response.
|
1393
1945
|
# @return [String]
|
1394
1946
|
#
|
1395
1947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJobRequest AWS API Documentation
|
@@ -1439,7 +1991,8 @@ module Aws::Comprehend
|
|
1439
1991
|
|
1440
1992
|
# @!attribute [rw] job_id
|
1441
1993
|
# The identifier that Amazon Comprehend generated for the job. The
|
1442
|
-
# operation returns this identifier in its
|
1994
|
+
# `StartEntitiesDetectionJob` operation returns this identifier in its
|
1995
|
+
# response.
|
1443
1996
|
# @return [String]
|
1444
1997
|
#
|
1445
1998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJobRequest AWS API Documentation
|
@@ -1513,9 +2066,61 @@ module Aws::Comprehend
|
|
1513
2066
|
include Aws::Structure
|
1514
2067
|
end
|
1515
2068
|
|
2069
|
+
# @!attribute [rw] flywheel_arn
|
2070
|
+
# @return [String]
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] flywheel_iteration_id
|
2073
|
+
# @return [String]
|
2074
|
+
#
|
2075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIterationRequest AWS API Documentation
|
2076
|
+
#
|
2077
|
+
class DescribeFlywheelIterationRequest < Struct.new(
|
2078
|
+
:flywheel_arn,
|
2079
|
+
:flywheel_iteration_id)
|
2080
|
+
SENSITIVE = []
|
2081
|
+
include Aws::Structure
|
2082
|
+
end
|
2083
|
+
|
2084
|
+
# @!attribute [rw] flywheel_iteration_properties
|
2085
|
+
# The configuration properties of a flywheel iteration.
|
2086
|
+
# @return [Types::FlywheelIterationProperties]
|
2087
|
+
#
|
2088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIterationResponse AWS API Documentation
|
2089
|
+
#
|
2090
|
+
class DescribeFlywheelIterationResponse < Struct.new(
|
2091
|
+
:flywheel_iteration_properties)
|
2092
|
+
SENSITIVE = []
|
2093
|
+
include Aws::Structure
|
2094
|
+
end
|
2095
|
+
|
2096
|
+
# @!attribute [rw] flywheel_arn
|
2097
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
2098
|
+
# @return [String]
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelRequest AWS API Documentation
|
2101
|
+
#
|
2102
|
+
class DescribeFlywheelRequest < Struct.new(
|
2103
|
+
:flywheel_arn)
|
2104
|
+
SENSITIVE = []
|
2105
|
+
include Aws::Structure
|
2106
|
+
end
|
2107
|
+
|
2108
|
+
# @!attribute [rw] flywheel_properties
|
2109
|
+
# The flywheel properties.
|
2110
|
+
# @return [Types::FlywheelProperties]
|
2111
|
+
#
|
2112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelResponse AWS API Documentation
|
2113
|
+
#
|
2114
|
+
class DescribeFlywheelResponse < Struct.new(
|
2115
|
+
:flywheel_properties)
|
2116
|
+
SENSITIVE = []
|
2117
|
+
include Aws::Structure
|
2118
|
+
end
|
2119
|
+
|
1516
2120
|
# @!attribute [rw] job_id
|
1517
2121
|
# The identifier that Amazon Comprehend generated for the job. The
|
1518
|
-
# operation returns this identifier in
|
2122
|
+
# `StartKeyPhrasesDetectionJob` operation returns this identifier in
|
2123
|
+
# its response.
|
1519
2124
|
# @return [String]
|
1520
2125
|
#
|
1521
2126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJobRequest AWS API Documentation
|
@@ -1634,7 +2239,8 @@ module Aws::Comprehend
|
|
1634
2239
|
|
1635
2240
|
# @!attribute [rw] job_id
|
1636
2241
|
# The identifier that Amazon Comprehend generated for the job. The
|
1637
|
-
# operation returns this
|
2242
|
+
# `StartTargetedSentimentDetectionJob` operation returns this
|
2243
|
+
# identifier in its response.
|
1638
2244
|
# @return [String]
|
1639
2245
|
#
|
1640
2246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobRequest AWS API Documentation
|
@@ -1696,11 +2302,14 @@ module Aws::Comprehend
|
|
1696
2302
|
end
|
1697
2303
|
|
1698
2304
|
# @!attribute [rw] languages
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
#
|
1702
|
-
#
|
1703
|
-
#
|
2305
|
+
# Array of languages that Amazon Comprehend detected in the input
|
2306
|
+
# text. The array is sorted in descending order of the score (the
|
2307
|
+
# dominant language is always the first element in the array).
|
2308
|
+
#
|
2309
|
+
# For each language, the response returns the RFC 5646 language code
|
2310
|
+
# and the level of confidence that Amazon Comprehend has in the
|
2311
|
+
# accuracy of its inference. For more information about RFC 5646, see
|
2312
|
+
# [Tags for Identifying Languages][1] on the *IETF Tools* web site.
|
1704
2313
|
#
|
1705
2314
|
#
|
1706
2315
|
#
|
@@ -1922,12 +2531,6 @@ module Aws::Comprehend
|
|
1922
2531
|
|
1923
2532
|
# @!attribute [rw] text
|
1924
2533
|
# A UTF-8 text string. The maximum string size is 5 KB.
|
1925
|
-
#
|
1926
|
-
# <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
|
1927
|
-
# 500 characters of the input text and ignores any additional text in
|
1928
|
-
# the input.
|
1929
|
-
#
|
1930
|
-
# </note>
|
1931
2534
|
# @return [String]
|
1932
2535
|
#
|
1933
2536
|
# @!attribute [rw] language_code
|
@@ -2061,6 +2664,26 @@ module Aws::Comprehend
|
|
2061
2664
|
include Aws::Structure
|
2062
2665
|
end
|
2063
2666
|
|
2667
|
+
# Configuration required for a custom classification model.
|
2668
|
+
#
|
2669
|
+
# @!attribute [rw] mode
|
2670
|
+
# Classification mode indicates whether the documents are
|
2671
|
+
# `MULTI_CLASS` or `MULTI_LABEL`.
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2674
|
+
# @!attribute [rw] labels
|
2675
|
+
# One or more labels to associate with the custom classifier.
|
2676
|
+
# @return [Array<String>]
|
2677
|
+
#
|
2678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationConfig AWS API Documentation
|
2679
|
+
#
|
2680
|
+
class DocumentClassificationConfig < Struct.new(
|
2681
|
+
:mode,
|
2682
|
+
:labels)
|
2683
|
+
SENSITIVE = []
|
2684
|
+
include Aws::Structure
|
2685
|
+
end
|
2686
|
+
|
2064
2687
|
# Provides information for filtering a list of document classification
|
2065
2688
|
# jobs. For more information, see the operation. You can provide only
|
2066
2689
|
# one filter parameter in each request.
|
@@ -2108,8 +2731,8 @@ module Aws::Comprehend
|
|
2108
2731
|
# @!attribute [rw] job_arn
|
2109
2732
|
# The Amazon Resource Name (ARN) of the document classification job.
|
2110
2733
|
# It is a unique, fully qualified identifier for the job. It includes
|
2111
|
-
# the
|
2112
|
-
# follows:
|
2734
|
+
# the Amazon Web Services account, Amazon Web Services Region, and the
|
2735
|
+
# job ID. The format of the ARN is as follows:
|
2113
2736
|
#
|
2114
2737
|
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
2115
2738
|
#
|
@@ -2156,16 +2779,15 @@ module Aws::Comprehend
|
|
2156
2779
|
# @return [Types::OutputDataConfig]
|
2157
2780
|
#
|
2158
2781
|
# @!attribute [rw] data_access_role_arn
|
2159
|
-
# The Amazon Resource Name (ARN) of the
|
2160
|
-
#
|
2161
|
-
# your input data.
|
2782
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
2783
|
+
# Comprehend read access to your input data.
|
2162
2784
|
# @return [String]
|
2163
2785
|
#
|
2164
2786
|
# @!attribute [rw] volume_kms_key_id
|
2165
|
-
# ID for the
|
2166
|
-
# Comprehend uses to encrypt data on the storage volume
|
2167
|
-
# the ML compute instance(s) that process the analysis
|
2168
|
-
# VolumeKmsKeyId can be either of the following formats:
|
2787
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
2788
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
2789
|
+
# attached to the ML compute instance(s) that process the analysis
|
2790
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
2169
2791
|
#
|
2170
2792
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2171
2793
|
#
|
@@ -2183,6 +2805,10 @@ module Aws::Comprehend
|
|
2183
2805
|
# [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
|
2184
2806
|
# @return [Types::VpcConfig]
|
2185
2807
|
#
|
2808
|
+
# @!attribute [rw] flywheel_arn
|
2809
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
2810
|
+
# @return [String]
|
2811
|
+
#
|
2186
2812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
|
2187
2813
|
#
|
2188
2814
|
class DocumentClassificationJobProperties < Struct.new(
|
@@ -2198,14 +2824,15 @@ module Aws::Comprehend
|
|
2198
2824
|
:output_data_config,
|
2199
2825
|
:data_access_role_arn,
|
2200
2826
|
:volume_kms_key_id,
|
2201
|
-
:vpc_config
|
2827
|
+
:vpc_config,
|
2828
|
+
:flywheel_arn)
|
2202
2829
|
SENSITIVE = []
|
2203
2830
|
include Aws::Structure
|
2204
2831
|
end
|
2205
2832
|
|
2206
2833
|
# Provides information for filtering a list of document classifiers. You
|
2207
2834
|
# can only specify one filtering parameter in a request. For more
|
2208
|
-
# information, see the operation.
|
2835
|
+
# information, see the `ListDocumentClassifiers` operation.
|
2209
2836
|
#
|
2210
2837
|
# @!attribute [rw] status
|
2211
2838
|
# Filters the list of classifiers based on status.
|
@@ -2252,15 +2879,15 @@ module Aws::Comprehend
|
|
2252
2879
|
# @!attribute [rw] data_format
|
2253
2880
|
# The format of your training data:
|
2254
2881
|
#
|
2255
|
-
# * `COMPREHEND_CSV
|
2256
|
-
#
|
2257
|
-
#
|
2258
|
-
#
|
2882
|
+
# * `COMPREHEND_CSV`: A two-column CSV file, where labels are provided
|
2883
|
+
# in the first column, and documents are provided in the second. If
|
2884
|
+
# you use this value, you must provide the `S3Uri` parameter in your
|
2885
|
+
# request.
|
2259
2886
|
#
|
2260
|
-
# * `AUGMENTED_MANIFEST
|
2261
|
-
#
|
2262
|
-
#
|
2263
|
-
#
|
2887
|
+
# * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
|
2888
|
+
# SageMaker Ground Truth. This file is in JSON lines format. Each
|
2889
|
+
# line is a complete JSON object that contains a training document
|
2890
|
+
# and its associated labels.
|
2264
2891
|
#
|
2265
2892
|
# If you use this value, you must provide the `AugmentedManifests`
|
2266
2893
|
# parameter in your request.
|
@@ -2271,7 +2898,7 @@ module Aws::Comprehend
|
|
2271
2898
|
#
|
2272
2899
|
# @!attribute [rw] s3_uri
|
2273
2900
|
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
2274
|
-
# same
|
2901
|
+
# same Region as the API endpoint that you are calling. The URI can
|
2275
2902
|
# point to a single input file or it can provide the prefix for a
|
2276
2903
|
# collection of input files.
|
2277
2904
|
#
|
@@ -2286,8 +2913,8 @@ module Aws::Comprehend
|
|
2286
2913
|
#
|
2287
2914
|
# @!attribute [rw] test_s3_uri
|
2288
2915
|
# This specifies the Amazon S3 location where the test annotations for
|
2289
|
-
# an entity recognizer are located. The URI must be in the same
|
2290
|
-
# Region as the API endpoint that you are calling.
|
2916
|
+
# an entity recognizer are located. The URI must be in the same Amazon
|
2917
|
+
# Web Services Region as the API endpoint that you are calling.
|
2291
2918
|
# @return [String]
|
2292
2919
|
#
|
2293
2920
|
# @!attribute [rw] label_delimiter
|
@@ -2327,7 +2954,7 @@ module Aws::Comprehend
|
|
2327
2954
|
# @!attribute [rw] s3_uri
|
2328
2955
|
# When you use the `OutputDataConfig` object while creating a custom
|
2329
2956
|
# classifier, you specify the Amazon S3 location where you want to
|
2330
|
-
# write the confusion matrix. The URI must be in the same
|
2957
|
+
# write the confusion matrix. The URI must be in the same Region as
|
2331
2958
|
# the API endpoint that you are calling. The location is used as the
|
2332
2959
|
# prefix for the actual location of this output file.
|
2333
2960
|
#
|
@@ -2338,9 +2965,9 @@ module Aws::Comprehend
|
|
2338
2965
|
# @return [String]
|
2339
2966
|
#
|
2340
2967
|
# @!attribute [rw] kms_key_id
|
2341
|
-
# ID for the
|
2342
|
-
# Comprehend uses to encrypt the output results from an
|
2343
|
-
# The KmsKeyId can be one of the following formats:
|
2968
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
2969
|
+
# Amazon Comprehend uses to encrypt the output results from an
|
2970
|
+
# analysis job. The KmsKeyId can be one of the following formats:
|
2344
2971
|
#
|
2345
2972
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2346
2973
|
#
|
@@ -2353,11 +2980,17 @@ module Aws::Comprehend
|
|
2353
2980
|
# `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`
|
2354
2981
|
# @return [String]
|
2355
2982
|
#
|
2983
|
+
# @!attribute [rw] flywheel_stats_s3_prefix
|
2984
|
+
# The Amazon S3 prefix for the data lake location of the flywheel
|
2985
|
+
# statistics.
|
2986
|
+
# @return [String]
|
2987
|
+
#
|
2356
2988
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierOutputDataConfig AWS API Documentation
|
2357
2989
|
#
|
2358
2990
|
class DocumentClassifierOutputDataConfig < Struct.new(
|
2359
2991
|
:s3_uri,
|
2360
|
-
:kms_key_id
|
2992
|
+
:kms_key_id,
|
2993
|
+
:flywheel_stats_s3_prefix)
|
2361
2994
|
SENSITIVE = []
|
2362
2995
|
include Aws::Structure
|
2363
2996
|
end
|
@@ -2423,16 +3056,15 @@ module Aws::Comprehend
|
|
2423
3056
|
# @return [Types::ClassifierMetadata]
|
2424
3057
|
#
|
2425
3058
|
# @!attribute [rw] data_access_role_arn
|
2426
|
-
# The Amazon Resource Name (ARN) of the
|
2427
|
-
#
|
2428
|
-
# data.
|
3059
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
3060
|
+
# Comprehend read access to your input data.
|
2429
3061
|
# @return [String]
|
2430
3062
|
#
|
2431
3063
|
# @!attribute [rw] volume_kms_key_id
|
2432
|
-
# ID for the
|
2433
|
-
# Comprehend uses to encrypt data on the storage volume
|
2434
|
-
# the ML compute instance(s) that process the analysis
|
2435
|
-
# VolumeKmsKeyId can be either of the following formats:
|
3064
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
3065
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
3066
|
+
# attached to the ML compute instance(s) that process the analysis
|
3067
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
2436
3068
|
#
|
2437
3069
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2438
3070
|
#
|
@@ -2458,9 +3090,9 @@ module Aws::Comprehend
|
|
2458
3090
|
# @return [String]
|
2459
3091
|
#
|
2460
3092
|
# @!attribute [rw] model_kms_key_id
|
2461
|
-
# ID for the
|
2462
|
-
#
|
2463
|
-
#
|
3093
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
3094
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
3095
|
+
# formats:
|
2464
3096
|
#
|
2465
3097
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2466
3098
|
#
|
@@ -2474,8 +3106,12 @@ module Aws::Comprehend
|
|
2474
3106
|
#
|
2475
3107
|
# @!attribute [rw] source_model_arn
|
2476
3108
|
# The Amazon Resource Name (ARN) of the source model. This model was
|
2477
|
-
# imported from a different
|
2478
|
-
# classifier model in your
|
3109
|
+
# imported from a different Amazon Web Services account to create the
|
3110
|
+
# document classifier model in your Amazon Web Services account.
|
3111
|
+
# @return [String]
|
3112
|
+
#
|
3113
|
+
# @!attribute [rw] flywheel_arn
|
3114
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
2479
3115
|
# @return [String]
|
2480
3116
|
#
|
2481
3117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
@@ -2498,7 +3134,8 @@ module Aws::Comprehend
|
|
2498
3134
|
:mode,
|
2499
3135
|
:model_kms_key_id,
|
2500
3136
|
:version_name,
|
2501
|
-
:source_model_arn
|
3137
|
+
:source_model_arn,
|
3138
|
+
:flywheel_arn)
|
2502
3139
|
SENSITIVE = [:classifier_metadata]
|
2503
3140
|
include Aws::Structure
|
2504
3141
|
end
|
@@ -2749,8 +3386,8 @@ module Aws::Comprehend
|
|
2749
3386
|
# @!attribute [rw] job_arn
|
2750
3387
|
# The Amazon Resource Name (ARN) of the dominant language detection
|
2751
3388
|
# job. It is a unique, fully qualified identifier for the job. It
|
2752
|
-
# includes the
|
2753
|
-
# ARN is as follows:
|
3389
|
+
# includes the Amazon Web Services account, Amazon Web Services
|
3390
|
+
# Region, and the job ID. The format of the ARN is as follows:
|
2754
3391
|
#
|
2755
3392
|
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
2756
3393
|
#
|
@@ -2793,15 +3430,15 @@ module Aws::Comprehend
|
|
2793
3430
|
# @return [Types::OutputDataConfig]
|
2794
3431
|
#
|
2795
3432
|
# @!attribute [rw] data_access_role_arn
|
2796
|
-
# The Amazon Resource Name (ARN) that
|
2797
|
-
# access to your input data.
|
3433
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
3434
|
+
# Comprehend read access to your input data.
|
2798
3435
|
# @return [String]
|
2799
3436
|
#
|
2800
3437
|
# @!attribute [rw] volume_kms_key_id
|
2801
|
-
# ID for the
|
2802
|
-
# Comprehend uses to encrypt data on the storage volume
|
2803
|
-
# the ML compute instance(s) that process the analysis
|
2804
|
-
# VolumeKmsKeyId can be either of the following formats:
|
3438
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
3439
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
3440
|
+
# attached to the ML compute instance(s) that process the analysis
|
3441
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
2805
3442
|
#
|
2806
3443
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2807
3444
|
#
|
@@ -2925,10 +3562,9 @@ module Aws::Comprehend
|
|
2925
3562
|
# @return [Time]
|
2926
3563
|
#
|
2927
3564
|
# @!attribute [rw] data_access_role_arn
|
2928
|
-
# The Amazon Resource Name (ARN) of the
|
2929
|
-
#
|
2930
|
-
#
|
2931
|
-
# (ModelKmsKeyId).
|
3565
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
3566
|
+
# Comprehend read access to trained custom models encrypted with a
|
3567
|
+
# customer managed key (ModelKmsKeyId).
|
2932
3568
|
# @return [String]
|
2933
3569
|
#
|
2934
3570
|
# @!attribute [rw] desired_data_access_role_arn
|
@@ -2936,6 +3572,10 @@ module Aws::Comprehend
|
|
2936
3572
|
# a customer KMS key.
|
2937
3573
|
# @return [String]
|
2938
3574
|
#
|
3575
|
+
# @!attribute [rw] flywheel_arn
|
3576
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
3577
|
+
# @return [String]
|
3578
|
+
#
|
2939
3579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
|
2940
3580
|
#
|
2941
3581
|
class EndpointProperties < Struct.new(
|
@@ -2949,7 +3589,8 @@ module Aws::Comprehend
|
|
2949
3589
|
:creation_time,
|
2950
3590
|
:last_modified_time,
|
2951
3591
|
:data_access_role_arn,
|
2952
|
-
:desired_data_access_role_arn
|
3592
|
+
:desired_data_access_role_arn,
|
3593
|
+
:flywheel_arn)
|
2953
3594
|
SENSITIVE = []
|
2954
3595
|
include Aws::Structure
|
2955
3596
|
end
|
@@ -3000,8 +3641,8 @@ module Aws::Comprehend
|
|
3000
3641
|
# @!attribute [rw] job_arn
|
3001
3642
|
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
3002
3643
|
# a unique, fully qualified identifier for the job. It includes the
|
3003
|
-
#
|
3004
|
-
# follows:
|
3644
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
3645
|
+
# ID. The format of the ARN is as follows:
|
3005
3646
|
#
|
3006
3647
|
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
3007
3648
|
#
|
@@ -3052,15 +3693,15 @@ module Aws::Comprehend
|
|
3052
3693
|
# @return [String]
|
3053
3694
|
#
|
3054
3695
|
# @!attribute [rw] data_access_role_arn
|
3055
|
-
# The Amazon Resource Name (ARN) that
|
3056
|
-
# access to your input data.
|
3696
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
3697
|
+
# Comprehend read access to your input data.
|
3057
3698
|
# @return [String]
|
3058
3699
|
#
|
3059
3700
|
# @!attribute [rw] volume_kms_key_id
|
3060
|
-
# ID for the
|
3061
|
-
# Comprehend uses to encrypt data on the storage volume
|
3062
|
-
# the ML compute instance(s) that process the analysis
|
3063
|
-
# VolumeKmsKeyId can be either of the following formats:
|
3701
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
3702
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
3703
|
+
# attached to the ML compute instance(s) that process the analysis
|
3704
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
3064
3705
|
#
|
3065
3706
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3066
3707
|
#
|
@@ -3078,6 +3719,11 @@ module Aws::Comprehend
|
|
3078
3719
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3079
3720
|
# @return [Types::VpcConfig]
|
3080
3721
|
#
|
3722
|
+
# @!attribute [rw] flywheel_arn
|
3723
|
+
# The Amazon Resource Name (ARN) of the flywheel associated with this
|
3724
|
+
# job.
|
3725
|
+
# @return [String]
|
3726
|
+
#
|
3081
3727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties AWS API Documentation
|
3082
3728
|
#
|
3083
3729
|
class EntitiesDetectionJobProperties < Struct.new(
|
@@ -3094,7 +3740,8 @@ module Aws::Comprehend
|
|
3094
3740
|
:language_code,
|
3095
3741
|
:data_access_role_arn,
|
3096
3742
|
:volume_kms_key_id,
|
3097
|
-
:vpc_config
|
3743
|
+
:vpc_config,
|
3744
|
+
:flywheel_arn)
|
3098
3745
|
SENSITIVE = []
|
3099
3746
|
include Aws::Structure
|
3100
3747
|
end
|
@@ -3171,17 +3818,31 @@ module Aws::Comprehend
|
|
3171
3818
|
include Aws::Structure
|
3172
3819
|
end
|
3173
3820
|
|
3821
|
+
# Configuration required for an entity recognition model.
|
3822
|
+
#
|
3823
|
+
# @!attribute [rw] entity_types
|
3824
|
+
# Up to 25 entity types that the model is trained to recognize.
|
3825
|
+
# @return [Array<Types::EntityTypesListItem>]
|
3826
|
+
#
|
3827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognitionConfig AWS API Documentation
|
3828
|
+
#
|
3829
|
+
class EntityRecognitionConfig < Struct.new(
|
3830
|
+
:entity_types)
|
3831
|
+
SENSITIVE = []
|
3832
|
+
include Aws::Structure
|
3833
|
+
end
|
3834
|
+
|
3174
3835
|
# Describes the annotations associated with a entity recognizer.
|
3175
3836
|
#
|
3176
3837
|
# @!attribute [rw] s3_uri
|
3177
3838
|
# Specifies the Amazon S3 location where the annotations for an entity
|
3178
|
-
# recognizer are located. The URI must be in the same
|
3839
|
+
# recognizer are located. The URI must be in the same Region as the
|
3179
3840
|
# API endpoint that you are calling.
|
3180
3841
|
# @return [String]
|
3181
3842
|
#
|
3182
3843
|
# @!attribute [rw] test_s3_uri
|
3183
3844
|
# Specifies the Amazon S3 location where the test annotations for an
|
3184
|
-
# entity recognizer are located. The URI must be in the same
|
3845
|
+
# entity recognizer are located. The URI must be in the same Region as
|
3185
3846
|
# the API endpoint that you are calling.
|
3186
3847
|
# @return [String]
|
3187
3848
|
#
|
@@ -3198,14 +3859,14 @@ module Aws::Comprehend
|
|
3198
3859
|
#
|
3199
3860
|
# @!attribute [rw] s3_uri
|
3200
3861
|
# Specifies the Amazon S3 location where the training documents for an
|
3201
|
-
# entity recognizer are located. The URI must be in the same
|
3862
|
+
# entity recognizer are located. The URI must be in the same Region as
|
3202
3863
|
# the API endpoint that you are calling.
|
3203
3864
|
# @return [String]
|
3204
3865
|
#
|
3205
3866
|
# @!attribute [rw] test_s3_uri
|
3206
3867
|
# Specifies the Amazon S3 location where the test documents for an
|
3207
|
-
# entity recognizer are located. The URI must be in the same
|
3208
|
-
# Region as the API endpoint that you are calling.
|
3868
|
+
# entity recognizer are located. The URI must be in the same Amazon
|
3869
|
+
# Web Services Region as the API endpoint that you are calling.
|
3209
3870
|
# @return [String]
|
3210
3871
|
#
|
3211
3872
|
# @!attribute [rw] input_format
|
@@ -3228,11 +3889,11 @@ module Aws::Comprehend
|
|
3228
3889
|
include Aws::Structure
|
3229
3890
|
end
|
3230
3891
|
|
3231
|
-
# Describes the entity
|
3892
|
+
# Describes the entity list submitted with an entity recognizer.
|
3232
3893
|
#
|
3233
3894
|
# @!attribute [rw] s3_uri
|
3234
3895
|
# Specifies the Amazon S3 location where the entity list is located.
|
3235
|
-
# The URI must be in the same
|
3896
|
+
# The URI must be in the same Region as the API endpoint that you are
|
3236
3897
|
# calling.
|
3237
3898
|
# @return [String]
|
3238
3899
|
#
|
@@ -3279,7 +3940,7 @@ module Aws::Comprehend
|
|
3279
3940
|
|
3280
3941
|
# Provides information for filtering a list of entity recognizers. You
|
3281
3942
|
# can only specify one filtering parameter in a request. For more
|
3282
|
-
# information, see the operation./>
|
3943
|
+
# information, see the `ListEntityRecognizers` operation./>
|
3283
3944
|
#
|
3284
3945
|
# @!attribute [rw] status
|
3285
3946
|
# The status of an entity recognizer.
|
@@ -3319,7 +3980,7 @@ module Aws::Comprehend
|
|
3319
3980
|
# @!attribute [rw] data_format
|
3320
3981
|
# The format of your training data:
|
3321
3982
|
#
|
3322
|
-
# * `COMPREHEND_CSV
|
3983
|
+
# * `COMPREHEND_CSV`: A CSV file that supplements your training
|
3323
3984
|
# documents. The CSV file contains information about the custom
|
3324
3985
|
# entities that your trained model will detect. The required format
|
3325
3986
|
# of the file depends on whether you are providing annotations or an
|
@@ -3330,11 +3991,11 @@ module Aws::Comprehend
|
|
3330
3991
|
# provide your training documents by using the `Documents`
|
3331
3992
|
# parameter.
|
3332
3993
|
#
|
3333
|
-
# * `AUGMENTED_MANIFEST
|
3334
|
-
#
|
3335
|
-
#
|
3336
|
-
#
|
3337
|
-
#
|
3994
|
+
# * `AUGMENTED_MANIFEST`: A labeled dataset that is produced by Amazon
|
3995
|
+
# SageMaker Ground Truth. This file is in JSON lines format. Each
|
3996
|
+
# line is a complete JSON object that contains a training document
|
3997
|
+
# and its labels. Each label annotates a named entity in the
|
3998
|
+
# training document.
|
3338
3999
|
#
|
3339
4000
|
# If you use this value, you must provide the `AugmentedManifests`
|
3340
4001
|
# parameter in your request.
|
@@ -3456,6 +4117,21 @@ module Aws::Comprehend
|
|
3456
4117
|
include Aws::Structure
|
3457
4118
|
end
|
3458
4119
|
|
4120
|
+
# Output data configuration.
|
4121
|
+
#
|
4122
|
+
# @!attribute [rw] flywheel_stats_s3_prefix
|
4123
|
+
# The Amazon S3 prefix for the data lake location of the flywheel
|
4124
|
+
# statistics.
|
4125
|
+
# @return [String]
|
4126
|
+
#
|
4127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerOutputDataConfig AWS API Documentation
|
4128
|
+
#
|
4129
|
+
class EntityRecognizerOutputDataConfig < Struct.new(
|
4130
|
+
:flywheel_stats_s3_prefix)
|
4131
|
+
SENSITIVE = []
|
4132
|
+
include Aws::Structure
|
4133
|
+
end
|
4134
|
+
|
3459
4135
|
# Describes information about an entity recognizer.
|
3460
4136
|
#
|
3461
4137
|
# @!attribute [rw] entity_recognizer_arn
|
@@ -3501,16 +4177,15 @@ module Aws::Comprehend
|
|
3501
4177
|
# @return [Types::EntityRecognizerMetadata]
|
3502
4178
|
#
|
3503
4179
|
# @!attribute [rw] data_access_role_arn
|
3504
|
-
# The Amazon Resource Name (ARN) of the
|
3505
|
-
#
|
3506
|
-
# data.
|
4180
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4181
|
+
# Comprehend read access to your input data.
|
3507
4182
|
# @return [String]
|
3508
4183
|
#
|
3509
4184
|
# @!attribute [rw] volume_kms_key_id
|
3510
|
-
# ID for the
|
3511
|
-
# Comprehend uses to encrypt data on the storage volume
|
3512
|
-
# the ML compute instance(s) that process the analysis
|
3513
|
-
# VolumeKmsKeyId can be either of the following formats:
|
4185
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4186
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
4187
|
+
# attached to the ML compute instance(s) that process the analysis
|
4188
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
3514
4189
|
#
|
3515
4190
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3516
4191
|
#
|
@@ -3529,9 +4204,9 @@ module Aws::Comprehend
|
|
3529
4204
|
# @return [Types::VpcConfig]
|
3530
4205
|
#
|
3531
4206
|
# @!attribute [rw] model_kms_key_id
|
3532
|
-
# ID for the
|
3533
|
-
#
|
3534
|
-
#
|
4207
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
4208
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
4209
|
+
# formats:
|
3535
4210
|
#
|
3536
4211
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3537
4212
|
#
|
@@ -3545,10 +4220,18 @@ module Aws::Comprehend
|
|
3545
4220
|
#
|
3546
4221
|
# @!attribute [rw] source_model_arn
|
3547
4222
|
# The Amazon Resource Name (ARN) of the source model. This model was
|
3548
|
-
# imported from a different
|
3549
|
-
# recognizer model in your
|
4223
|
+
# imported from a different Amazon Web Services account to create the
|
4224
|
+
# entity recognizer model in your Amazon Web Services account.
|
4225
|
+
# @return [String]
|
4226
|
+
#
|
4227
|
+
# @!attribute [rw] flywheel_arn
|
4228
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
3550
4229
|
# @return [String]
|
3551
4230
|
#
|
4231
|
+
# @!attribute [rw] output_data_config
|
4232
|
+
# Output data configuration.
|
4233
|
+
# @return [Types::EntityRecognizerOutputDataConfig]
|
4234
|
+
#
|
3552
4235
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
|
3553
4236
|
#
|
3554
4237
|
class EntityRecognizerProperties < Struct.new(
|
@@ -3567,7 +4250,9 @@ module Aws::Comprehend
|
|
3567
4250
|
:vpc_config,
|
3568
4251
|
:model_kms_key_id,
|
3569
4252
|
:version_name,
|
3570
|
-
:source_model_arn
|
4253
|
+
:source_model_arn,
|
4254
|
+
:flywheel_arn,
|
4255
|
+
:output_data_config)
|
3571
4256
|
SENSITIVE = [:recognizer_metadata]
|
3572
4257
|
include Aws::Structure
|
3573
4258
|
end
|
@@ -3755,9 +4440,9 @@ module Aws::Comprehend
|
|
3755
4440
|
#
|
3756
4441
|
# @!attribute [rw] job_arn
|
3757
4442
|
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
3758
|
-
# unique, fully qualified identifier for the job. It includes the
|
3759
|
-
# account, Region, and the job
|
3760
|
-
# follows:
|
4443
|
+
# unique, fully qualified identifier for the job. It includes the
|
4444
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
4445
|
+
# ID. The format of the ARN is as follows:
|
3761
4446
|
#
|
3762
4447
|
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
3763
4448
|
#
|
@@ -3801,9 +4486,8 @@ module Aws::Comprehend
|
|
3801
4486
|
# @return [String]
|
3802
4487
|
#
|
3803
4488
|
# @!attribute [rw] data_access_role_arn
|
3804
|
-
# The Amazon Resource Name (ARN) of the
|
3805
|
-
#
|
3806
|
-
# your input data.
|
4489
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4490
|
+
# Comprehend read access to your input data.
|
3807
4491
|
# @return [String]
|
3808
4492
|
#
|
3809
4493
|
# @!attribute [rw] target_event_types
|
@@ -3831,19 +4515,283 @@ module Aws::Comprehend
|
|
3831
4515
|
|
3832
4516
|
# Array of the number of characters extracted from each page.
|
3833
4517
|
#
|
3834
|
-
# @!attribute [rw] page
|
3835
|
-
# Page number.
|
3836
|
-
# @return [Integer]
|
4518
|
+
# @!attribute [rw] page
|
4519
|
+
# Page number.
|
4520
|
+
# @return [Integer]
|
4521
|
+
#
|
4522
|
+
# @!attribute [rw] count
|
4523
|
+
# Number of characters extracted from each page.
|
4524
|
+
# @return [Integer]
|
4525
|
+
#
|
4526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ExtractedCharactersListItem AWS API Documentation
|
4527
|
+
#
|
4528
|
+
class ExtractedCharactersListItem < Struct.new(
|
4529
|
+
:page,
|
4530
|
+
:count)
|
4531
|
+
SENSITIVE = []
|
4532
|
+
include Aws::Structure
|
4533
|
+
end
|
4534
|
+
|
4535
|
+
# Filter the flywheels based on creation time or flywheel status.
|
4536
|
+
#
|
4537
|
+
# @!attribute [rw] status
|
4538
|
+
# Filter the flywheels based on the flywheel status.
|
4539
|
+
# @return [String]
|
4540
|
+
#
|
4541
|
+
# @!attribute [rw] creation_time_after
|
4542
|
+
# Filter the flywheels to include flywheels created after the
|
4543
|
+
# specified time.
|
4544
|
+
# @return [Time]
|
4545
|
+
#
|
4546
|
+
# @!attribute [rw] creation_time_before
|
4547
|
+
# Filter the flywheels to include flywheels created before the
|
4548
|
+
# specified time.
|
4549
|
+
# @return [Time]
|
4550
|
+
#
|
4551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelFilter AWS API Documentation
|
4552
|
+
#
|
4553
|
+
class FlywheelFilter < Struct.new(
|
4554
|
+
:status,
|
4555
|
+
:creation_time_after,
|
4556
|
+
:creation_time_before)
|
4557
|
+
SENSITIVE = []
|
4558
|
+
include Aws::Structure
|
4559
|
+
end
|
4560
|
+
|
4561
|
+
# Filter the flywheel iterations based on creation time.
|
4562
|
+
#
|
4563
|
+
# @!attribute [rw] creation_time_after
|
4564
|
+
# Filter the flywheel iterations to include iterations created after
|
4565
|
+
# the specified time.
|
4566
|
+
# @return [Time]
|
4567
|
+
#
|
4568
|
+
# @!attribute [rw] creation_time_before
|
4569
|
+
# Filter the flywheel iterations to include iterations created before
|
4570
|
+
# the specified time.
|
4571
|
+
# @return [Time]
|
4572
|
+
#
|
4573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelIterationFilter AWS API Documentation
|
4574
|
+
#
|
4575
|
+
class FlywheelIterationFilter < Struct.new(
|
4576
|
+
:creation_time_after,
|
4577
|
+
:creation_time_before)
|
4578
|
+
SENSITIVE = []
|
4579
|
+
include Aws::Structure
|
4580
|
+
end
|
4581
|
+
|
4582
|
+
# The configuration properties of a flywheel iteration.
|
4583
|
+
#
|
4584
|
+
# @!attribute [rw] flywheel_arn
|
4585
|
+
# @return [String]
|
4586
|
+
#
|
4587
|
+
# @!attribute [rw] flywheel_iteration_id
|
4588
|
+
# @return [String]
|
4589
|
+
#
|
4590
|
+
# @!attribute [rw] creation_time
|
4591
|
+
# The creation start time of the flywheel iteration.
|
4592
|
+
# @return [Time]
|
4593
|
+
#
|
4594
|
+
# @!attribute [rw] end_time
|
4595
|
+
# The completion time of this flywheel iteration.
|
4596
|
+
# @return [Time]
|
4597
|
+
#
|
4598
|
+
# @!attribute [rw] status
|
4599
|
+
# The status of the flywheel iteration.
|
4600
|
+
# @return [String]
|
4601
|
+
#
|
4602
|
+
# @!attribute [rw] message
|
4603
|
+
# A description of the status of the flywheel iteration.
|
4604
|
+
# @return [String]
|
4605
|
+
#
|
4606
|
+
# @!attribute [rw] evaluated_model_arn
|
4607
|
+
# The ARN of the evaluated model associated with this flywheel
|
4608
|
+
# iteration.
|
4609
|
+
# @return [String]
|
4610
|
+
#
|
4611
|
+
# @!attribute [rw] evaluated_model_metrics
|
4612
|
+
# The evaluation metrics associated with the evaluated model.
|
4613
|
+
# @return [Types::FlywheelModelEvaluationMetrics]
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] trained_model_arn
|
4616
|
+
# The ARN of the trained model associated with this flywheel
|
4617
|
+
# iteration.
|
4618
|
+
# @return [String]
|
4619
|
+
#
|
4620
|
+
# @!attribute [rw] trained_model_metrics
|
4621
|
+
# The metrics associated with the trained model.
|
4622
|
+
# @return [Types::FlywheelModelEvaluationMetrics]
|
4623
|
+
#
|
4624
|
+
# @!attribute [rw] evaluation_manifest_s3_prefix
|
4625
|
+
# @return [String]
|
4626
|
+
#
|
4627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelIterationProperties AWS API Documentation
|
4628
|
+
#
|
4629
|
+
class FlywheelIterationProperties < Struct.new(
|
4630
|
+
:flywheel_arn,
|
4631
|
+
:flywheel_iteration_id,
|
4632
|
+
:creation_time,
|
4633
|
+
:end_time,
|
4634
|
+
:status,
|
4635
|
+
:message,
|
4636
|
+
:evaluated_model_arn,
|
4637
|
+
:evaluated_model_metrics,
|
4638
|
+
:trained_model_arn,
|
4639
|
+
:trained_model_metrics,
|
4640
|
+
:evaluation_manifest_s3_prefix)
|
4641
|
+
SENSITIVE = []
|
4642
|
+
include Aws::Structure
|
4643
|
+
end
|
4644
|
+
|
4645
|
+
# The evaluation metrics associated with the evaluated model.
|
4646
|
+
#
|
4647
|
+
# @!attribute [rw] average_f1_score
|
4648
|
+
# The average F1 score from the evaluation metrics.
|
4649
|
+
# @return [Float]
|
4650
|
+
#
|
4651
|
+
# @!attribute [rw] average_precision
|
4652
|
+
# Average precision metric for the model.
|
4653
|
+
# @return [Float]
|
4654
|
+
#
|
4655
|
+
# @!attribute [rw] average_recall
|
4656
|
+
# Average recall metric for the model.
|
4657
|
+
# @return [Float]
|
4658
|
+
#
|
4659
|
+
# @!attribute [rw] average_accuracy
|
4660
|
+
# Average accuracy metric for the model.
|
4661
|
+
# @return [Float]
|
4662
|
+
#
|
4663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelModelEvaluationMetrics AWS API Documentation
|
4664
|
+
#
|
4665
|
+
class FlywheelModelEvaluationMetrics < Struct.new(
|
4666
|
+
:average_f1_score,
|
4667
|
+
:average_precision,
|
4668
|
+
:average_recall,
|
4669
|
+
:average_accuracy)
|
4670
|
+
SENSITIVE = []
|
4671
|
+
include Aws::Structure
|
4672
|
+
end
|
4673
|
+
|
4674
|
+
# The flywheel properties.
|
4675
|
+
#
|
4676
|
+
# @!attribute [rw] flywheel_arn
|
4677
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @!attribute [rw] active_model_arn
|
4681
|
+
# The Amazon Resource Number (ARN) of the active model version.
|
4682
|
+
# @return [String]
|
4683
|
+
#
|
4684
|
+
# @!attribute [rw] data_access_role_arn
|
4685
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4686
|
+
# Comprehend permission to access the flywheel data.
|
4687
|
+
# @return [String]
|
4688
|
+
#
|
4689
|
+
# @!attribute [rw] task_config
|
4690
|
+
# Configuration about the custom classifier associated with the
|
4691
|
+
# flywheel.
|
4692
|
+
# @return [Types::TaskConfig]
|
4693
|
+
#
|
4694
|
+
# @!attribute [rw] data_lake_s3_uri
|
4695
|
+
# Amazon S3 URI of the data lake location.
|
4696
|
+
# @return [String]
|
4697
|
+
#
|
4698
|
+
# @!attribute [rw] data_security_config
|
4699
|
+
# Data security configuration.
|
4700
|
+
# @return [Types::DataSecurityConfig]
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] status
|
4703
|
+
# The status of the flywheel.
|
4704
|
+
# @return [String]
|
4705
|
+
#
|
4706
|
+
# @!attribute [rw] model_type
|
4707
|
+
# Model type of the flywheel's model.
|
4708
|
+
# @return [String]
|
4709
|
+
#
|
4710
|
+
# @!attribute [rw] message
|
4711
|
+
# A description of the status of the flywheel.
|
4712
|
+
# @return [String]
|
4713
|
+
#
|
4714
|
+
# @!attribute [rw] creation_time
|
4715
|
+
# Creation time of the flywheel.
|
4716
|
+
# @return [Time]
|
4717
|
+
#
|
4718
|
+
# @!attribute [rw] last_modified_time
|
4719
|
+
# Last modified time for the flywheel.
|
4720
|
+
# @return [Time]
|
4721
|
+
#
|
4722
|
+
# @!attribute [rw] latest_flywheel_iteration
|
4723
|
+
# The most recent flywheel iteration.
|
4724
|
+
# @return [String]
|
4725
|
+
#
|
4726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelProperties AWS API Documentation
|
4727
|
+
#
|
4728
|
+
class FlywheelProperties < Struct.new(
|
4729
|
+
:flywheel_arn,
|
4730
|
+
:active_model_arn,
|
4731
|
+
:data_access_role_arn,
|
4732
|
+
:task_config,
|
4733
|
+
:data_lake_s3_uri,
|
4734
|
+
:data_security_config,
|
4735
|
+
:status,
|
4736
|
+
:model_type,
|
4737
|
+
:message,
|
4738
|
+
:creation_time,
|
4739
|
+
:last_modified_time,
|
4740
|
+
:latest_flywheel_iteration)
|
4741
|
+
SENSITIVE = []
|
4742
|
+
include Aws::Structure
|
4743
|
+
end
|
4744
|
+
|
4745
|
+
# Flywheel summary information.
|
4746
|
+
#
|
4747
|
+
# @!attribute [rw] flywheel_arn
|
4748
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
4749
|
+
# @return [String]
|
4750
|
+
#
|
4751
|
+
# @!attribute [rw] active_model_arn
|
4752
|
+
# ARN of the active model version for the flywheel.
|
4753
|
+
# @return [String]
|
4754
|
+
#
|
4755
|
+
# @!attribute [rw] data_lake_s3_uri
|
4756
|
+
# Amazon S3 URI of the data lake location.
|
4757
|
+
# @return [String]
|
4758
|
+
#
|
4759
|
+
# @!attribute [rw] status
|
4760
|
+
# The status of the flywheel.
|
4761
|
+
# @return [String]
|
4762
|
+
#
|
4763
|
+
# @!attribute [rw] model_type
|
4764
|
+
# Model type of the flywheel's model.
|
4765
|
+
# @return [String]
|
3837
4766
|
#
|
3838
|
-
# @!attribute [rw]
|
3839
|
-
#
|
3840
|
-
# @return [
|
4767
|
+
# @!attribute [rw] message
|
4768
|
+
# A description of the status of the flywheel.
|
4769
|
+
# @return [String]
|
3841
4770
|
#
|
3842
|
-
#
|
4771
|
+
# @!attribute [rw] creation_time
|
4772
|
+
# Creation time of the flywheel.
|
4773
|
+
# @return [Time]
|
3843
4774
|
#
|
3844
|
-
|
3845
|
-
|
3846
|
-
|
4775
|
+
# @!attribute [rw] last_modified_time
|
4776
|
+
# Last modified time for the flywheel.
|
4777
|
+
# @return [Time]
|
4778
|
+
#
|
4779
|
+
# @!attribute [rw] latest_flywheel_iteration
|
4780
|
+
# The most recent flywheel iteration.
|
4781
|
+
# @return [String]
|
4782
|
+
#
|
4783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelSummary AWS API Documentation
|
4784
|
+
#
|
4785
|
+
class FlywheelSummary < Struct.new(
|
4786
|
+
:flywheel_arn,
|
4787
|
+
:active_model_arn,
|
4788
|
+
:data_lake_s3_uri,
|
4789
|
+
:status,
|
4790
|
+
:model_type,
|
4791
|
+
:message,
|
4792
|
+
:creation_time,
|
4793
|
+
:last_modified_time,
|
4794
|
+
:latest_flywheel_iteration)
|
3847
4795
|
SENSITIVE = []
|
3848
4796
|
include Aws::Structure
|
3849
4797
|
end
|
@@ -3890,13 +4838,13 @@ module Aws::Comprehend
|
|
3890
4838
|
# import. Version names can have a maximum of 256 characters.
|
3891
4839
|
# Alphanumeric characters, hyphens (-) and underscores (\_) are
|
3892
4840
|
# allowed. The version name must be unique among all models with the
|
3893
|
-
# same classifier name in the account/
|
4841
|
+
# same classifier name in the account/Region.
|
3894
4842
|
# @return [String]
|
3895
4843
|
#
|
3896
4844
|
# @!attribute [rw] model_kms_key_id
|
3897
|
-
# ID for the
|
3898
|
-
#
|
3899
|
-
#
|
4845
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
4846
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
4847
|
+
# formats:
|
3900
4848
|
#
|
3901
4849
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3902
4850
|
#
|
@@ -3905,13 +4853,13 @@ module Aws::Comprehend
|
|
3905
4853
|
# @return [String]
|
3906
4854
|
#
|
3907
4855
|
# @!attribute [rw] data_access_role_arn
|
3908
|
-
# The Amazon Resource Name (ARN) of the
|
3909
|
-
#
|
3910
|
-
#
|
4856
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4857
|
+
# Comprehend permission to use Amazon Key Management Service (KMS) to
|
4858
|
+
# encrypt or decrypt the custom model.
|
3911
4859
|
# @return [String]
|
3912
4860
|
#
|
3913
4861
|
# @!attribute [rw] tags
|
3914
|
-
# Tags to
|
4862
|
+
# Tags to associate with the custom model that is created by this
|
3915
4863
|
# import. A tag is a key-value pair that adds as a metadata to a
|
3916
4864
|
# resource used by Amazon Comprehend. For example, a tag with
|
3917
4865
|
# "Sales" as the key might be added to a resource to indicate its
|
@@ -3947,7 +4895,7 @@ module Aws::Comprehend
|
|
3947
4895
|
# field applies only to non-text inputs for custom analysis.
|
3948
4896
|
#
|
3949
4897
|
# @!attribute [rw] s3_uri
|
3950
|
-
# The Amazon S3 URI for the input data. The URI must be in same
|
4898
|
+
# The Amazon S3 URI for the input data. The URI must be in same Region
|
3951
4899
|
# as the API endpoint that you are calling. The URI can point to a
|
3952
4900
|
# single input file or it can provide the prefix for a collection of
|
3953
4901
|
# data files.
|
@@ -4165,8 +5113,8 @@ module Aws::Comprehend
|
|
4165
5113
|
# @!attribute [rw] job_arn
|
4166
5114
|
# The Amazon Resource Name (ARN) of the key phrases detection job. It
|
4167
5115
|
# is a unique, fully qualified identifier for the job. It includes the
|
4168
|
-
#
|
4169
|
-
# follows:
|
5116
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
5117
|
+
# ID. The format of the ARN is as follows:
|
4170
5118
|
#
|
4171
5119
|
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
4172
5120
|
#
|
@@ -4212,15 +5160,15 @@ module Aws::Comprehend
|
|
4212
5160
|
# @return [String]
|
4213
5161
|
#
|
4214
5162
|
# @!attribute [rw] data_access_role_arn
|
4215
|
-
# The Amazon Resource Name (ARN) that
|
4216
|
-
# access to your input data.
|
5163
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
5164
|
+
# Comprehend read access to your input data.
|
4217
5165
|
# @return [String]
|
4218
5166
|
#
|
4219
5167
|
# @!attribute [rw] volume_kms_key_id
|
4220
|
-
# ID for the
|
4221
|
-
#
|
4222
|
-
# the
|
4223
|
-
#
|
5168
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt data on
|
5169
|
+
# the storage volume attached to the ML compute instance(s) that
|
5170
|
+
# process the analysis job. The VolumeKmsKeyId can be either of the
|
5171
|
+
# following formats:
|
4224
5172
|
#
|
4225
5173
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
4226
5174
|
#
|
@@ -4272,6 +5220,51 @@ module Aws::Comprehend
|
|
4272
5220
|
include Aws::Structure
|
4273
5221
|
end
|
4274
5222
|
|
5223
|
+
# @!attribute [rw] flywheel_arn
|
5224
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
5225
|
+
# @return [String]
|
5226
|
+
#
|
5227
|
+
# @!attribute [rw] filter
|
5228
|
+
# Filters the datasets to be returned in the response.
|
5229
|
+
# @return [Types::DatasetFilter]
|
5230
|
+
#
|
5231
|
+
# @!attribute [rw] next_token
|
5232
|
+
# Identifies the next page of results to return.
|
5233
|
+
# @return [String]
|
5234
|
+
#
|
5235
|
+
# @!attribute [rw] max_results
|
5236
|
+
# Maximum number of results to return in a response. The default is
|
5237
|
+
# 100.
|
5238
|
+
# @return [Integer]
|
5239
|
+
#
|
5240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasetsRequest AWS API Documentation
|
5241
|
+
#
|
5242
|
+
class ListDatasetsRequest < Struct.new(
|
5243
|
+
:flywheel_arn,
|
5244
|
+
:filter,
|
5245
|
+
:next_token,
|
5246
|
+
:max_results)
|
5247
|
+
SENSITIVE = []
|
5248
|
+
include Aws::Structure
|
5249
|
+
end
|
5250
|
+
|
5251
|
+
# @!attribute [rw] dataset_properties_list
|
5252
|
+
# The dataset properties list.
|
5253
|
+
# @return [Array<Types::DatasetProperties>]
|
5254
|
+
#
|
5255
|
+
# @!attribute [rw] next_token
|
5256
|
+
# Identifies the next page of results to return.
|
5257
|
+
# @return [String]
|
5258
|
+
#
|
5259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasetsResponse AWS API Documentation
|
5260
|
+
#
|
5261
|
+
class ListDatasetsResponse < Struct.new(
|
5262
|
+
:dataset_properties_list,
|
5263
|
+
:next_token)
|
5264
|
+
SENSITIVE = []
|
5265
|
+
include Aws::Structure
|
5266
|
+
end
|
5267
|
+
|
4275
5268
|
# @!attribute [rw] filter
|
4276
5269
|
# Filters the jobs that are returned. You can filter jobs on their
|
4277
5270
|
# names, status, or the date and time that they were submitted. You
|
@@ -4541,7 +5534,7 @@ module Aws::Comprehend
|
|
4541
5534
|
# @return [Array<Types::EntityRecognizerSummary>]
|
4542
5535
|
#
|
4543
5536
|
# @!attribute [rw] next_token
|
4544
|
-
#
|
5537
|
+
# Identifies the next page of results to return.
|
4545
5538
|
# @return [String]
|
4546
5539
|
#
|
4547
5540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesResponse AWS API Documentation
|
@@ -4636,6 +5629,93 @@ module Aws::Comprehend
|
|
4636
5629
|
include Aws::Structure
|
4637
5630
|
end
|
4638
5631
|
|
5632
|
+
# @!attribute [rw] flywheel_arn
|
5633
|
+
# The ARN of the flywheel.
|
5634
|
+
# @return [String]
|
5635
|
+
#
|
5636
|
+
# @!attribute [rw] filter
|
5637
|
+
# Filter the flywheel iteration history based on creation time.
|
5638
|
+
# @return [Types::FlywheelIterationFilter]
|
5639
|
+
#
|
5640
|
+
# @!attribute [rw] next_token
|
5641
|
+
# Next token
|
5642
|
+
# @return [String]
|
5643
|
+
#
|
5644
|
+
# @!attribute [rw] max_results
|
5645
|
+
# Maximum number of iteration history results to return
|
5646
|
+
# @return [Integer]
|
5647
|
+
#
|
5648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistoryRequest AWS API Documentation
|
5649
|
+
#
|
5650
|
+
class ListFlywheelIterationHistoryRequest < Struct.new(
|
5651
|
+
:flywheel_arn,
|
5652
|
+
:filter,
|
5653
|
+
:next_token,
|
5654
|
+
:max_results)
|
5655
|
+
SENSITIVE = []
|
5656
|
+
include Aws::Structure
|
5657
|
+
end
|
5658
|
+
|
5659
|
+
# @!attribute [rw] flywheel_iteration_properties_list
|
5660
|
+
# List of flywheel iteration properties
|
5661
|
+
# @return [Array<Types::FlywheelIterationProperties>]
|
5662
|
+
#
|
5663
|
+
# @!attribute [rw] next_token
|
5664
|
+
# Next token
|
5665
|
+
# @return [String]
|
5666
|
+
#
|
5667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistoryResponse AWS API Documentation
|
5668
|
+
#
|
5669
|
+
class ListFlywheelIterationHistoryResponse < Struct.new(
|
5670
|
+
:flywheel_iteration_properties_list,
|
5671
|
+
:next_token)
|
5672
|
+
SENSITIVE = []
|
5673
|
+
include Aws::Structure
|
5674
|
+
end
|
5675
|
+
|
5676
|
+
# @!attribute [rw] filter
|
5677
|
+
# Filters the flywheels that are returned. You can filter flywheels on
|
5678
|
+
# their status, or the date and time that they were submitted. You can
|
5679
|
+
# only set one filter at a time.
|
5680
|
+
# @return [Types::FlywheelFilter]
|
5681
|
+
#
|
5682
|
+
# @!attribute [rw] next_token
|
5683
|
+
# Identifies the next page of results to return.
|
5684
|
+
# @return [String]
|
5685
|
+
#
|
5686
|
+
# @!attribute [rw] max_results
|
5687
|
+
# Maximum number of results to return in a response. The default is
|
5688
|
+
# 100.
|
5689
|
+
# @return [Integer]
|
5690
|
+
#
|
5691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelsRequest AWS API Documentation
|
5692
|
+
#
|
5693
|
+
class ListFlywheelsRequest < Struct.new(
|
5694
|
+
:filter,
|
5695
|
+
:next_token,
|
5696
|
+
:max_results)
|
5697
|
+
SENSITIVE = []
|
5698
|
+
include Aws::Structure
|
5699
|
+
end
|
5700
|
+
|
5701
|
+
# @!attribute [rw] flywheel_summary_list
|
5702
|
+
# A list of flywheel properties retrieved by the service in response
|
5703
|
+
# to the request.
|
5704
|
+
# @return [Array<Types::FlywheelSummary>]
|
5705
|
+
#
|
5706
|
+
# @!attribute [rw] next_token
|
5707
|
+
# Identifies the next page of results to return.
|
5708
|
+
# @return [String]
|
5709
|
+
#
|
5710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelsResponse AWS API Documentation
|
5711
|
+
#
|
5712
|
+
class ListFlywheelsResponse < Struct.new(
|
5713
|
+
:flywheel_summary_list,
|
5714
|
+
:next_token)
|
5715
|
+
SENSITIVE = []
|
5716
|
+
include Aws::Structure
|
5717
|
+
end
|
5718
|
+
|
4639
5719
|
# @!attribute [rw] filter
|
4640
5720
|
# Filters the jobs that are returned. You can filter jobs on their
|
4641
5721
|
# name, status, or the date and time that they were submitted. You can
|
@@ -4913,7 +5993,7 @@ module Aws::Comprehend
|
|
4913
5993
|
# @!attribute [rw] s3_uri
|
4914
5994
|
# When you use the `OutputDataConfig` object with asynchronous
|
4915
5995
|
# operations, you specify the Amazon S3 location where you want to
|
4916
|
-
# write the output data. The URI must be in the same
|
5996
|
+
# write the output data. The URI must be in the same Region as the API
|
4917
5997
|
# endpoint that you are calling. The location is used as the prefix
|
4918
5998
|
# for the actual location of the output file.
|
4919
5999
|
#
|
@@ -4928,9 +6008,9 @@ module Aws::Comprehend
|
|
4928
6008
|
# @return [String]
|
4929
6009
|
#
|
4930
6010
|
# @!attribute [rw] kms_key_id
|
4931
|
-
# ID for the
|
4932
|
-
# Comprehend uses to encrypt the output results from an
|
4933
|
-
# The KmsKeyId can be one of the following formats:
|
6011
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6012
|
+
# Amazon Comprehend uses to encrypt the output results from an
|
6013
|
+
# analysis job. The KmsKeyId can be one of the following formats:
|
4934
6014
|
#
|
4935
6015
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
4936
6016
|
#
|
@@ -5026,8 +6106,8 @@ module Aws::Comprehend
|
|
5026
6106
|
# @!attribute [rw] job_arn
|
5027
6107
|
# The Amazon Resource Name (ARN) of the PII entities detection job. It
|
5028
6108
|
# is a unique, fully qualified identifier for the job. It includes the
|
5029
|
-
#
|
5030
|
-
# follows:
|
6109
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
6110
|
+
# ID. The format of the ARN is as follows:
|
5031
6111
|
#
|
5032
6112
|
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
5033
6113
|
#
|
@@ -5080,8 +6160,8 @@ module Aws::Comprehend
|
|
5080
6160
|
# @return [String]
|
5081
6161
|
#
|
5082
6162
|
# @!attribute [rw] data_access_role_arn
|
5083
|
-
# The Amazon Resource Name (ARN) that
|
5084
|
-
# access to your input data.
|
6163
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
6164
|
+
# Comprehend read access to your input data.
|
5085
6165
|
# @return [String]
|
5086
6166
|
#
|
5087
6167
|
# @!attribute [rw] mode
|
@@ -5155,8 +6235,9 @@ module Aws::Comprehend
|
|
5155
6235
|
# @return [String]
|
5156
6236
|
#
|
5157
6237
|
# @!attribute [rw] kms_key_id
|
5158
|
-
# ID for the
|
5159
|
-
# Comprehend uses to encrypt the output results from an
|
6238
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6239
|
+
# Amazon Comprehend uses to encrypt the output results from an
|
6240
|
+
# analysis job.
|
5160
6241
|
# @return [String]
|
5161
6242
|
#
|
5162
6243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
|
@@ -5393,8 +6474,8 @@ module Aws::Comprehend
|
|
5393
6474
|
# @!attribute [rw] job_arn
|
5394
6475
|
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
5395
6476
|
# a unique, fully qualified identifier for the job. It includes the
|
5396
|
-
#
|
5397
|
-
# follows:
|
6477
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
6478
|
+
# ID. The format of the ARN is as follows:
|
5398
6479
|
#
|
5399
6480
|
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
5400
6481
|
#
|
@@ -5440,15 +6521,15 @@ module Aws::Comprehend
|
|
5440
6521
|
# @return [String]
|
5441
6522
|
#
|
5442
6523
|
# @!attribute [rw] data_access_role_arn
|
5443
|
-
# The Amazon Resource Name (ARN) that
|
5444
|
-
# access to your input data.
|
6524
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
6525
|
+
# Comprehend read access to your input data.
|
5445
6526
|
# @return [String]
|
5446
6527
|
#
|
5447
6528
|
# @!attribute [rw] volume_kms_key_id
|
5448
|
-
# ID for the
|
5449
|
-
# Comprehend uses to encrypt data on the storage volume
|
5450
|
-
# the ML compute instance(s) that process the analysis
|
5451
|
-
# VolumeKmsKeyId can be either of the following formats:
|
6529
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6530
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
6531
|
+
# attached to the ML compute instance(s) that process the analysis
|
6532
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
5452
6533
|
#
|
5453
6534
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
5454
6535
|
#
|
@@ -5538,9 +6619,8 @@ module Aws::Comprehend
|
|
5538
6619
|
# @return [Types::OutputDataConfig]
|
5539
6620
|
#
|
5540
6621
|
# @!attribute [rw] data_access_role_arn
|
5541
|
-
# The Amazon Resource Name (ARN) of the
|
5542
|
-
#
|
5543
|
-
# your input data.
|
6622
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
6623
|
+
# Comprehend read access to your input data.
|
5544
6624
|
# @return [String]
|
5545
6625
|
#
|
5546
6626
|
# @!attribute [rw] client_request_token
|
@@ -5552,10 +6632,10 @@ module Aws::Comprehend
|
|
5552
6632
|
# @return [String]
|
5553
6633
|
#
|
5554
6634
|
# @!attribute [rw] volume_kms_key_id
|
5555
|
-
# ID for the
|
5556
|
-
# Comprehend uses to encrypt data on the storage volume
|
5557
|
-
# the ML compute instance(s) that process the analysis
|
5558
|
-
# VolumeKmsKeyId can be either of the following formats:
|
6635
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6636
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
6637
|
+
# attached to the ML compute instance(s) that process the analysis
|
6638
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
5559
6639
|
#
|
5560
6640
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
5561
6641
|
#
|
@@ -5574,12 +6654,17 @@ module Aws::Comprehend
|
|
5574
6654
|
# @return [Types::VpcConfig]
|
5575
6655
|
#
|
5576
6656
|
# @!attribute [rw] tags
|
5577
|
-
# Tags to
|
5578
|
-
#
|
6657
|
+
# Tags to associate with the document classification job. A tag is a
|
6658
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5579
6659
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
5580
6660
|
# added to a resource to indicate its use by the sales department.
|
5581
6661
|
# @return [Array<Types::Tag>]
|
5582
6662
|
#
|
6663
|
+
# @!attribute [rw] flywheel_arn
|
6664
|
+
# The Amazon Resource Number (ARN) of the flywheel associated with the
|
6665
|
+
# model to use.
|
6666
|
+
# @return [String]
|
6667
|
+
#
|
5583
6668
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
|
5584
6669
|
#
|
5585
6670
|
class StartDocumentClassificationJobRequest < Struct.new(
|
@@ -5591,21 +6676,23 @@ module Aws::Comprehend
|
|
5591
6676
|
:client_request_token,
|
5592
6677
|
:volume_kms_key_id,
|
5593
6678
|
:vpc_config,
|
5594
|
-
:tags
|
6679
|
+
:tags,
|
6680
|
+
:flywheel_arn)
|
5595
6681
|
SENSITIVE = []
|
5596
6682
|
include Aws::Structure
|
5597
6683
|
end
|
5598
6684
|
|
5599
6685
|
# @!attribute [rw] job_id
|
5600
6686
|
# The identifier generated for the job. To get the status of the job,
|
5601
|
-
# use this identifier with the
|
6687
|
+
# use this identifier with the `DescribeDocumentClassificationJob`
|
6688
|
+
# operation.
|
5602
6689
|
# @return [String]
|
5603
6690
|
#
|
5604
6691
|
# @!attribute [rw] job_arn
|
5605
6692
|
# The Amazon Resource Name (ARN) of the document classification job.
|
5606
6693
|
# It is a unique, fully qualified identifier for the job. It includes
|
5607
|
-
# the
|
5608
|
-
# follows:
|
6694
|
+
# the Amazon Web Services account, Amazon Web Services Region, and the
|
6695
|
+
# job ID. The format of the ARN is as follows:
|
5609
6696
|
#
|
5610
6697
|
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
5611
6698
|
#
|
@@ -5624,7 +6711,8 @@ module Aws::Comprehend
|
|
5624
6711
|
# * COMPLETED - The job was successfully completed and the output is
|
5625
6712
|
# available.
|
5626
6713
|
#
|
5627
|
-
# * FAILED - The job did not complete. For details, use the
|
6714
|
+
# * FAILED - The job did not complete. For details, use the
|
6715
|
+
# `DescribeDocumentClassificationJob` operation.
|
5628
6716
|
#
|
5629
6717
|
# * STOP\_REQUESTED - Amazon Comprehend has received a stop request
|
5630
6718
|
# for the job and is processing the request.
|
@@ -5632,12 +6720,17 @@ module Aws::Comprehend
|
|
5632
6720
|
# * STOPPED - The job was successfully stopped without completing.
|
5633
6721
|
# @return [String]
|
5634
6722
|
#
|
6723
|
+
# @!attribute [rw] document_classifier_arn
|
6724
|
+
# The ARN of the custom classification model.
|
6725
|
+
# @return [String]
|
6726
|
+
#
|
5635
6727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobResponse AWS API Documentation
|
5636
6728
|
#
|
5637
6729
|
class StartDocumentClassificationJobResponse < Struct.new(
|
5638
6730
|
:job_id,
|
5639
6731
|
:job_arn,
|
5640
|
-
:job_status
|
6732
|
+
:job_status,
|
6733
|
+
:document_classifier_arn)
|
5641
6734
|
SENSITIVE = []
|
5642
6735
|
include Aws::Structure
|
5643
6736
|
end
|
@@ -5651,14 +6744,13 @@ module Aws::Comprehend
|
|
5651
6744
|
# @return [Types::OutputDataConfig]
|
5652
6745
|
#
|
5653
6746
|
# @!attribute [rw] data_access_role_arn
|
5654
|
-
# The Amazon Resource Name (ARN) of the
|
5655
|
-
#
|
5656
|
-
#
|
5657
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
6747
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
6748
|
+
# Comprehend read access to your input data. For more information, see
|
6749
|
+
# [Role-based permissions][1].
|
5658
6750
|
#
|
5659
6751
|
#
|
5660
6752
|
#
|
5661
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
6753
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
5662
6754
|
# @return [String]
|
5663
6755
|
#
|
5664
6756
|
# @!attribute [rw] job_name
|
@@ -5674,10 +6766,10 @@ module Aws::Comprehend
|
|
5674
6766
|
# @return [String]
|
5675
6767
|
#
|
5676
6768
|
# @!attribute [rw] volume_kms_key_id
|
5677
|
-
# ID for the
|
5678
|
-
# Comprehend uses to encrypt data on the storage volume
|
5679
|
-
# the ML compute instance(s) that process the analysis
|
5680
|
-
# VolumeKmsKeyId can be either of the following formats:
|
6769
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6770
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
6771
|
+
# attached to the ML compute instance(s) that process the analysis
|
6772
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
5681
6773
|
#
|
5682
6774
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
5683
6775
|
#
|
@@ -5696,11 +6788,10 @@ module Aws::Comprehend
|
|
5696
6788
|
# @return [Types::VpcConfig]
|
5697
6789
|
#
|
5698
6790
|
# @!attribute [rw] tags
|
5699
|
-
# Tags to
|
5700
|
-
#
|
5701
|
-
#
|
5702
|
-
#
|
5703
|
-
# department.
|
6791
|
+
# Tags to associate with the dominant language detection job. A tag is
|
6792
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
6793
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
6794
|
+
# added to a resource to indicate its use by the sales department.
|
5704
6795
|
# @return [Array<Types::Tag>]
|
5705
6796
|
#
|
5706
6797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
|
@@ -5726,8 +6817,8 @@ module Aws::Comprehend
|
|
5726
6817
|
# @!attribute [rw] job_arn
|
5727
6818
|
# The Amazon Resource Name (ARN) of the dominant language detection
|
5728
6819
|
# job. It is a unique, fully qualified identifier for the job. It
|
5729
|
-
# includes the
|
5730
|
-
# ARN is as follows:
|
6820
|
+
# includes the Amazon Web Services account, Amazon Web Services
|
6821
|
+
# Region, and the job ID. The format of the ARN is as follows:
|
5731
6822
|
#
|
5732
6823
|
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
5733
6824
|
#
|
@@ -5770,14 +6861,13 @@ module Aws::Comprehend
|
|
5770
6861
|
# @return [Types::OutputDataConfig]
|
5771
6862
|
#
|
5772
6863
|
# @!attribute [rw] data_access_role_arn
|
5773
|
-
# The Amazon Resource Name (ARN) of the
|
5774
|
-
#
|
5775
|
-
#
|
5776
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
6864
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
6865
|
+
# Comprehend read access to your input data. For more information, see
|
6866
|
+
# [Role-based permissions][1].
|
5777
6867
|
#
|
5778
6868
|
#
|
5779
6869
|
#
|
5780
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
6870
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
5781
6871
|
# @return [String]
|
5782
6872
|
#
|
5783
6873
|
# @!attribute [rw] job_name
|
@@ -5807,10 +6897,10 @@ module Aws::Comprehend
|
|
5807
6897
|
# @return [String]
|
5808
6898
|
#
|
5809
6899
|
# @!attribute [rw] volume_kms_key_id
|
5810
|
-
# ID for the
|
5811
|
-
# Comprehend uses to encrypt data on the storage volume
|
5812
|
-
# the ML compute instance(s) that process the analysis
|
5813
|
-
# VolumeKmsKeyId can be either of the following formats:
|
6900
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
6901
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
6902
|
+
# attached to the ML compute instance(s) that process the analysis
|
6903
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
5814
6904
|
#
|
5815
6905
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
5816
6906
|
#
|
@@ -5829,12 +6919,17 @@ module Aws::Comprehend
|
|
5829
6919
|
# @return [Types::VpcConfig]
|
5830
6920
|
#
|
5831
6921
|
# @!attribute [rw] tags
|
5832
|
-
# Tags to
|
6922
|
+
# Tags to associate with the entities detection job. A tag is a
|
5833
6923
|
# key-value pair that adds metadata to a resource used by Amazon
|
5834
6924
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
5835
6925
|
# added to a resource to indicate its use by the sales department.
|
5836
6926
|
# @return [Array<Types::Tag>]
|
5837
6927
|
#
|
6928
|
+
# @!attribute [rw] flywheel_arn
|
6929
|
+
# The Amazon Resource Number (ARN) of the flywheel associated with the
|
6930
|
+
# model to use.
|
6931
|
+
# @return [String]
|
6932
|
+
#
|
5838
6933
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
|
5839
6934
|
#
|
5840
6935
|
class StartEntitiesDetectionJobRequest < Struct.new(
|
@@ -5847,7 +6942,8 @@ module Aws::Comprehend
|
|
5847
6942
|
:client_request_token,
|
5848
6943
|
:volume_kms_key_id,
|
5849
6944
|
:vpc_config,
|
5850
|
-
:tags
|
6945
|
+
:tags,
|
6946
|
+
:flywheel_arn)
|
5851
6947
|
SENSITIVE = []
|
5852
6948
|
include Aws::Structure
|
5853
6949
|
end
|
@@ -5860,8 +6956,8 @@ module Aws::Comprehend
|
|
5860
6956
|
# @!attribute [rw] job_arn
|
5861
6957
|
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
5862
6958
|
# a unique, fully qualified identifier for the job. It includes the
|
5863
|
-
#
|
5864
|
-
# follows:
|
6959
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
6960
|
+
# ID. The format of the ARN is as follows:
|
5865
6961
|
#
|
5866
6962
|
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
5867
6963
|
#
|
@@ -5890,12 +6986,17 @@ module Aws::Comprehend
|
|
5890
6986
|
# * STOPPED - The job was successfully stopped without completing.
|
5891
6987
|
# @return [String]
|
5892
6988
|
#
|
6989
|
+
# @!attribute [rw] entity_recognizer_arn
|
6990
|
+
# The ARN of the custom entity recognition model.
|
6991
|
+
# @return [String]
|
6992
|
+
#
|
5893
6993
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobResponse AWS API Documentation
|
5894
6994
|
#
|
5895
6995
|
class StartEntitiesDetectionJobResponse < Struct.new(
|
5896
6996
|
:job_id,
|
5897
6997
|
:job_arn,
|
5898
|
-
:job_status
|
6998
|
+
:job_status,
|
6999
|
+
:entity_recognizer_arn)
|
5899
7000
|
SENSITIVE = []
|
5900
7001
|
include Aws::Structure
|
5901
7002
|
end
|
@@ -5909,9 +7010,8 @@ module Aws::Comprehend
|
|
5909
7010
|
# @return [Types::OutputDataConfig]
|
5910
7011
|
#
|
5911
7012
|
# @!attribute [rw] data_access_role_arn
|
5912
|
-
# The Amazon Resource Name (ARN) of the
|
5913
|
-
#
|
5914
|
-
# your input data.
|
7013
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7014
|
+
# Comprehend read access to your input data.
|
5915
7015
|
# @return [String]
|
5916
7016
|
#
|
5917
7017
|
# @!attribute [rw] job_name
|
@@ -5935,7 +7035,7 @@ module Aws::Comprehend
|
|
5935
7035
|
# @return [Array<String>]
|
5936
7036
|
#
|
5937
7037
|
# @!attribute [rw] tags
|
5938
|
-
# Tags to
|
7038
|
+
# Tags to associate with the events detection job. A tag is a
|
5939
7039
|
# key-value pair that adds metadata to a resource used by Amazon
|
5940
7040
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
5941
7041
|
# added to a resource to indicate its use by the sales department.
|
@@ -5963,9 +7063,9 @@ module Aws::Comprehend
|
|
5963
7063
|
#
|
5964
7064
|
# @!attribute [rw] job_arn
|
5965
7065
|
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
5966
|
-
# unique, fully qualified identifier for the job. It includes the
|
5967
|
-
# account, Region, and the job
|
5968
|
-
# follows:
|
7066
|
+
# unique, fully qualified identifier for the job. It includes the
|
7067
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
7068
|
+
# ID. The format of the ARN is as follows:
|
5969
7069
|
#
|
5970
7070
|
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
5971
7071
|
#
|
@@ -5988,6 +7088,39 @@ module Aws::Comprehend
|
|
5988
7088
|
include Aws::Structure
|
5989
7089
|
end
|
5990
7090
|
|
7091
|
+
# @!attribute [rw] flywheel_arn
|
7092
|
+
# The ARN of the flywheel.
|
7093
|
+
# @return [String]
|
7094
|
+
#
|
7095
|
+
# @!attribute [rw] client_request_token
|
7096
|
+
# A unique identifier for the request. If you don't set the client
|
7097
|
+
# request token, Amazon Comprehend generates one.
|
7098
|
+
# @return [String]
|
7099
|
+
#
|
7100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIterationRequest AWS API Documentation
|
7101
|
+
#
|
7102
|
+
class StartFlywheelIterationRequest < Struct.new(
|
7103
|
+
:flywheel_arn,
|
7104
|
+
:client_request_token)
|
7105
|
+
SENSITIVE = []
|
7106
|
+
include Aws::Structure
|
7107
|
+
end
|
7108
|
+
|
7109
|
+
# @!attribute [rw] flywheel_arn
|
7110
|
+
# @return [String]
|
7111
|
+
#
|
7112
|
+
# @!attribute [rw] flywheel_iteration_id
|
7113
|
+
# @return [String]
|
7114
|
+
#
|
7115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIterationResponse AWS API Documentation
|
7116
|
+
#
|
7117
|
+
class StartFlywheelIterationResponse < Struct.new(
|
7118
|
+
:flywheel_arn,
|
7119
|
+
:flywheel_iteration_id)
|
7120
|
+
SENSITIVE = []
|
7121
|
+
include Aws::Structure
|
7122
|
+
end
|
7123
|
+
|
5991
7124
|
# @!attribute [rw] input_data_config
|
5992
7125
|
# Specifies the format and location of the input data for the job.
|
5993
7126
|
# @return [Types::InputDataConfig]
|
@@ -5997,14 +7130,13 @@ module Aws::Comprehend
|
|
5997
7130
|
# @return [Types::OutputDataConfig]
|
5998
7131
|
#
|
5999
7132
|
# @!attribute [rw] data_access_role_arn
|
6000
|
-
# The Amazon Resource Name (ARN) of the
|
6001
|
-
#
|
6002
|
-
#
|
6003
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
7133
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7134
|
+
# Comprehend read access to your input data. For more information, see
|
7135
|
+
# [Role-based permissions][1].
|
6004
7136
|
#
|
6005
7137
|
#
|
6006
7138
|
#
|
6007
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
7139
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
6008
7140
|
# @return [String]
|
6009
7141
|
#
|
6010
7142
|
# @!attribute [rw] job_name
|
@@ -6026,10 +7158,10 @@ module Aws::Comprehend
|
|
6026
7158
|
# @return [String]
|
6027
7159
|
#
|
6028
7160
|
# @!attribute [rw] volume_kms_key_id
|
6029
|
-
# ID for the
|
6030
|
-
# Comprehend uses to encrypt data on the storage volume
|
6031
|
-
# the ML compute instance(s) that process the analysis
|
6032
|
-
# VolumeKmsKeyId can be either of the following formats:
|
7161
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
7162
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
7163
|
+
# attached to the ML compute instance(s) that process the analysis
|
7164
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
6033
7165
|
#
|
6034
7166
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
6035
7167
|
#
|
@@ -6048,7 +7180,7 @@ module Aws::Comprehend
|
|
6048
7180
|
# @return [Types::VpcConfig]
|
6049
7181
|
#
|
6050
7182
|
# @!attribute [rw] tags
|
6051
|
-
# Tags to
|
7183
|
+
# Tags to associate with the key phrases detection job. A tag is a
|
6052
7184
|
# key-value pair that adds metadata to a resource used by Amazon
|
6053
7185
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
6054
7186
|
# added to a resource to indicate its use by the sales department.
|
@@ -6078,8 +7210,8 @@ module Aws::Comprehend
|
|
6078
7210
|
# @!attribute [rw] job_arn
|
6079
7211
|
# The Amazon Resource Name (ARN) of the key phrase detection job. It
|
6080
7212
|
# is a unique, fully qualified identifier for the job. It includes the
|
6081
|
-
#
|
6082
|
-
# follows:
|
7213
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
7214
|
+
# ID. The format of the ARN is as follows:
|
6083
7215
|
#
|
6084
7216
|
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
6085
7217
|
#
|
@@ -6136,9 +7268,8 @@ module Aws::Comprehend
|
|
6136
7268
|
# @return [Types::RedactionConfig]
|
6137
7269
|
#
|
6138
7270
|
# @!attribute [rw] data_access_role_arn
|
6139
|
-
# The Amazon Resource Name (ARN) of the
|
6140
|
-
#
|
6141
|
-
# your input data.
|
7271
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7272
|
+
# Comprehend read access to your input data.
|
6142
7273
|
# @return [String]
|
6143
7274
|
#
|
6144
7275
|
# @!attribute [rw] job_name
|
@@ -6159,8 +7290,8 @@ module Aws::Comprehend
|
|
6159
7290
|
# @return [String]
|
6160
7291
|
#
|
6161
7292
|
# @!attribute [rw] tags
|
6162
|
-
# Tags to
|
6163
|
-
#
|
7293
|
+
# Tags to associate with the PII entities detection job. A tag is a
|
7294
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
6164
7295
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
6165
7296
|
# added to a resource to indicate its use by the sales department.
|
6166
7297
|
# @return [Array<Types::Tag>]
|
@@ -6188,8 +7319,8 @@ module Aws::Comprehend
|
|
6188
7319
|
# @!attribute [rw] job_arn
|
6189
7320
|
# The Amazon Resource Name (ARN) of the PII entity detection job. It
|
6190
7321
|
# is a unique, fully qualified identifier for the job. It includes the
|
6191
|
-
#
|
6192
|
-
# follows:
|
7322
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
7323
|
+
# ID. The format of the ARN is as follows:
|
6193
7324
|
#
|
6194
7325
|
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
6195
7326
|
#
|
@@ -6221,14 +7352,13 @@ module Aws::Comprehend
|
|
6221
7352
|
# @return [Types::OutputDataConfig]
|
6222
7353
|
#
|
6223
7354
|
# @!attribute [rw] data_access_role_arn
|
6224
|
-
# The Amazon Resource Name (ARN) of the
|
6225
|
-
#
|
6226
|
-
#
|
6227
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
7355
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7356
|
+
# Comprehend read access to your input data. For more information, see
|
7357
|
+
# [Role-based permissions][1].
|
6228
7358
|
#
|
6229
7359
|
#
|
6230
7360
|
#
|
6231
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
7361
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
6232
7362
|
# @return [String]
|
6233
7363
|
#
|
6234
7364
|
# @!attribute [rw] job_name
|
@@ -6250,10 +7380,10 @@ module Aws::Comprehend
|
|
6250
7380
|
# @return [String]
|
6251
7381
|
#
|
6252
7382
|
# @!attribute [rw] volume_kms_key_id
|
6253
|
-
# ID for the
|
6254
|
-
# Comprehend uses to encrypt data on the storage volume
|
6255
|
-
# the ML compute instance(s) that process the analysis
|
6256
|
-
# VolumeKmsKeyId can be either of the following formats:
|
7383
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
7384
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
7385
|
+
# attached to the ML compute instance(s) that process the analysis
|
7386
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
6257
7387
|
#
|
6258
7388
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
6259
7389
|
#
|
@@ -6272,7 +7402,7 @@ module Aws::Comprehend
|
|
6272
7402
|
# @return [Types::VpcConfig]
|
6273
7403
|
#
|
6274
7404
|
# @!attribute [rw] tags
|
6275
|
-
# Tags to
|
7405
|
+
# Tags to associate with the sentiment detection job. A tag is a
|
6276
7406
|
# key-value pair that adds metadata to a resource used by Amazon
|
6277
7407
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
6278
7408
|
# added to a resource to indicate its use by the sales department.
|
@@ -6302,8 +7432,8 @@ module Aws::Comprehend
|
|
6302
7432
|
# @!attribute [rw] job_arn
|
6303
7433
|
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
6304
7434
|
# a unique, fully qualified identifier for the job. It includes the
|
6305
|
-
#
|
6306
|
-
# follows:
|
7435
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
7436
|
+
# ID. The format of the ARN is as follows:
|
6307
7437
|
#
|
6308
7438
|
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
6309
7439
|
#
|
@@ -6347,10 +7477,9 @@ module Aws::Comprehend
|
|
6347
7477
|
# @return [Types::OutputDataConfig]
|
6348
7478
|
#
|
6349
7479
|
# @!attribute [rw] data_access_role_arn
|
6350
|
-
# The Amazon Resource Name (ARN) of the
|
6351
|
-
#
|
6352
|
-
#
|
6353
|
-
# permissions][1].
|
7480
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7481
|
+
# Comprehend read access to your input data. For more information, see
|
7482
|
+
# [Role-based permissions][1].
|
6354
7483
|
#
|
6355
7484
|
#
|
6356
7485
|
#
|
@@ -6397,11 +7526,10 @@ module Aws::Comprehend
|
|
6397
7526
|
# @return [Types::VpcConfig]
|
6398
7527
|
#
|
6399
7528
|
# @!attribute [rw] tags
|
6400
|
-
# Tags to
|
6401
|
-
#
|
6402
|
-
#
|
6403
|
-
#
|
6404
|
-
# department.
|
7529
|
+
# Tags to associate with the targeted sentiment detection job. A tag
|
7530
|
+
# is a key-value pair that adds metadata to a resource used by Amazon
|
7531
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
7532
|
+
# added to a resource to indicate its use by the sales department.
|
6405
7533
|
# @return [Array<Types::Tag>]
|
6406
7534
|
#
|
6407
7535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobRequest AWS API Documentation
|
@@ -6422,14 +7550,15 @@ module Aws::Comprehend
|
|
6422
7550
|
|
6423
7551
|
# @!attribute [rw] job_id
|
6424
7552
|
# The identifier generated for the job. To get the status of a job,
|
6425
|
-
# use this identifier with the
|
7553
|
+
# use this identifier with the `DescribeTargetedSentimentDetectionJob`
|
7554
|
+
# operation.
|
6426
7555
|
# @return [String]
|
6427
7556
|
#
|
6428
7557
|
# @!attribute [rw] job_arn
|
6429
7558
|
# The Amazon Resource Name (ARN) of the targeted sentiment detection
|
6430
7559
|
# job. It is a unique, fully qualified identifier for the job. It
|
6431
|
-
# includes the
|
6432
|
-
# ARN is as follows:
|
7560
|
+
# includes the Amazon Web Services account, Amazon Web Services
|
7561
|
+
# Region, and the job ID. The format of the ARN is as follows:
|
6433
7562
|
#
|
6434
7563
|
# `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
|
6435
7564
|
#
|
@@ -6450,7 +7579,7 @@ module Aws::Comprehend
|
|
6450
7579
|
# available.
|
6451
7580
|
#
|
6452
7581
|
# * FAILED - The job did not complete. To get details, use the
|
6453
|
-
# operation.
|
7582
|
+
# `DescribeTargetedSentimentDetectionJob` operation.
|
6454
7583
|
# @return [String]
|
6455
7584
|
#
|
6456
7585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobResponse AWS API Documentation
|
@@ -6475,14 +7604,13 @@ module Aws::Comprehend
|
|
6475
7604
|
# @return [Types::OutputDataConfig]
|
6476
7605
|
#
|
6477
7606
|
# @!attribute [rw] data_access_role_arn
|
6478
|
-
# The Amazon Resource Name (ARN) of the
|
6479
|
-
#
|
6480
|
-
#
|
6481
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
7607
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
7608
|
+
# Comprehend read access to your input data. For more information, see
|
7609
|
+
# [Role-based permissions][1].
|
6482
7610
|
#
|
6483
7611
|
#
|
6484
7612
|
#
|
6485
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
7613
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
6486
7614
|
# @return [String]
|
6487
7615
|
#
|
6488
7616
|
# @!attribute [rw] job_name
|
@@ -6502,10 +7630,10 @@ module Aws::Comprehend
|
|
6502
7630
|
# @return [String]
|
6503
7631
|
#
|
6504
7632
|
# @!attribute [rw] volume_kms_key_id
|
6505
|
-
# ID for the
|
6506
|
-
# Comprehend uses to encrypt data on the storage volume
|
6507
|
-
# the ML compute instance(s) that process the analysis
|
6508
|
-
# VolumeKmsKeyId can be either of the following formats:
|
7633
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
7634
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
7635
|
+
# attached to the ML compute instance(s) that process the analysis
|
7636
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
6509
7637
|
#
|
6510
7638
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
6511
7639
|
#
|
@@ -6524,7 +7652,7 @@ module Aws::Comprehend
|
|
6524
7652
|
# @return [Types::VpcConfig]
|
6525
7653
|
#
|
6526
7654
|
# @!attribute [rw] tags
|
6527
|
-
# Tags to
|
7655
|
+
# Tags to associate with the topics detection job. A tag is a
|
6528
7656
|
# key-value pair that adds metadata to a resource used by Amazon
|
6529
7657
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
6530
7658
|
# added to a resource to indicate its use by the sales department.
|
@@ -6553,9 +7681,9 @@ module Aws::Comprehend
|
|
6553
7681
|
#
|
6554
7682
|
# @!attribute [rw] job_arn
|
6555
7683
|
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6556
|
-
# unique, fully qualified identifier for the job. It includes the
|
6557
|
-
# account, Region, and the job
|
6558
|
-
# follows:
|
7684
|
+
# unique, fully qualified identifier for the job. It includes the
|
7685
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
7686
|
+
# ID. The format of the ARN is as follows:
|
6559
7687
|
#
|
6560
7688
|
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6561
7689
|
#
|
@@ -6936,7 +8064,8 @@ module Aws::Comprehend
|
|
6936
8064
|
class TagResourceResponse < Aws::EmptyStructure; end
|
6937
8065
|
|
6938
8066
|
# Provides information for filtering a list of dominant language
|
6939
|
-
# detection jobs. For more information, see the
|
8067
|
+
# detection jobs. For more information, see the
|
8068
|
+
# `ListTargetedSentimentDetectionJobs` operation.
|
6940
8069
|
#
|
6941
8070
|
# @!attribute [rw] job_name
|
6942
8071
|
# Filters on the name of the job.
|
@@ -6981,8 +8110,8 @@ module Aws::Comprehend
|
|
6981
8110
|
# @!attribute [rw] job_arn
|
6982
8111
|
# The Amazon Resource Name (ARN) of the targeted sentiment detection
|
6983
8112
|
# job. It is a unique, fully qualified identifier for the job. It
|
6984
|
-
# includes the
|
6985
|
-
# ARN is as follows:
|
8113
|
+
# includes the Amazon Web Services account, Amazon Web Services
|
8114
|
+
# Region, and the job ID. The format of the ARN is as follows:
|
6986
8115
|
#
|
6987
8116
|
# `arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>`
|
6988
8117
|
#
|
@@ -7028,16 +8157,15 @@ module Aws::Comprehend
|
|
7028
8157
|
# @return [String]
|
7029
8158
|
#
|
7030
8159
|
# @!attribute [rw] data_access_role_arn
|
7031
|
-
# The Amazon Resource Name (ARN) that
|
7032
|
-
# access to your input data.
|
8160
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
8161
|
+
# Comprehend read access to your input data.
|
7033
8162
|
# @return [String]
|
7034
8163
|
#
|
7035
8164
|
# @!attribute [rw] volume_kms_key_id
|
7036
|
-
# ID for the
|
7037
|
-
#
|
7038
|
-
# the
|
7039
|
-
#
|
7040
|
-
# formats:
|
8165
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt the data
|
8166
|
+
# on the storage volume attached to the ML compute instance(s) that
|
8167
|
+
# process the targeted sentiment detection job. The VolumeKmsKeyId can
|
8168
|
+
# be either of the following formats:
|
7041
8169
|
#
|
7042
8170
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
7043
8171
|
#
|
@@ -7169,6 +8297,31 @@ module Aws::Comprehend
|
|
7169
8297
|
include Aws::Structure
|
7170
8298
|
end
|
7171
8299
|
|
8300
|
+
# Configuration about the custom classifier associated with the
|
8301
|
+
# flywheel.
|
8302
|
+
#
|
8303
|
+
# @!attribute [rw] language_code
|
8304
|
+
# Language code for the language that the model supports.
|
8305
|
+
# @return [String]
|
8306
|
+
#
|
8307
|
+
# @!attribute [rw] document_classification_config
|
8308
|
+
# Configuration required for a classification model.
|
8309
|
+
# @return [Types::DocumentClassificationConfig]
|
8310
|
+
#
|
8311
|
+
# @!attribute [rw] entity_recognition_config
|
8312
|
+
# Configuration required for an entity recognition model.
|
8313
|
+
# @return [Types::EntityRecognitionConfig]
|
8314
|
+
#
|
8315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TaskConfig AWS API Documentation
|
8316
|
+
#
|
8317
|
+
class TaskConfig < Struct.new(
|
8318
|
+
:language_code,
|
8319
|
+
:document_classification_config,
|
8320
|
+
:entity_recognition_config)
|
8321
|
+
SENSITIVE = []
|
8322
|
+
include Aws::Structure
|
8323
|
+
end
|
8324
|
+
|
7172
8325
|
# The size of the input text exceeds the limit. Use a smaller document.
|
7173
8326
|
#
|
7174
8327
|
# @!attribute [rw] message
|
@@ -7268,9 +8421,9 @@ module Aws::Comprehend
|
|
7268
8421
|
#
|
7269
8422
|
# @!attribute [rw] job_arn
|
7270
8423
|
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
7271
|
-
# unique, fully qualified identifier for the job. It includes the
|
7272
|
-
# account, Region, and the job
|
7273
|
-
# follows:
|
8424
|
+
# unique, fully qualified identifier for the job. It includes the
|
8425
|
+
# Amazon Web Services account, Amazon Web Services Region, and the job
|
8426
|
+
# ID. The format of the ARN is as follows:
|
7274
8427
|
#
|
7275
8428
|
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
7276
8429
|
#
|
@@ -7317,16 +8470,15 @@ module Aws::Comprehend
|
|
7317
8470
|
# @return [Integer]
|
7318
8471
|
#
|
7319
8472
|
# @!attribute [rw] data_access_role_arn
|
7320
|
-
# The Amazon Resource Name (ARN) of the
|
7321
|
-
#
|
7322
|
-
# data.
|
8473
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
8474
|
+
# Comprehend read access to your job data.
|
7323
8475
|
# @return [String]
|
7324
8476
|
#
|
7325
8477
|
# @!attribute [rw] volume_kms_key_id
|
7326
|
-
# ID for the
|
7327
|
-
# Comprehend uses to encrypt data on the storage volume
|
7328
|
-
# the ML compute instance(s) that process the analysis
|
7329
|
-
# VolumeKmsKeyId can be either of the following formats:
|
8478
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
8479
|
+
# Amazon Comprehend uses to encrypt data on the storage volume
|
8480
|
+
# attached to the ML compute instance(s) that process the analysis
|
8481
|
+
# job. The VolumeKmsKeyId can be either of the following formats:
|
7330
8482
|
#
|
7331
8483
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
7332
8484
|
#
|
@@ -7410,6 +8562,44 @@ module Aws::Comprehend
|
|
7410
8562
|
#
|
7411
8563
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
7412
8564
|
|
8565
|
+
# Data security configuration.
|
8566
|
+
#
|
8567
|
+
# @!attribute [rw] model_kms_key_id
|
8568
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
8569
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
8570
|
+
# formats:
|
8571
|
+
#
|
8572
|
+
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
8573
|
+
#
|
8574
|
+
# * Amazon Resource Name (ARN) of a KMS Key:
|
8575
|
+
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
8576
|
+
# @return [String]
|
8577
|
+
#
|
8578
|
+
# @!attribute [rw] volume_kms_key_id
|
8579
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt the
|
8580
|
+
# volume.
|
8581
|
+
# @return [String]
|
8582
|
+
#
|
8583
|
+
# @!attribute [rw] vpc_config
|
8584
|
+
# Configuration parameters for an optional private Virtual Private
|
8585
|
+
# Cloud (VPC) containing the resources you are using for the job. For
|
8586
|
+
# more information, see [Amazon VPC][1].
|
8587
|
+
#
|
8588
|
+
#
|
8589
|
+
#
|
8590
|
+
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
8591
|
+
# @return [Types::VpcConfig]
|
8592
|
+
#
|
8593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateDataSecurityConfig AWS API Documentation
|
8594
|
+
#
|
8595
|
+
class UpdateDataSecurityConfig < Struct.new(
|
8596
|
+
:model_kms_key_id,
|
8597
|
+
:volume_kms_key_id,
|
8598
|
+
:vpc_config)
|
8599
|
+
SENSITIVE = []
|
8600
|
+
include Aws::Structure
|
8601
|
+
end
|
8602
|
+
|
7413
8603
|
# @!attribute [rw] endpoint_arn
|
7414
8604
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
7415
8605
|
# @return [String]
|
@@ -7429,20 +8619,73 @@ module Aws::Comprehend
|
|
7429
8619
|
# a customer CMK.
|
7430
8620
|
# @return [String]
|
7431
8621
|
#
|
8622
|
+
# @!attribute [rw] flywheel_arn
|
8623
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
8624
|
+
# @return [String]
|
8625
|
+
#
|
7432
8626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointRequest AWS API Documentation
|
7433
8627
|
#
|
7434
8628
|
class UpdateEndpointRequest < Struct.new(
|
7435
8629
|
:endpoint_arn,
|
7436
8630
|
:desired_model_arn,
|
7437
8631
|
:desired_inference_units,
|
7438
|
-
:desired_data_access_role_arn
|
8632
|
+
:desired_data_access_role_arn,
|
8633
|
+
:flywheel_arn)
|
7439
8634
|
SENSITIVE = []
|
7440
8635
|
include Aws::Structure
|
7441
8636
|
end
|
7442
8637
|
|
8638
|
+
# @!attribute [rw] desired_model_arn
|
8639
|
+
# The Amazon Resource Number (ARN) of the new model.
|
8640
|
+
# @return [String]
|
8641
|
+
#
|
7443
8642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointResponse AWS API Documentation
|
7444
8643
|
#
|
7445
|
-
class UpdateEndpointResponse <
|
8644
|
+
class UpdateEndpointResponse < Struct.new(
|
8645
|
+
:desired_model_arn)
|
8646
|
+
SENSITIVE = []
|
8647
|
+
include Aws::Structure
|
8648
|
+
end
|
8649
|
+
|
8650
|
+
# @!attribute [rw] flywheel_arn
|
8651
|
+
# The Amazon Resource Number (ARN) of the flywheel to update.
|
8652
|
+
# @return [String]
|
8653
|
+
#
|
8654
|
+
# @!attribute [rw] active_model_arn
|
8655
|
+
# The Amazon Resource Number (ARN) of the active model version.
|
8656
|
+
# @return [String]
|
8657
|
+
#
|
8658
|
+
# @!attribute [rw] data_access_role_arn
|
8659
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
8660
|
+
# Comprehend permission to access the flywheel data.
|
8661
|
+
# @return [String]
|
8662
|
+
#
|
8663
|
+
# @!attribute [rw] data_security_config
|
8664
|
+
# Flywheel data security configuration.
|
8665
|
+
# @return [Types::UpdateDataSecurityConfig]
|
8666
|
+
#
|
8667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheelRequest AWS API Documentation
|
8668
|
+
#
|
8669
|
+
class UpdateFlywheelRequest < Struct.new(
|
8670
|
+
:flywheel_arn,
|
8671
|
+
:active_model_arn,
|
8672
|
+
:data_access_role_arn,
|
8673
|
+
:data_security_config)
|
8674
|
+
SENSITIVE = []
|
8675
|
+
include Aws::Structure
|
8676
|
+
end
|
8677
|
+
|
8678
|
+
# @!attribute [rw] flywheel_properties
|
8679
|
+
# The flywheel properties.
|
8680
|
+
# @return [Types::FlywheelProperties]
|
8681
|
+
#
|
8682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheelResponse AWS API Documentation
|
8683
|
+
#
|
8684
|
+
class UpdateFlywheelResponse < Struct.new(
|
8685
|
+
:flywheel_properties)
|
8686
|
+
SENSITIVE = []
|
8687
|
+
include Aws::Structure
|
8688
|
+
end
|
7446
8689
|
|
7447
8690
|
# Configuration parameters for an optional private Virtual Private Cloud
|
7448
8691
|
# (VPC) containing the resources you are using for the job. For more
|
@@ -7469,7 +8712,7 @@ module Aws::Comprehend
|
|
7469
8712
|
# @!attribute [rw] subnets
|
7470
8713
|
# The ID for each subnet being used in your private VPC. This subnet
|
7471
8714
|
# is a subset of the a range of IPv4 addresses used by the VPC and is
|
7472
|
-
# specific to a given availability zone in the VPC’s
|
8715
|
+
# specific to a given availability zone in the VPC’s Region. This ID
|
7473
8716
|
# number is preceded by "subnet-", for instance:
|
7474
8717
|
# "subnet-04ccf456919e69055". For more information, see [VPCs and
|
7475
8718
|
# Subnets][1].
|