aws-sdk-comprehend 1.64.0 → 1.66.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -919,6 +919,68 @@ module Aws::Comprehend
919
919
  include Aws::Structure
920
920
  end
921
921
 
922
+ # @!attribute [rw] flywheel_arn
923
+ # The Amazon Resource Number (ARN) of the flywheel of the flywheel to
924
+ # receive the data.
925
+ # @return [String]
926
+ #
927
+ # @!attribute [rw] dataset_name
928
+ # Name of the dataset.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] dataset_type
932
+ # The dataset type. You can specify that the data in a dataset is for
933
+ # training the model or for testing the model.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] description
937
+ # Description of the dataset.
938
+ # @return [String]
939
+ #
940
+ # @!attribute [rw] input_data_config
941
+ # Information about the input data configuration. The type of input
942
+ # data varies based on the format of the input and whether the data is
943
+ # for a classifier model or an entity recognition model.
944
+ # @return [Types::DatasetInputDataConfig]
945
+ #
946
+ # @!attribute [rw] client_request_token
947
+ # A unique identifier for the request. If you don't set the client
948
+ # request token, Amazon Comprehend generates one.
949
+ #
950
+ # **A suitable default value is auto-generated.** You should normally
951
+ # not need to pass this option.
952
+ # @return [String]
953
+ #
954
+ # @!attribute [rw] tags
955
+ # Tags for the dataset.
956
+ # @return [Array<Types::Tag>]
957
+ #
958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDatasetRequest AWS API Documentation
959
+ #
960
+ class CreateDatasetRequest < Struct.new(
961
+ :flywheel_arn,
962
+ :dataset_name,
963
+ :dataset_type,
964
+ :description,
965
+ :input_data_config,
966
+ :client_request_token,
967
+ :tags)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # @!attribute [rw] dataset_arn
973
+ # The ARN of the dataset.
974
+ # @return [String]
975
+ #
976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDatasetResponse AWS API Documentation
977
+ #
978
+ class CreateDatasetResponse < Struct.new(
979
+ :dataset_arn)
980
+ SENSITIVE = []
981
+ include Aws::Structure
982
+ end
983
+
922
984
  # @!attribute [rw] document_classifier_name
923
985
  # The name of the document classifier.
924
986
  # @return [String]
@@ -932,17 +994,16 @@ module Aws::Comprehend
932
994
  # @return [String]
933
995
  #
934
996
  # @!attribute [rw] data_access_role_arn
935
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
936
- # (IAM) role that grants Amazon Comprehend read access to your input
937
- # data.
997
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
998
+ # Management (IAM) role that grants Amazon Comprehend read access to
999
+ # your input data.
938
1000
  # @return [String]
939
1001
  #
940
1002
  # @!attribute [rw] tags
941
- # Tags to be associated with the document classifier being created. A
942
- # tag is a key-value pair that adds as a metadata to a resource used
943
- # by Amazon Comprehend. For example, a tag with "Sales" as the key
944
- # might be added to a resource to indicate its use by the sales
945
- # department.
1003
+ # Tags to associate with the document classifier. A tag is a key-value
1004
+ # pair that adds as a metadata to a resource used by Amazon
1005
+ # Comprehend. For example, a tag with "Sales" as the key might be
1006
+ # added to a resource to indicate its use by the sales department.
946
1007
  # @return [Array<Types::Tag>]
947
1008
  #
948
1009
  # @!attribute [rw] input_data_config
@@ -964,10 +1025,8 @@ module Aws::Comprehend
964
1025
  #
965
1026
  # @!attribute [rw] language_code
966
1027
  # The language of the input documents. You can specify any of the
967
- # following languages supported by Amazon Comprehend: German ("de"),
968
- # English ("en"), Spanish ("es"), French ("fr"), Italian
969
- # ("it"), or Portuguese ("pt"). All documents must be in the same
970
- # language.
1028
+ # languages supported by Amazon Comprehend. All documents must be in
1029
+ # the same language.
971
1030
  # @return [String]
972
1031
  #
973
1032
  # @!attribute [rw] volume_kms_key_id
@@ -1090,19 +1149,24 @@ module Aws::Comprehend
1090
1149
  # @return [String]
1091
1150
  #
1092
1151
  # @!attribute [rw] tags
1093
- # Tags associated with the endpoint being created. A tag is a
1094
- # key-value pair that adds metadata to the endpoint. For example, a
1095
- # tag with "Sales" as the key might be added to an endpoint to
1096
- # indicate its use by the sales department.
1152
+ # Tags to associate with the endpoint. A tag is a key-value pair that
1153
+ # adds metadata to the endpoint. For example, a tag with "Sales" as
1154
+ # the key might be added to an endpoint to indicate its use by the
1155
+ # sales department.
1097
1156
  # @return [Array<Types::Tag>]
1098
1157
  #
1099
1158
  # @!attribute [rw] data_access_role_arn
1100
- # The Amazon Resource Name (ARN) of the AWS identity and Access
1159
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1101
1160
  # Management (IAM) role that grants Amazon Comprehend read access to
1102
1161
  # trained custom models encrypted with a customer managed key
1103
1162
  # (ModelKmsKeyId).
1104
1163
  # @return [String]
1105
1164
  #
1165
+ # @!attribute [rw] flywheel_arn
1166
+ # The Amazon Resource Number (ARN) of the flywheel to which the
1167
+ # endpoint will be attached.
1168
+ # @return [String]
1169
+ #
1106
1170
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
1107
1171
  #
1108
1172
  class CreateEndpointRequest < Struct.new(
@@ -1111,7 +1175,8 @@ module Aws::Comprehend
1111
1175
  :desired_inference_units,
1112
1176
  :client_request_token,
1113
1177
  :tags,
1114
- :data_access_role_arn)
1178
+ :data_access_role_arn,
1179
+ :flywheel_arn)
1115
1180
  SENSITIVE = []
1116
1181
  include Aws::Structure
1117
1182
  end
@@ -1120,10 +1185,16 @@ module Aws::Comprehend
1120
1185
  # The Amazon Resource Number (ARN) of the endpoint being created.
1121
1186
  # @return [String]
1122
1187
  #
1188
+ # @!attribute [rw] model_arn
1189
+ # The Amazon Resource Number (ARN) of the model to which the endpoint
1190
+ # is attached.
1191
+ # @return [String]
1192
+ #
1123
1193
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointResponse AWS API Documentation
1124
1194
  #
1125
1195
  class CreateEndpointResponse < Struct.new(
1126
- :endpoint_arn)
1196
+ :endpoint_arn,
1197
+ :model_arn)
1127
1198
  SENSITIVE = []
1128
1199
  include Aws::Structure
1129
1200
  end
@@ -1144,17 +1215,16 @@ module Aws::Comprehend
1144
1215
  # @return [String]
1145
1216
  #
1146
1217
  # @!attribute [rw] data_access_role_arn
1147
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
1148
- # (IAM) role that grants Amazon Comprehend read access to your input
1149
- # data.
1218
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1219
+ # Management (IAM) role that grants Amazon Comprehend read access to
1220
+ # your input data.
1150
1221
  # @return [String]
1151
1222
  #
1152
1223
  # @!attribute [rw] tags
1153
- # Tags to be associated with the entity recognizer being created. A
1154
- # tag is a key-value pair that adds as a metadata to a resource used
1155
- # by Amazon Comprehend. For example, a tag with "Sales" as the key
1156
- # might be added to a resource to indicate its use by the sales
1157
- # department.
1224
+ # Tags to associate with the entity recognizer. A tag is a key-value
1225
+ # pair that adds as a metadata to a resource used by Amazon
1226
+ # Comprehend. For example, a tag with "Sales" as the key might be
1227
+ # added to a resource to indicate its use by the sales department.
1158
1228
  # @return [Array<Types::Tag>]
1159
1229
  #
1160
1230
  # @!attribute [rw] input_data_config
@@ -1205,7 +1275,7 @@ module Aws::Comprehend
1205
1275
  # @!attribute [rw] model_kms_key_id
1206
1276
  # ID for the AWS Key Management Service (KMS) key that Amazon
1207
1277
  # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1208
- # can be either of the following formats
1278
+ # can be either of the following formats:
1209
1279
  #
1210
1280
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1211
1281
  #
@@ -1263,6 +1333,454 @@ module Aws::Comprehend
1263
1333
  include Aws::Structure
1264
1334
  end
1265
1335
 
1336
+ # @!attribute [rw] flywheel_name
1337
+ # Name for the flywheel.
1338
+ # @return [String]
1339
+ #
1340
+ # @!attribute [rw] active_model_arn
1341
+ # To associate an existing model with the flywheel, specify the Amazon
1342
+ # Resource Number (ARN) of the model version.
1343
+ # @return [String]
1344
+ #
1345
+ # @!attribute [rw] data_access_role_arn
1346
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1347
+ # Management (IAM) role that grants Amazon Comprehend the permissions
1348
+ # required to access the flywheel data in the data lake.
1349
+ # @return [String]
1350
+ #
1351
+ # @!attribute [rw] task_config
1352
+ # Configuration about the custom classifier associated with the
1353
+ # flywheel.
1354
+ # @return [Types::TaskConfig]
1355
+ #
1356
+ # @!attribute [rw] model_type
1357
+ # The model type.
1358
+ # @return [String]
1359
+ #
1360
+ # @!attribute [rw] data_lake_s3_uri
1361
+ # Enter the S3 location for the data lake. You can specify a new S3
1362
+ # bucket or a new folder of an existing S3 bucket. The flywheel
1363
+ # creates the data lake at this location.
1364
+ # @return [String]
1365
+ #
1366
+ # @!attribute [rw] data_security_config
1367
+ # Data security configurations.
1368
+ # @return [Types::DataSecurityConfig]
1369
+ #
1370
+ # @!attribute [rw] client_request_token
1371
+ # A unique identifier for the request. If you don't set the client
1372
+ # request token, Amazon Comprehend generates one.
1373
+ #
1374
+ # **A suitable default value is auto-generated.** You should normally
1375
+ # not need to pass this option.
1376
+ # @return [String]
1377
+ #
1378
+ # @!attribute [rw] tags
1379
+ # The tags to associate with this flywheel.
1380
+ # @return [Array<Types::Tag>]
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheelRequest AWS API Documentation
1383
+ #
1384
+ class CreateFlywheelRequest < Struct.new(
1385
+ :flywheel_name,
1386
+ :active_model_arn,
1387
+ :data_access_role_arn,
1388
+ :task_config,
1389
+ :model_type,
1390
+ :data_lake_s3_uri,
1391
+ :data_security_config,
1392
+ :client_request_token,
1393
+ :tags)
1394
+ SENSITIVE = []
1395
+ include Aws::Structure
1396
+ end
1397
+
1398
+ # @!attribute [rw] flywheel_arn
1399
+ # The Amazon Resource Number (ARN) of the flywheel.
1400
+ # @return [String]
1401
+ #
1402
+ # @!attribute [rw] active_model_arn
1403
+ # The Amazon Resource Number (ARN) of the active model version.
1404
+ # @return [String]
1405
+ #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheelResponse AWS API Documentation
1407
+ #
1408
+ class CreateFlywheelResponse < Struct.new(
1409
+ :flywheel_arn,
1410
+ :active_model_arn)
1411
+ SENSITIVE = []
1412
+ include Aws::Structure
1413
+ end
1414
+
1415
+ # Data security configuration.
1416
+ #
1417
+ # @!attribute [rw] model_kms_key_id
1418
+ # ID for the AWS Key Management Service (KMS) key that Amazon
1419
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
1420
+ # can be either of the following formats:
1421
+ #
1422
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1423
+ #
1424
+ # * Amazon Resource Name (ARN) of a KMS Key:
1425
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] volume_kms_key_id
1429
+ # ID for the KMS key that Amazon Comprehend uses to encrypt the
1430
+ # volume.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] data_lake_kms_key_id
1434
+ # ID for the KMS key that Amazon Comprehend uses to encrypt the data
1435
+ # in the data lake.
1436
+ # @return [String]
1437
+ #
1438
+ # @!attribute [rw] vpc_config
1439
+ # Configuration parameters for an optional private Virtual Private
1440
+ # Cloud (VPC) containing the resources you are using for the job. For
1441
+ # more information, see [Amazon VPC][1].
1442
+ #
1443
+ #
1444
+ #
1445
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
1446
+ # @return [Types::VpcConfig]
1447
+ #
1448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DataSecurityConfig AWS API Documentation
1449
+ #
1450
+ class DataSecurityConfig < Struct.new(
1451
+ :model_kms_key_id,
1452
+ :volume_kms_key_id,
1453
+ :data_lake_kms_key_id,
1454
+ :vpc_config)
1455
+ SENSITIVE = []
1456
+ include Aws::Structure
1457
+ end
1458
+
1459
+ # An augmented manifest file that provides training data for your custom
1460
+ # model. An augmented manifest file is a labeled dataset that is
1461
+ # produced by Amazon SageMaker Ground Truth.
1462
+ #
1463
+ # @!attribute [rw] attribute_names
1464
+ # The JSON attribute that contains the annotations for your training
1465
+ # documents. The number of attribute names that you specify depends on
1466
+ # whether your augmented manifest file is the output of a single
1467
+ # labeling job or a chained labeling job.
1468
+ #
1469
+ # If your file is the output of a single labeling job, specify the
1470
+ # LabelAttributeName key that was used when the job was created in
1471
+ # Ground Truth.
1472
+ #
1473
+ # If your file is the output of a chained labeling job, specify the
1474
+ # LabelAttributeName key for one or more jobs in the chain. Each
1475
+ # LabelAttributeName key provides the annotations from an individual
1476
+ # job.
1477
+ # @return [Array<String>]
1478
+ #
1479
+ # @!attribute [rw] s3_uri
1480
+ # The Amazon S3 location of the augmented manifest file.
1481
+ # @return [String]
1482
+ #
1483
+ # @!attribute [rw] annotation_data_s3_uri
1484
+ # The S3 prefix to the annotation files that are referred in the
1485
+ # augmented manifest file.
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] source_documents_s3_uri
1489
+ # The S3 prefix to the source files (PDFs) that are referred to in the
1490
+ # augmented manifest file.
1491
+ # @return [String]
1492
+ #
1493
+ # @!attribute [rw] document_type
1494
+ # The type of augmented manifest. If you don't specify, the default
1495
+ # is PlainTextDocument.
1496
+ #
1497
+ # `PLAIN_TEXT_DOCUMENT` A document type that represents any unicode
1498
+ # text that is encoded in UTF-8.
1499
+ # @return [String]
1500
+ #
1501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetAugmentedManifestsListItem AWS API Documentation
1502
+ #
1503
+ class DatasetAugmentedManifestsListItem < Struct.new(
1504
+ :attribute_names,
1505
+ :s3_uri,
1506
+ :annotation_data_s3_uri,
1507
+ :source_documents_s3_uri,
1508
+ :document_type)
1509
+ SENSITIVE = []
1510
+ include Aws::Structure
1511
+ end
1512
+
1513
+ # Describes the dataset input data configuration for a document
1514
+ # classifier model.
1515
+ #
1516
+ # For more information on how the input file is formatted, see
1517
+ # [Preparing training data][1] in the Comprehend Developer Guide.
1518
+ #
1519
+ #
1520
+ #
1521
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
1522
+ #
1523
+ # @!attribute [rw] s3_uri
1524
+ # The Amazon S3 URI for the input data. The S3 bucket must be in the
1525
+ # same region as the API endpoint that you are calling. The URI can
1526
+ # point to a single input file or it can provide the prefix for a
1527
+ # collection of input files.
1528
+ #
1529
+ # For example, if you use the URI `S3://bucketName/prefix`, if the
1530
+ # prefix is a single file, Amazon Comprehend uses that file as input.
1531
+ # If more than one file begins with the prefix, Amazon Comprehend uses
1532
+ # all of them as input.
1533
+ #
1534
+ # This parameter is required if you set `DataFormat` to
1535
+ # `COMPREHEND_CSV`.
1536
+ # @return [String]
1537
+ #
1538
+ # @!attribute [rw] label_delimiter
1539
+ # Indicates the delimiter used to separate each label for training a
1540
+ # multi-label classifier. The default delimiter between labels is a
1541
+ # pipe (\|). You can use a different character as a delimiter (if
1542
+ # it's an allowed character) by specifying it under Delimiter for
1543
+ # labels. If the training documents use a delimiter other than the
1544
+ # default or the delimiter you specify, the labels on that line will
1545
+ # be combined to make a single unique label, such as LABELLABELLABEL.
1546
+ # @return [String]
1547
+ #
1548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetDocumentClassifierInputDataConfig AWS API Documentation
1549
+ #
1550
+ class DatasetDocumentClassifierInputDataConfig < Struct.new(
1551
+ :s3_uri,
1552
+ :label_delimiter)
1553
+ SENSITIVE = []
1554
+ include Aws::Structure
1555
+ end
1556
+
1557
+ # Describes the annotations associated with a entity recognizer.
1558
+ #
1559
+ # @!attribute [rw] s3_uri
1560
+ # Specifies the Amazon S3 location where the training documents for an
1561
+ # entity recognizer are located. The URI must be in the same region as
1562
+ # the API endpoint that you are calling.
1563
+ # @return [String]
1564
+ #
1565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerAnnotations AWS API Documentation
1566
+ #
1567
+ class DatasetEntityRecognizerAnnotations < Struct.new(
1568
+ :s3_uri)
1569
+ SENSITIVE = []
1570
+ include Aws::Structure
1571
+ end
1572
+
1573
+ # Describes the documents submitted with a dataset for an entity
1574
+ # recognizer model.
1575
+ #
1576
+ # @!attribute [rw] s3_uri
1577
+ # Specifies the Amazon S3 location where the documents for the dataset
1578
+ # are located.
1579
+ # @return [String]
1580
+ #
1581
+ # @!attribute [rw] input_format
1582
+ # Specifies how the text in an input file should be processed. This is
1583
+ # optional, and the default is ONE\_DOC\_PER\_LINE.
1584
+ # ONE\_DOC\_PER\_FILE - Each file is considered a separate document.
1585
+ # Use this option when you are processing large documents, such as
1586
+ # newspaper articles or scientific papers. ONE\_DOC\_PER\_LINE - Each
1587
+ # line in a file is considered a separate document. Use this option
1588
+ # when you are processing many short documents, such as text messages.
1589
+ # @return [String]
1590
+ #
1591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerDocuments AWS API Documentation
1592
+ #
1593
+ class DatasetEntityRecognizerDocuments < Struct.new(
1594
+ :s3_uri,
1595
+ :input_format)
1596
+ SENSITIVE = []
1597
+ include Aws::Structure
1598
+ end
1599
+
1600
+ # Describes the dataset entity list for an entity recognizer model.
1601
+ #
1602
+ # For more information on how the input file is formatted, see
1603
+ # [Preparing training data][1] in the Comprehend Developer Guide.
1604
+ #
1605
+ #
1606
+ #
1607
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html
1608
+ #
1609
+ # @!attribute [rw] s3_uri
1610
+ # Specifies the Amazon S3 location where the entity list is located.
1611
+ # @return [String]
1612
+ #
1613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerEntityList AWS API Documentation
1614
+ #
1615
+ class DatasetEntityRecognizerEntityList < Struct.new(
1616
+ :s3_uri)
1617
+ SENSITIVE = []
1618
+ include Aws::Structure
1619
+ end
1620
+
1621
+ # Specifies the format and location of the input data. You must provide
1622
+ # either the `Annotations` parameter or the `EntityList` parameter.
1623
+ #
1624
+ # @!attribute [rw] annotations
1625
+ # The S3 location of the annotation documents for your custom entity
1626
+ # recognizer.
1627
+ # @return [Types::DatasetEntityRecognizerAnnotations]
1628
+ #
1629
+ # @!attribute [rw] documents
1630
+ # The format and location of the training documents for your custom
1631
+ # entity recognizer.
1632
+ # @return [Types::DatasetEntityRecognizerDocuments]
1633
+ #
1634
+ # @!attribute [rw] entity_list
1635
+ # The S3 location of the entity list for your custom entity
1636
+ # recognizer.
1637
+ # @return [Types::DatasetEntityRecognizerEntityList]
1638
+ #
1639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetEntityRecognizerInputDataConfig AWS API Documentation
1640
+ #
1641
+ class DatasetEntityRecognizerInputDataConfig < Struct.new(
1642
+ :annotations,
1643
+ :documents,
1644
+ :entity_list)
1645
+ SENSITIVE = []
1646
+ include Aws::Structure
1647
+ end
1648
+
1649
+ # Filter the datasets based on creation time or dataset status.
1650
+ #
1651
+ # @!attribute [rw] status
1652
+ # Filter the datasets based on the dataset status.
1653
+ # @return [String]
1654
+ #
1655
+ # @!attribute [rw] dataset_type
1656
+ # Filter the datasets based on the dataset type.
1657
+ # @return [String]
1658
+ #
1659
+ # @!attribute [rw] creation_time_after
1660
+ # Filter the datasets to include datasets created after the specified
1661
+ # time.
1662
+ # @return [Time]
1663
+ #
1664
+ # @!attribute [rw] creation_time_before
1665
+ # Filter the datasets to include datasets created before the specified
1666
+ # time.
1667
+ # @return [Time]
1668
+ #
1669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetFilter AWS API Documentation
1670
+ #
1671
+ class DatasetFilter < Struct.new(
1672
+ :status,
1673
+ :dataset_type,
1674
+ :creation_time_after,
1675
+ :creation_time_before)
1676
+ SENSITIVE = []
1677
+ include Aws::Structure
1678
+ end
1679
+
1680
+ # Specifies the format and location of the input data for the dataset.
1681
+ #
1682
+ # @!attribute [rw] augmented_manifests
1683
+ # A list of augmented manifest files that provide training data for
1684
+ # your custom model. An augmented manifest file is a labeled dataset
1685
+ # that is produced by Amazon SageMaker Ground Truth.
1686
+ # @return [Array<Types::DatasetAugmentedManifestsListItem>]
1687
+ #
1688
+ # @!attribute [rw] data_format
1689
+ # `COMPREHEND_CSV`\: The data format is a two-column CSV file, where
1690
+ # the first column contains labels and the second column contains
1691
+ # documents.
1692
+ #
1693
+ # `AUGMENTED_MANIFEST`\: The data format
1694
+ # @return [String]
1695
+ #
1696
+ # @!attribute [rw] document_classifier_input_data_config
1697
+ # The input properties for training a document classifier model.
1698
+ #
1699
+ # For more information on how the input file is formatted, see
1700
+ # [Preparing training data][1] in the Comprehend Developer Guide.
1701
+ #
1702
+ #
1703
+ #
1704
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
1705
+ # @return [Types::DatasetDocumentClassifierInputDataConfig]
1706
+ #
1707
+ # @!attribute [rw] entity_recognizer_input_data_config
1708
+ # The input properties for training an entity recognizer model.
1709
+ # @return [Types::DatasetEntityRecognizerInputDataConfig]
1710
+ #
1711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetInputDataConfig AWS API Documentation
1712
+ #
1713
+ class DatasetInputDataConfig < Struct.new(
1714
+ :augmented_manifests,
1715
+ :data_format,
1716
+ :document_classifier_input_data_config,
1717
+ :entity_recognizer_input_data_config)
1718
+ SENSITIVE = []
1719
+ include Aws::Structure
1720
+ end
1721
+
1722
+ # Properties associated with the dataset.
1723
+ #
1724
+ # @!attribute [rw] dataset_arn
1725
+ # The ARN of the dataset.
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] dataset_name
1729
+ # The name of the dataset.
1730
+ # @return [String]
1731
+ #
1732
+ # @!attribute [rw] dataset_type
1733
+ # The dataset type (training data or test data).
1734
+ # @return [String]
1735
+ #
1736
+ # @!attribute [rw] dataset_s3_uri
1737
+ # The S3 URI where the dataset is stored.
1738
+ # @return [String]
1739
+ #
1740
+ # @!attribute [rw] description
1741
+ # Description of the dataset.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] status
1745
+ # The dataset status. While the system creates the dataset, the status
1746
+ # is `CREATING`. When the dataset is ready to use, the status changes
1747
+ # to `COMPLETED`.
1748
+ # @return [String]
1749
+ #
1750
+ # @!attribute [rw] message
1751
+ # A description of the status of the dataset.
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] number_of_documents
1755
+ # The number of documents in the dataset.
1756
+ # @return [Integer]
1757
+ #
1758
+ # @!attribute [rw] creation_time
1759
+ # Creation time of the dataset.
1760
+ # @return [Time]
1761
+ #
1762
+ # @!attribute [rw] end_time
1763
+ # Time when the data from the dataset becomes available in the data
1764
+ # lake.
1765
+ # @return [Time]
1766
+ #
1767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DatasetProperties AWS API Documentation
1768
+ #
1769
+ class DatasetProperties < Struct.new(
1770
+ :dataset_arn,
1771
+ :dataset_name,
1772
+ :dataset_type,
1773
+ :dataset_s3_uri,
1774
+ :description,
1775
+ :status,
1776
+ :message,
1777
+ :number_of_documents,
1778
+ :creation_time,
1779
+ :end_time)
1780
+ SENSITIVE = []
1781
+ include Aws::Structure
1782
+ end
1783
+
1266
1784
  # @!attribute [rw] document_classifier_arn
1267
1785
  # The Amazon Resource Name (ARN) that identifies the document
1268
1786
  # classifier.
@@ -1311,7 +1829,23 @@ module Aws::Comprehend
1311
1829
 
1312
1830
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizerResponse AWS API Documentation
1313
1831
  #
1314
- class DeleteEntityRecognizerResponse < Aws::EmptyStructure; end
1832
+ class DeleteEntityRecognizerResponse < Aws::EmptyStructure; end
1833
+
1834
+ # @!attribute [rw] flywheel_arn
1835
+ # The Amazon Resource Number (ARN) of the flywheel to delete.
1836
+ # @return [String]
1837
+ #
1838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheelRequest AWS API Documentation
1839
+ #
1840
+ class DeleteFlywheelRequest < Struct.new(
1841
+ :flywheel_arn)
1842
+ SENSITIVE = []
1843
+ include Aws::Structure
1844
+ end
1845
+
1846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheelResponse AWS API Documentation
1847
+ #
1848
+ class DeleteFlywheelResponse < Aws::EmptyStructure; end
1315
1849
 
1316
1850
  # @!attribute [rw] resource_arn
1317
1851
  # The Amazon Resource Name (ARN) of the custom model version that has
@@ -1335,9 +1869,34 @@ module Aws::Comprehend
1335
1869
  #
1336
1870
  class DeleteResourcePolicyResponse < Aws::EmptyStructure; end
1337
1871
 
1872
+ # @!attribute [rw] dataset_arn
1873
+ # The ARN of the dataset.
1874
+ # @return [String]
1875
+ #
1876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDatasetRequest AWS API Documentation
1877
+ #
1878
+ class DescribeDatasetRequest < Struct.new(
1879
+ :dataset_arn)
1880
+ SENSITIVE = []
1881
+ include Aws::Structure
1882
+ end
1883
+
1884
+ # @!attribute [rw] dataset_properties
1885
+ # The dataset properties.
1886
+ # @return [Types::DatasetProperties]
1887
+ #
1888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDatasetResponse AWS API Documentation
1889
+ #
1890
+ class DescribeDatasetResponse < Struct.new(
1891
+ :dataset_properties)
1892
+ SENSITIVE = []
1893
+ include Aws::Structure
1894
+ end
1895
+
1338
1896
  # @!attribute [rw] job_id
1339
1897
  # The identifier that Amazon Comprehend generated for the job. The
1340
- # operation returns this identifier in its response.
1898
+ # `StartDocumentClassificationJob` operation returns this identifier
1899
+ # in its response.
1341
1900
  # @return [String]
1342
1901
  #
1343
1902
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJobRequest AWS API Documentation
@@ -1363,7 +1922,8 @@ module Aws::Comprehend
1363
1922
 
1364
1923
  # @!attribute [rw] document_classifier_arn
1365
1924
  # The Amazon Resource Name (ARN) that identifies the document
1366
- # classifier. The operation returns this identifier in its response.
1925
+ # classifier. The `CreateDocumentClassifier` operation returns this
1926
+ # identifier in its response.
1367
1927
  # @return [String]
1368
1928
  #
1369
1929
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifierRequest AWS API Documentation
@@ -1389,7 +1949,8 @@ module Aws::Comprehend
1389
1949
 
1390
1950
  # @!attribute [rw] job_id
1391
1951
  # The identifier that Amazon Comprehend generated for the job. The
1392
- # operation returns this identifier in its response.
1952
+ # `StartDominantLanguageDetectionJob` operation returns this
1953
+ # identifier in its response.
1393
1954
  # @return [String]
1394
1955
  #
1395
1956
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJobRequest AWS API Documentation
@@ -1439,7 +2000,8 @@ module Aws::Comprehend
1439
2000
 
1440
2001
  # @!attribute [rw] job_id
1441
2002
  # The identifier that Amazon Comprehend generated for the job. The
1442
- # operation returns this identifier in its response.
2003
+ # `StartEntitiesDetectionJob` operation returns this identifier in its
2004
+ # response.
1443
2005
  # @return [String]
1444
2006
  #
1445
2007
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJobRequest AWS API Documentation
@@ -1513,9 +2075,61 @@ module Aws::Comprehend
1513
2075
  include Aws::Structure
1514
2076
  end
1515
2077
 
2078
+ # @!attribute [rw] flywheel_arn
2079
+ # @return [String]
2080
+ #
2081
+ # @!attribute [rw] flywheel_iteration_id
2082
+ # @return [String]
2083
+ #
2084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIterationRequest AWS API Documentation
2085
+ #
2086
+ class DescribeFlywheelIterationRequest < Struct.new(
2087
+ :flywheel_arn,
2088
+ :flywheel_iteration_id)
2089
+ SENSITIVE = []
2090
+ include Aws::Structure
2091
+ end
2092
+
2093
+ # @!attribute [rw] flywheel_iteration_properties
2094
+ # The configuration properties of a flywheel iteration.
2095
+ # @return [Types::FlywheelIterationProperties]
2096
+ #
2097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIterationResponse AWS API Documentation
2098
+ #
2099
+ class DescribeFlywheelIterationResponse < Struct.new(
2100
+ :flywheel_iteration_properties)
2101
+ SENSITIVE = []
2102
+ include Aws::Structure
2103
+ end
2104
+
2105
+ # @!attribute [rw] flywheel_arn
2106
+ # The Amazon Resource Number (ARN) of the flywheel.
2107
+ # @return [String]
2108
+ #
2109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelRequest AWS API Documentation
2110
+ #
2111
+ class DescribeFlywheelRequest < Struct.new(
2112
+ :flywheel_arn)
2113
+ SENSITIVE = []
2114
+ include Aws::Structure
2115
+ end
2116
+
2117
+ # @!attribute [rw] flywheel_properties
2118
+ # The flywheel properties.
2119
+ # @return [Types::FlywheelProperties]
2120
+ #
2121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelResponse AWS API Documentation
2122
+ #
2123
+ class DescribeFlywheelResponse < Struct.new(
2124
+ :flywheel_properties)
2125
+ SENSITIVE = []
2126
+ include Aws::Structure
2127
+ end
2128
+
1516
2129
  # @!attribute [rw] job_id
1517
2130
  # The identifier that Amazon Comprehend generated for the job. The
1518
- # operation returns this identifier in its response.
2131
+ # `StartKeyPhrasesDetectionJob` operation returns this identifier in
2132
+ # its response.
1519
2133
  # @return [String]
1520
2134
  #
1521
2135
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJobRequest AWS API Documentation
@@ -1634,7 +2248,8 @@ module Aws::Comprehend
1634
2248
 
1635
2249
  # @!attribute [rw] job_id
1636
2250
  # The identifier that Amazon Comprehend generated for the job. The
1637
- # operation returns this identifier in its response.
2251
+ # `StartTargetedSentimentDetectionJob` operation returns this
2252
+ # identifier in its response.
1638
2253
  # @return [String]
1639
2254
  #
1640
2255
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJobRequest AWS API Documentation
@@ -2061,6 +2676,26 @@ module Aws::Comprehend
2061
2676
  include Aws::Structure
2062
2677
  end
2063
2678
 
2679
+ # Configuration required for a custom classification model.
2680
+ #
2681
+ # @!attribute [rw] mode
2682
+ # Classification mode indicates whether the documents are
2683
+ # `MULTI_CLASS` or `MULTI_LABEL`.
2684
+ # @return [String]
2685
+ #
2686
+ # @!attribute [rw] labels
2687
+ # One or more labels to associate with the custom classifier.
2688
+ # @return [Array<String>]
2689
+ #
2690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationConfig AWS API Documentation
2691
+ #
2692
+ class DocumentClassificationConfig < Struct.new(
2693
+ :mode,
2694
+ :labels)
2695
+ SENSITIVE = []
2696
+ include Aws::Structure
2697
+ end
2698
+
2064
2699
  # Provides information for filtering a list of document classification
2065
2700
  # jobs. For more information, see the operation. You can provide only
2066
2701
  # one filter parameter in each request.
@@ -2156,7 +2791,7 @@ module Aws::Comprehend
2156
2791
  # @return [Types::OutputDataConfig]
2157
2792
  #
2158
2793
  # @!attribute [rw] data_access_role_arn
2159
- # The Amazon Resource Name (ARN) of the AWS identity and Access
2794
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
2160
2795
  # Management (IAM) role that grants Amazon Comprehend read access to
2161
2796
  # your input data.
2162
2797
  # @return [String]
@@ -2183,6 +2818,10 @@ module Aws::Comprehend
2183
2818
  # [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
2184
2819
  # @return [Types::VpcConfig]
2185
2820
  #
2821
+ # @!attribute [rw] flywheel_arn
2822
+ # The Amazon Resource Number (ARN) of the flywheel
2823
+ # @return [String]
2824
+ #
2186
2825
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
2187
2826
  #
2188
2827
  class DocumentClassificationJobProperties < Struct.new(
@@ -2198,14 +2837,15 @@ module Aws::Comprehend
2198
2837
  :output_data_config,
2199
2838
  :data_access_role_arn,
2200
2839
  :volume_kms_key_id,
2201
- :vpc_config)
2840
+ :vpc_config,
2841
+ :flywheel_arn)
2202
2842
  SENSITIVE = []
2203
2843
  include Aws::Structure
2204
2844
  end
2205
2845
 
2206
2846
  # Provides information for filtering a list of document classifiers. You
2207
2847
  # can only specify one filtering parameter in a request. For more
2208
- # information, see the operation.
2848
+ # information, see the `ListDocumentClassifiers` operation.
2209
2849
  #
2210
2850
  # @!attribute [rw] status
2211
2851
  # Filters the list of classifiers based on status.
@@ -2353,11 +2993,17 @@ module Aws::Comprehend
2353
2993
  # `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`
2354
2994
  # @return [String]
2355
2995
  #
2996
+ # @!attribute [rw] flywheel_stats_s3_prefix
2997
+ # The Amazon S3 prefix for the data lake location of the flywheel
2998
+ # statistics.
2999
+ # @return [String]
3000
+ #
2356
3001
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierOutputDataConfig AWS API Documentation
2357
3002
  #
2358
3003
  class DocumentClassifierOutputDataConfig < Struct.new(
2359
3004
  :s3_uri,
2360
- :kms_key_id)
3005
+ :kms_key_id,
3006
+ :flywheel_stats_s3_prefix)
2361
3007
  SENSITIVE = []
2362
3008
  include Aws::Structure
2363
3009
  end
@@ -2423,9 +3069,9 @@ module Aws::Comprehend
2423
3069
  # @return [Types::ClassifierMetadata]
2424
3070
  #
2425
3071
  # @!attribute [rw] data_access_role_arn
2426
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
2427
- # (IAM) role that grants Amazon Comprehend read access to your input
2428
- # data.
3072
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
3073
+ # Management (IAM) role that grants Amazon Comprehend read access to
3074
+ # your input data.
2429
3075
  # @return [String]
2430
3076
  #
2431
3077
  # @!attribute [rw] volume_kms_key_id
@@ -2478,6 +3124,10 @@ module Aws::Comprehend
2478
3124
  # classifier model in your AWS account.
2479
3125
  # @return [String]
2480
3126
  #
3127
+ # @!attribute [rw] flywheel_arn
3128
+ # The Amazon Resource Number (ARN) of the flywheel
3129
+ # @return [String]
3130
+ #
2481
3131
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
2482
3132
  #
2483
3133
  class DocumentClassifierProperties < Struct.new(
@@ -2498,7 +3148,8 @@ module Aws::Comprehend
2498
3148
  :mode,
2499
3149
  :model_kms_key_id,
2500
3150
  :version_name,
2501
- :source_model_arn)
3151
+ :source_model_arn,
3152
+ :flywheel_arn)
2502
3153
  SENSITIVE = [:classifier_metadata]
2503
3154
  include Aws::Structure
2504
3155
  end
@@ -2793,8 +3444,9 @@ module Aws::Comprehend
2793
3444
  # @return [Types::OutputDataConfig]
2794
3445
  #
2795
3446
  # @!attribute [rw] data_access_role_arn
2796
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
2797
- # access to your input data.
3447
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
3448
+ # Management (IAM) role that grants Amazon Comprehend read access to
3449
+ # your input data.
2798
3450
  # @return [String]
2799
3451
  #
2800
3452
  # @!attribute [rw] volume_kms_key_id
@@ -2925,7 +3577,7 @@ module Aws::Comprehend
2925
3577
  # @return [Time]
2926
3578
  #
2927
3579
  # @!attribute [rw] data_access_role_arn
2928
- # The Amazon Resource Name (ARN) of the AWS identity and Access
3580
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
2929
3581
  # Management (IAM) role that grants Amazon Comprehend read access to
2930
3582
  # trained custom models encrypted with a customer managed key
2931
3583
  # (ModelKmsKeyId).
@@ -2936,6 +3588,10 @@ module Aws::Comprehend
2936
3588
  # a customer KMS key.
2937
3589
  # @return [String]
2938
3590
  #
3591
+ # @!attribute [rw] flywheel_arn
3592
+ # The Amazon Resource Number (ARN) of the flywheel
3593
+ # @return [String]
3594
+ #
2939
3595
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
2940
3596
  #
2941
3597
  class EndpointProperties < Struct.new(
@@ -2949,7 +3605,8 @@ module Aws::Comprehend
2949
3605
  :creation_time,
2950
3606
  :last_modified_time,
2951
3607
  :data_access_role_arn,
2952
- :desired_data_access_role_arn)
3608
+ :desired_data_access_role_arn,
3609
+ :flywheel_arn)
2953
3610
  SENSITIVE = []
2954
3611
  include Aws::Structure
2955
3612
  end
@@ -3052,8 +3709,9 @@ module Aws::Comprehend
3052
3709
  # @return [String]
3053
3710
  #
3054
3711
  # @!attribute [rw] data_access_role_arn
3055
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
3056
- # access to your input data.
3712
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
3713
+ # Management (IAM) role that grants Amazon Comprehend read access to
3714
+ # your input data.
3057
3715
  # @return [String]
3058
3716
  #
3059
3717
  # @!attribute [rw] volume_kms_key_id
@@ -3171,6 +3829,20 @@ module Aws::Comprehend
3171
3829
  include Aws::Structure
3172
3830
  end
3173
3831
 
3832
+ # Configuration required for an entity recognition model.
3833
+ #
3834
+ # @!attribute [rw] entity_types
3835
+ # Up to 25 entity types that the model is trained to recognize.
3836
+ # @return [Array<Types::EntityTypesListItem>]
3837
+ #
3838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognitionConfig AWS API Documentation
3839
+ #
3840
+ class EntityRecognitionConfig < Struct.new(
3841
+ :entity_types)
3842
+ SENSITIVE = []
3843
+ include Aws::Structure
3844
+ end
3845
+
3174
3846
  # Describes the annotations associated with a entity recognizer.
3175
3847
  #
3176
3848
  # @!attribute [rw] s3_uri
@@ -3228,7 +3900,7 @@ module Aws::Comprehend
3228
3900
  include Aws::Structure
3229
3901
  end
3230
3902
 
3231
- # Describes the entity recognizer submitted with an entity recognizer.
3903
+ # Describes the entity list submitted with an entity recognizer.
3232
3904
  #
3233
3905
  # @!attribute [rw] s3_uri
3234
3906
  # Specifies the Amazon S3 location where the entity list is located.
@@ -3279,7 +3951,7 @@ module Aws::Comprehend
3279
3951
 
3280
3952
  # Provides information for filtering a list of entity recognizers. You
3281
3953
  # can only specify one filtering parameter in a request. For more
3282
- # information, see the operation./&gt;
3954
+ # information, see the `ListEntityRecognizers` operation./&gt;
3283
3955
  #
3284
3956
  # @!attribute [rw] status
3285
3957
  # The status of an entity recognizer.
@@ -3456,6 +4128,21 @@ module Aws::Comprehend
3456
4128
  include Aws::Structure
3457
4129
  end
3458
4130
 
4131
+ # Output data configuration.
4132
+ #
4133
+ # @!attribute [rw] flywheel_stats_s3_prefix
4134
+ # The Amazon S3 prefix for the data lake location of the flywheel
4135
+ # statistics.
4136
+ # @return [String]
4137
+ #
4138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerOutputDataConfig AWS API Documentation
4139
+ #
4140
+ class EntityRecognizerOutputDataConfig < Struct.new(
4141
+ :flywheel_stats_s3_prefix)
4142
+ SENSITIVE = []
4143
+ include Aws::Structure
4144
+ end
4145
+
3459
4146
  # Describes information about an entity recognizer.
3460
4147
  #
3461
4148
  # @!attribute [rw] entity_recognizer_arn
@@ -3501,9 +4188,9 @@ module Aws::Comprehend
3501
4188
  # @return [Types::EntityRecognizerMetadata]
3502
4189
  #
3503
4190
  # @!attribute [rw] data_access_role_arn
3504
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
3505
- # (IAM) role that grants Amazon Comprehend read access to your input
3506
- # data.
4191
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4192
+ # Management (IAM) role that grants Amazon Comprehend read access to
4193
+ # your input data.
3507
4194
  # @return [String]
3508
4195
  #
3509
4196
  # @!attribute [rw] volume_kms_key_id
@@ -3549,6 +4236,14 @@ module Aws::Comprehend
3549
4236
  # recognizer model in your AWS account.
3550
4237
  # @return [String]
3551
4238
  #
4239
+ # @!attribute [rw] flywheel_arn
4240
+ # The Amazon Resource Number (ARN) of the flywheel
4241
+ # @return [String]
4242
+ #
4243
+ # @!attribute [rw] output_data_config
4244
+ # Output data configuration.
4245
+ # @return [Types::EntityRecognizerOutputDataConfig]
4246
+ #
3552
4247
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
3553
4248
  #
3554
4249
  class EntityRecognizerProperties < Struct.new(
@@ -3567,7 +4262,9 @@ module Aws::Comprehend
3567
4262
  :vpc_config,
3568
4263
  :model_kms_key_id,
3569
4264
  :version_name,
3570
- :source_model_arn)
4265
+ :source_model_arn,
4266
+ :flywheel_arn,
4267
+ :output_data_config)
3571
4268
  SENSITIVE = [:recognizer_metadata]
3572
4269
  include Aws::Structure
3573
4270
  end
@@ -3801,7 +4498,7 @@ module Aws::Comprehend
3801
4498
  # @return [String]
3802
4499
  #
3803
4500
  # @!attribute [rw] data_access_role_arn
3804
- # The Amazon Resource Name (ARN) of the AWS Identify and Access
4501
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
3805
4502
  # Management (IAM) role that grants Amazon Comprehend read access to
3806
4503
  # your input data.
3807
4504
  # @return [String]
@@ -3835,15 +4532,280 @@ module Aws::Comprehend
3835
4532
  # Page number.
3836
4533
  # @return [Integer]
3837
4534
  #
3838
- # @!attribute [rw] count
3839
- # Number of characters extracted from each page.
3840
- # @return [Integer]
4535
+ # @!attribute [rw] count
4536
+ # Number of characters extracted from each page.
4537
+ # @return [Integer]
4538
+ #
4539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ExtractedCharactersListItem AWS API Documentation
4540
+ #
4541
+ class ExtractedCharactersListItem < Struct.new(
4542
+ :page,
4543
+ :count)
4544
+ SENSITIVE = []
4545
+ include Aws::Structure
4546
+ end
4547
+
4548
+ # Filter the flywheels based on creation time or flywheel status.
4549
+ #
4550
+ # @!attribute [rw] status
4551
+ # Filter the flywheels based on the flywheel status.
4552
+ # @return [String]
4553
+ #
4554
+ # @!attribute [rw] creation_time_after
4555
+ # Filter the flywheels to include flywheels created after the
4556
+ # specified time.
4557
+ # @return [Time]
4558
+ #
4559
+ # @!attribute [rw] creation_time_before
4560
+ # Filter the flywheels to include flywheels created before the
4561
+ # specified time.
4562
+ # @return [Time]
4563
+ #
4564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelFilter AWS API Documentation
4565
+ #
4566
+ class FlywheelFilter < Struct.new(
4567
+ :status,
4568
+ :creation_time_after,
4569
+ :creation_time_before)
4570
+ SENSITIVE = []
4571
+ include Aws::Structure
4572
+ end
4573
+
4574
+ # Filter the flywheel iterations based on creation time.
4575
+ #
4576
+ # @!attribute [rw] creation_time_after
4577
+ # Filter the flywheel iterations to include iterations created after
4578
+ # the specified time.
4579
+ # @return [Time]
4580
+ #
4581
+ # @!attribute [rw] creation_time_before
4582
+ # Filter the flywheel iterations to include iterations created before
4583
+ # the specified time.
4584
+ # @return [Time]
4585
+ #
4586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelIterationFilter AWS API Documentation
4587
+ #
4588
+ class FlywheelIterationFilter < Struct.new(
4589
+ :creation_time_after,
4590
+ :creation_time_before)
4591
+ SENSITIVE = []
4592
+ include Aws::Structure
4593
+ end
4594
+
4595
+ # The configuration properties of a flywheel iteration.
4596
+ #
4597
+ # @!attribute [rw] flywheel_arn
4598
+ # @return [String]
4599
+ #
4600
+ # @!attribute [rw] flywheel_iteration_id
4601
+ # @return [String]
4602
+ #
4603
+ # @!attribute [rw] creation_time
4604
+ # The creation start time of the flywheel iteration.
4605
+ # @return [Time]
4606
+ #
4607
+ # @!attribute [rw] end_time
4608
+ # The completion time of this flywheel iteration.
4609
+ # @return [Time]
4610
+ #
4611
+ # @!attribute [rw] status
4612
+ # The status of the flywheel iteration.
4613
+ # @return [String]
4614
+ #
4615
+ # @!attribute [rw] message
4616
+ # A description of the status of the flywheel iteration.
4617
+ # @return [String]
4618
+ #
4619
+ # @!attribute [rw] evaluated_model_arn
4620
+ # The ARN of the evaluated model associated with this flywheel
4621
+ # iteration.
4622
+ # @return [String]
4623
+ #
4624
+ # @!attribute [rw] evaluated_model_metrics
4625
+ # The evaluation metrics associated with the evaluated model.
4626
+ # @return [Types::FlywheelModelEvaluationMetrics]
4627
+ #
4628
+ # @!attribute [rw] trained_model_arn
4629
+ # The ARN of the trained model associated with this flywheel
4630
+ # iteration.
4631
+ # @return [String]
4632
+ #
4633
+ # @!attribute [rw] trained_model_metrics
4634
+ # The metrics associated with the trained model.
4635
+ # @return [Types::FlywheelModelEvaluationMetrics]
4636
+ #
4637
+ # @!attribute [rw] evaluation_manifest_s3_prefix
4638
+ # @return [String]
4639
+ #
4640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelIterationProperties AWS API Documentation
4641
+ #
4642
+ class FlywheelIterationProperties < Struct.new(
4643
+ :flywheel_arn,
4644
+ :flywheel_iteration_id,
4645
+ :creation_time,
4646
+ :end_time,
4647
+ :status,
4648
+ :message,
4649
+ :evaluated_model_arn,
4650
+ :evaluated_model_metrics,
4651
+ :trained_model_arn,
4652
+ :trained_model_metrics,
4653
+ :evaluation_manifest_s3_prefix)
4654
+ SENSITIVE = []
4655
+ include Aws::Structure
4656
+ end
4657
+
4658
+ # The evaluation metrics associated with the evaluated model.
4659
+ #
4660
+ # @!attribute [rw] average_f1_score
4661
+ # The average F1 score from the evaluation metrics.
4662
+ # @return [Float]
4663
+ #
4664
+ # @!attribute [rw] average_precision
4665
+ # Average precision metric for the model.
4666
+ # @return [Float]
4667
+ #
4668
+ # @!attribute [rw] average_recall
4669
+ # Average recall metric for the model.
4670
+ # @return [Float]
4671
+ #
4672
+ # @!attribute [rw] average_accuracy
4673
+ # Average accuracy metric for the model.
4674
+ # @return [Float]
4675
+ #
4676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelModelEvaluationMetrics AWS API Documentation
4677
+ #
4678
+ class FlywheelModelEvaluationMetrics < Struct.new(
4679
+ :average_f1_score,
4680
+ :average_precision,
4681
+ :average_recall,
4682
+ :average_accuracy)
4683
+ SENSITIVE = []
4684
+ include Aws::Structure
4685
+ end
4686
+
4687
+ # The flywheel properties.
4688
+ #
4689
+ # @!attribute [rw] flywheel_arn
4690
+ # The Amazon Resource Number (ARN) of the flywheel.
4691
+ # @return [String]
4692
+ #
4693
+ # @!attribute [rw] active_model_arn
4694
+ # The Amazon Resource Number (ARN) of the active model version.
4695
+ # @return [String]
4696
+ #
4697
+ # @!attribute [rw] data_access_role_arn
4698
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4699
+ # Management (IAM) role that grants Amazon Comprehend permission to
4700
+ # access the flywheel data.
4701
+ # @return [String]
4702
+ #
4703
+ # @!attribute [rw] task_config
4704
+ # Configuration about the custom classifier associated with the
4705
+ # flywheel.
4706
+ # @return [Types::TaskConfig]
4707
+ #
4708
+ # @!attribute [rw] data_lake_s3_uri
4709
+ # Amazon S3 URI of the data lake location.
4710
+ # @return [String]
4711
+ #
4712
+ # @!attribute [rw] data_security_config
4713
+ # Data security configuration.
4714
+ # @return [Types::DataSecurityConfig]
4715
+ #
4716
+ # @!attribute [rw] status
4717
+ # The status of the flywheel.
4718
+ # @return [String]
4719
+ #
4720
+ # @!attribute [rw] model_type
4721
+ # Model type of the flywheel's model.
4722
+ # @return [String]
4723
+ #
4724
+ # @!attribute [rw] message
4725
+ # A description of the status of the flywheel.
4726
+ # @return [String]
4727
+ #
4728
+ # @!attribute [rw] creation_time
4729
+ # Creation time of the flywheel.
4730
+ # @return [Time]
4731
+ #
4732
+ # @!attribute [rw] last_modified_time
4733
+ # Last modified time for the flywheel.
4734
+ # @return [Time]
4735
+ #
4736
+ # @!attribute [rw] latest_flywheel_iteration
4737
+ # The most recent flywheel iteration.
4738
+ # @return [String]
4739
+ #
4740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelProperties AWS API Documentation
4741
+ #
4742
+ class FlywheelProperties < Struct.new(
4743
+ :flywheel_arn,
4744
+ :active_model_arn,
4745
+ :data_access_role_arn,
4746
+ :task_config,
4747
+ :data_lake_s3_uri,
4748
+ :data_security_config,
4749
+ :status,
4750
+ :model_type,
4751
+ :message,
4752
+ :creation_time,
4753
+ :last_modified_time,
4754
+ :latest_flywheel_iteration)
4755
+ SENSITIVE = []
4756
+ include Aws::Structure
4757
+ end
4758
+
4759
+ # Flywheel summary information.
4760
+ #
4761
+ # @!attribute [rw] flywheel_arn
4762
+ # The Amazon Resource Number (ARN) of the flywheel
4763
+ # @return [String]
4764
+ #
4765
+ # @!attribute [rw] active_model_arn
4766
+ # ARN of the active model version for the flywheel.
4767
+ # @return [String]
4768
+ #
4769
+ # @!attribute [rw] data_lake_s3_uri
4770
+ # Amazon S3 URI of the data lake location.
4771
+ # @return [String]
4772
+ #
4773
+ # @!attribute [rw] status
4774
+ # The status of the flywheel.
4775
+ # @return [String]
4776
+ #
4777
+ # @!attribute [rw] model_type
4778
+ # Model type of the flywheel's model.
4779
+ # @return [String]
4780
+ #
4781
+ # @!attribute [rw] message
4782
+ # A description of the status of the flywheel.
4783
+ # @return [String]
4784
+ #
4785
+ # @!attribute [rw] creation_time
4786
+ # Creation time of the flywheel.
4787
+ # @return [Time]
4788
+ #
4789
+ # @!attribute [rw] last_modified_time
4790
+ # Last modified time for the flywheel.
4791
+ # @return [Time]
3841
4792
  #
3842
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ExtractedCharactersListItem AWS API Documentation
4793
+ # @!attribute [rw] latest_flywheel_iteration
4794
+ # The most recent flywheel iteration.
4795
+ # @return [String]
3843
4796
  #
3844
- class ExtractedCharactersListItem < Struct.new(
3845
- :page,
3846
- :count)
4797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/FlywheelSummary AWS API Documentation
4798
+ #
4799
+ class FlywheelSummary < Struct.new(
4800
+ :flywheel_arn,
4801
+ :active_model_arn,
4802
+ :data_lake_s3_uri,
4803
+ :status,
4804
+ :model_type,
4805
+ :message,
4806
+ :creation_time,
4807
+ :last_modified_time,
4808
+ :latest_flywheel_iteration)
3847
4809
  SENSITIVE = []
3848
4810
  include Aws::Structure
3849
4811
  end
@@ -3905,13 +4867,14 @@ module Aws::Comprehend
3905
4867
  # @return [String]
3906
4868
  #
3907
4869
  # @!attribute [rw] data_access_role_arn
3908
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
3909
- # (IAM) role that allows Amazon Comprehend to use Amazon Key
3910
- # Management Service (KMS) to encrypt or decrypt the custom model.
4870
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4871
+ # Management (IAM) role that grants Amazon Comprehend permission to
4872
+ # use Amazon Key Management Service (KMS) to encrypt or decrypt the
4873
+ # custom model.
3911
4874
  # @return [String]
3912
4875
  #
3913
4876
  # @!attribute [rw] tags
3914
- # Tags to be associated with the custom model that is created by this
4877
+ # Tags to associate with the custom model that is created by this
3915
4878
  # import. A tag is a key-value pair that adds as a metadata to a
3916
4879
  # resource used by Amazon Comprehend. For example, a tag with
3917
4880
  # "Sales" as the key might be added to a resource to indicate its
@@ -4212,8 +5175,9 @@ module Aws::Comprehend
4212
5175
  # @return [String]
4213
5176
  #
4214
5177
  # @!attribute [rw] data_access_role_arn
4215
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
4216
- # access to your input data.
5178
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
5179
+ # Management (IAM) role that grants Amazon Comprehend read access to
5180
+ # your input data.
4217
5181
  # @return [String]
4218
5182
  #
4219
5183
  # @!attribute [rw] volume_kms_key_id
@@ -4272,6 +5236,51 @@ module Aws::Comprehend
4272
5236
  include Aws::Structure
4273
5237
  end
4274
5238
 
5239
+ # @!attribute [rw] flywheel_arn
5240
+ # The Amazon Resource Number (ARN) of the flywheel.
5241
+ # @return [String]
5242
+ #
5243
+ # @!attribute [rw] filter
5244
+ # Filters the datasets to be returned in the response.
5245
+ # @return [Types::DatasetFilter]
5246
+ #
5247
+ # @!attribute [rw] next_token
5248
+ # Identifies the next page of results to return.
5249
+ # @return [String]
5250
+ #
5251
+ # @!attribute [rw] max_results
5252
+ # Maximum number of results to return in a response. The default is
5253
+ # 100.
5254
+ # @return [Integer]
5255
+ #
5256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasetsRequest AWS API Documentation
5257
+ #
5258
+ class ListDatasetsRequest < Struct.new(
5259
+ :flywheel_arn,
5260
+ :filter,
5261
+ :next_token,
5262
+ :max_results)
5263
+ SENSITIVE = []
5264
+ include Aws::Structure
5265
+ end
5266
+
5267
+ # @!attribute [rw] dataset_properties_list
5268
+ # The dataset properties list.
5269
+ # @return [Array<Types::DatasetProperties>]
5270
+ #
5271
+ # @!attribute [rw] next_token
5272
+ # Identifies the next page of results to return.
5273
+ # @return [String]
5274
+ #
5275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasetsResponse AWS API Documentation
5276
+ #
5277
+ class ListDatasetsResponse < Struct.new(
5278
+ :dataset_properties_list,
5279
+ :next_token)
5280
+ SENSITIVE = []
5281
+ include Aws::Structure
5282
+ end
5283
+
4275
5284
  # @!attribute [rw] filter
4276
5285
  # Filters the jobs that are returned. You can filter jobs on their
4277
5286
  # names, status, or the date and time that they were submitted. You
@@ -4541,7 +5550,7 @@ module Aws::Comprehend
4541
5550
  # @return [Array<Types::EntityRecognizerSummary>]
4542
5551
  #
4543
5552
  # @!attribute [rw] next_token
4544
- # The list entity recognizer summaries.
5553
+ # Identifies the next page of results to return.
4545
5554
  # @return [String]
4546
5555
  #
4547
5556
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesResponse AWS API Documentation
@@ -4636,6 +5645,93 @@ module Aws::Comprehend
4636
5645
  include Aws::Structure
4637
5646
  end
4638
5647
 
5648
+ # @!attribute [rw] flywheel_arn
5649
+ # The ARN of the flywheel.
5650
+ # @return [String]
5651
+ #
5652
+ # @!attribute [rw] filter
5653
+ # Filter the flywheel iteration history based on creation time.
5654
+ # @return [Types::FlywheelIterationFilter]
5655
+ #
5656
+ # @!attribute [rw] next_token
5657
+ # Next token
5658
+ # @return [String]
5659
+ #
5660
+ # @!attribute [rw] max_results
5661
+ # Maximum number of iteration history results to return
5662
+ # @return [Integer]
5663
+ #
5664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistoryRequest AWS API Documentation
5665
+ #
5666
+ class ListFlywheelIterationHistoryRequest < Struct.new(
5667
+ :flywheel_arn,
5668
+ :filter,
5669
+ :next_token,
5670
+ :max_results)
5671
+ SENSITIVE = []
5672
+ include Aws::Structure
5673
+ end
5674
+
5675
+ # @!attribute [rw] flywheel_iteration_properties_list
5676
+ # List of flywheel iteration properties
5677
+ # @return [Array<Types::FlywheelIterationProperties>]
5678
+ #
5679
+ # @!attribute [rw] next_token
5680
+ # Next token
5681
+ # @return [String]
5682
+ #
5683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistoryResponse AWS API Documentation
5684
+ #
5685
+ class ListFlywheelIterationHistoryResponse < Struct.new(
5686
+ :flywheel_iteration_properties_list,
5687
+ :next_token)
5688
+ SENSITIVE = []
5689
+ include Aws::Structure
5690
+ end
5691
+
5692
+ # @!attribute [rw] filter
5693
+ # Filters the flywheels that are returned. You can filter flywheels on
5694
+ # their status, or the date and time that they were submitted. You can
5695
+ # only set one filter at a time.
5696
+ # @return [Types::FlywheelFilter]
5697
+ #
5698
+ # @!attribute [rw] next_token
5699
+ # Identifies the next page of results to return.
5700
+ # @return [String]
5701
+ #
5702
+ # @!attribute [rw] max_results
5703
+ # Maximum number of results to return in a response. The default is
5704
+ # 100.
5705
+ # @return [Integer]
5706
+ #
5707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelsRequest AWS API Documentation
5708
+ #
5709
+ class ListFlywheelsRequest < Struct.new(
5710
+ :filter,
5711
+ :next_token,
5712
+ :max_results)
5713
+ SENSITIVE = []
5714
+ include Aws::Structure
5715
+ end
5716
+
5717
+ # @!attribute [rw] flywheel_summary_list
5718
+ # A list of flywheel properties retrieved by the service in response
5719
+ # to the request.
5720
+ # @return [Array<Types::FlywheelSummary>]
5721
+ #
5722
+ # @!attribute [rw] next_token
5723
+ # Identifies the next page of results to return.
5724
+ # @return [String]
5725
+ #
5726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelsResponse AWS API Documentation
5727
+ #
5728
+ class ListFlywheelsResponse < Struct.new(
5729
+ :flywheel_summary_list,
5730
+ :next_token)
5731
+ SENSITIVE = []
5732
+ include Aws::Structure
5733
+ end
5734
+
4639
5735
  # @!attribute [rw] filter
4640
5736
  # Filters the jobs that are returned. You can filter jobs on their
4641
5737
  # name, status, or the date and time that they were submitted. You can
@@ -5080,8 +6176,9 @@ module Aws::Comprehend
5080
6176
  # @return [String]
5081
6177
  #
5082
6178
  # @!attribute [rw] data_access_role_arn
5083
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
5084
- # access to your input data.
6179
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
6180
+ # Management (IAM) role that grants Amazon Comprehend read access to
6181
+ # your input data.
5085
6182
  # @return [String]
5086
6183
  #
5087
6184
  # @!attribute [rw] mode
@@ -5440,8 +6537,9 @@ module Aws::Comprehend
5440
6537
  # @return [String]
5441
6538
  #
5442
6539
  # @!attribute [rw] data_access_role_arn
5443
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
5444
- # access to your input data.
6540
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
6541
+ # Management (IAM) role that grants Amazon Comprehend read access to
6542
+ # your input data.
5445
6543
  # @return [String]
5446
6544
  #
5447
6545
  # @!attribute [rw] volume_kms_key_id
@@ -5574,12 +6672,17 @@ module Aws::Comprehend
5574
6672
  # @return [Types::VpcConfig]
5575
6673
  #
5576
6674
  # @!attribute [rw] tags
5577
- # Tags to be associated with the document classification job. A tag is
5578
- # a key-value pair that adds metadata to a resource used by Amazon
6675
+ # Tags to associate with the document classification job. A tag is a
6676
+ # key-value pair that adds metadata to a resource used by Amazon
5579
6677
  # Comprehend. For example, a tag with "Sales" as the key might be
5580
6678
  # added to a resource to indicate its use by the sales department.
5581
6679
  # @return [Array<Types::Tag>]
5582
6680
  #
6681
+ # @!attribute [rw] flywheel_arn
6682
+ # The Amazon Resource Number (ARN) of the flywheel associated with the
6683
+ # model to use.
6684
+ # @return [String]
6685
+ #
5583
6686
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
5584
6687
  #
5585
6688
  class StartDocumentClassificationJobRequest < Struct.new(
@@ -5591,14 +6694,16 @@ module Aws::Comprehend
5591
6694
  :client_request_token,
5592
6695
  :volume_kms_key_id,
5593
6696
  :vpc_config,
5594
- :tags)
6697
+ :tags,
6698
+ :flywheel_arn)
5595
6699
  SENSITIVE = []
5596
6700
  include Aws::Structure
5597
6701
  end
5598
6702
 
5599
6703
  # @!attribute [rw] job_id
5600
6704
  # The identifier generated for the job. To get the status of the job,
5601
- # use this identifier with the operation.
6705
+ # use this identifier with the `DescribeDocumentClassificationJob`
6706
+ # operation.
5602
6707
  # @return [String]
5603
6708
  #
5604
6709
  # @!attribute [rw] job_arn
@@ -5624,7 +6729,8 @@ module Aws::Comprehend
5624
6729
  # * COMPLETED - The job was successfully completed and the output is
5625
6730
  # available.
5626
6731
  #
5627
- # * FAILED - The job did not complete. For details, use the operation.
6732
+ # * FAILED - The job did not complete. For details, use the
6733
+ # `DescribeDocumentClassificationJob` operation.
5628
6734
  #
5629
6735
  # * STOP\_REQUESTED - Amazon Comprehend has received a stop request
5630
6736
  # for the job and is processing the request.
@@ -5632,12 +6738,17 @@ module Aws::Comprehend
5632
6738
  # * STOPPED - The job was successfully stopped without completing.
5633
6739
  # @return [String]
5634
6740
  #
6741
+ # @!attribute [rw] document_classifier_arn
6742
+ # The ARN of the custom classification model.
6743
+ # @return [String]
6744
+ #
5635
6745
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobResponse AWS API Documentation
5636
6746
  #
5637
6747
  class StartDocumentClassificationJobResponse < Struct.new(
5638
6748
  :job_id,
5639
6749
  :job_arn,
5640
- :job_status)
6750
+ :job_status,
6751
+ :document_classifier_arn)
5641
6752
  SENSITIVE = []
5642
6753
  include Aws::Structure
5643
6754
  end
@@ -5696,11 +6807,10 @@ module Aws::Comprehend
5696
6807
  # @return [Types::VpcConfig]
5697
6808
  #
5698
6809
  # @!attribute [rw] tags
5699
- # Tags to be associated with the dominant language detection job. A
5700
- # tag is a key-value pair that adds metadata to a resource used by
5701
- # Amazon Comprehend. For example, a tag with "Sales" as the key
5702
- # might be added to a resource to indicate its use by the sales
5703
- # department.
6810
+ # Tags to associate with the dominant language detection job. A tag is
6811
+ # a key-value pair that adds metadata to a resource used by Amazon
6812
+ # Comprehend. For example, a tag with "Sales" as the key might be
6813
+ # added to a resource to indicate its use by the sales department.
5704
6814
  # @return [Array<Types::Tag>]
5705
6815
  #
5706
6816
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
@@ -5829,12 +6939,17 @@ module Aws::Comprehend
5829
6939
  # @return [Types::VpcConfig]
5830
6940
  #
5831
6941
  # @!attribute [rw] tags
5832
- # Tags to be associated with the entities detection job. A tag is a
6942
+ # Tags to associate with the entities detection job. A tag is a
5833
6943
  # key-value pair that adds metadata to a resource used by Amazon
5834
6944
  # Comprehend. For example, a tag with "Sales" as the key might be
5835
6945
  # added to a resource to indicate its use by the sales department.
5836
6946
  # @return [Array<Types::Tag>]
5837
6947
  #
6948
+ # @!attribute [rw] flywheel_arn
6949
+ # The Amazon Resource Number (ARN) of the flywheel associated with the
6950
+ # model to use.
6951
+ # @return [String]
6952
+ #
5838
6953
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
5839
6954
  #
5840
6955
  class StartEntitiesDetectionJobRequest < Struct.new(
@@ -5847,7 +6962,8 @@ module Aws::Comprehend
5847
6962
  :client_request_token,
5848
6963
  :volume_kms_key_id,
5849
6964
  :vpc_config,
5850
- :tags)
6965
+ :tags,
6966
+ :flywheel_arn)
5851
6967
  SENSITIVE = []
5852
6968
  include Aws::Structure
5853
6969
  end
@@ -5890,12 +7006,17 @@ module Aws::Comprehend
5890
7006
  # * STOPPED - The job was successfully stopped without completing.
5891
7007
  # @return [String]
5892
7008
  #
7009
+ # @!attribute [rw] entity_recognizer_arn
7010
+ # The ARN of the custom entity recognition model.
7011
+ # @return [String]
7012
+ #
5893
7013
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobResponse AWS API Documentation
5894
7014
  #
5895
7015
  class StartEntitiesDetectionJobResponse < Struct.new(
5896
7016
  :job_id,
5897
7017
  :job_arn,
5898
- :job_status)
7018
+ :job_status,
7019
+ :entity_recognizer_arn)
5899
7020
  SENSITIVE = []
5900
7021
  include Aws::Structure
5901
7022
  end
@@ -5935,7 +7056,7 @@ module Aws::Comprehend
5935
7056
  # @return [Array<String>]
5936
7057
  #
5937
7058
  # @!attribute [rw] tags
5938
- # Tags to be associated with the events detection job. A tag is a
7059
+ # Tags to associate with the events detection job. A tag is a
5939
7060
  # key-value pair that adds metadata to a resource used by Amazon
5940
7061
  # Comprehend. For example, a tag with "Sales" as the key might be
5941
7062
  # added to a resource to indicate its use by the sales department.
@@ -5988,6 +7109,39 @@ module Aws::Comprehend
5988
7109
  include Aws::Structure
5989
7110
  end
5990
7111
 
7112
+ # @!attribute [rw] flywheel_arn
7113
+ # The ARN of the flywheel.
7114
+ # @return [String]
7115
+ #
7116
+ # @!attribute [rw] client_request_token
7117
+ # A unique identifier for the request. If you don't set the client
7118
+ # request token, Amazon Comprehend generates one.
7119
+ # @return [String]
7120
+ #
7121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIterationRequest AWS API Documentation
7122
+ #
7123
+ class StartFlywheelIterationRequest < Struct.new(
7124
+ :flywheel_arn,
7125
+ :client_request_token)
7126
+ SENSITIVE = []
7127
+ include Aws::Structure
7128
+ end
7129
+
7130
+ # @!attribute [rw] flywheel_arn
7131
+ # @return [String]
7132
+ #
7133
+ # @!attribute [rw] flywheel_iteration_id
7134
+ # @return [String]
7135
+ #
7136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIterationResponse AWS API Documentation
7137
+ #
7138
+ class StartFlywheelIterationResponse < Struct.new(
7139
+ :flywheel_arn,
7140
+ :flywheel_iteration_id)
7141
+ SENSITIVE = []
7142
+ include Aws::Structure
7143
+ end
7144
+
5991
7145
  # @!attribute [rw] input_data_config
5992
7146
  # Specifies the format and location of the input data for the job.
5993
7147
  # @return [Types::InputDataConfig]
@@ -6048,7 +7202,7 @@ module Aws::Comprehend
6048
7202
  # @return [Types::VpcConfig]
6049
7203
  #
6050
7204
  # @!attribute [rw] tags
6051
- # Tags to be associated with the key phrases detection job. A tag is a
7205
+ # Tags to associate with the key phrases detection job. A tag is a
6052
7206
  # key-value pair that adds metadata to a resource used by Amazon
6053
7207
  # Comprehend. For example, a tag with "Sales" as the key might be
6054
7208
  # added to a resource to indicate its use by the sales department.
@@ -6159,8 +7313,8 @@ module Aws::Comprehend
6159
7313
  # @return [String]
6160
7314
  #
6161
7315
  # @!attribute [rw] tags
6162
- # Tags to be associated with the PII entities detection job. A tag is
6163
- # a key-value pair that adds metadata to a resource used by Amazon
7316
+ # Tags to associate with the PII entities detection job. A tag is a
7317
+ # key-value pair that adds metadata to a resource used by Amazon
6164
7318
  # Comprehend. For example, a tag with "Sales" as the key might be
6165
7319
  # added to a resource to indicate its use by the sales department.
6166
7320
  # @return [Array<Types::Tag>]
@@ -6272,7 +7426,7 @@ module Aws::Comprehend
6272
7426
  # @return [Types::VpcConfig]
6273
7427
  #
6274
7428
  # @!attribute [rw] tags
6275
- # Tags to be associated with the sentiment detection job. A tag is a
7429
+ # Tags to associate with the sentiment detection job. A tag is a
6276
7430
  # key-value pair that adds metadata to a resource used by Amazon
6277
7431
  # Comprehend. For example, a tag with "Sales" as the key might be
6278
7432
  # added to a resource to indicate its use by the sales department.
@@ -6397,11 +7551,10 @@ module Aws::Comprehend
6397
7551
  # @return [Types::VpcConfig]
6398
7552
  #
6399
7553
  # @!attribute [rw] tags
6400
- # Tags to be associated with the targeted sentiment detection job. A
6401
- # tag is a key-value pair that adds metadata to a resource used by
6402
- # Amazon Comprehend. For example, a tag with "Sales" as the key
6403
- # might be added to a resource to indicate its use by the sales
6404
- # department.
7554
+ # Tags to associate with the targeted sentiment detection job. A tag
7555
+ # is a key-value pair that adds metadata to a resource used by Amazon
7556
+ # Comprehend. For example, a tag with "Sales" as the key might be
7557
+ # added to a resource to indicate its use by the sales department.
6405
7558
  # @return [Array<Types::Tag>]
6406
7559
  #
6407
7560
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobRequest AWS API Documentation
@@ -6422,7 +7575,8 @@ module Aws::Comprehend
6422
7575
 
6423
7576
  # @!attribute [rw] job_id
6424
7577
  # The identifier generated for the job. To get the status of a job,
6425
- # use this identifier with the operation.
7578
+ # use this identifier with the `DescribeTargetedSentimentDetectionJob`
7579
+ # operation.
6426
7580
  # @return [String]
6427
7581
  #
6428
7582
  # @!attribute [rw] job_arn
@@ -6450,7 +7604,7 @@ module Aws::Comprehend
6450
7604
  # available.
6451
7605
  #
6452
7606
  # * FAILED - The job did not complete. To get details, use the
6453
- # operation.
7607
+ # `DescribeTargetedSentimentDetectionJob` operation.
6454
7608
  # @return [String]
6455
7609
  #
6456
7610
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJobResponse AWS API Documentation
@@ -6524,7 +7678,7 @@ module Aws::Comprehend
6524
7678
  # @return [Types::VpcConfig]
6525
7679
  #
6526
7680
  # @!attribute [rw] tags
6527
- # Tags to be associated with the topics detection job. A tag is a
7681
+ # Tags to associate with the topics detection job. A tag is a
6528
7682
  # key-value pair that adds metadata to a resource used by Amazon
6529
7683
  # Comprehend. For example, a tag with "Sales" as the key might be
6530
7684
  # added to a resource to indicate its use by the sales department.
@@ -6936,7 +8090,8 @@ module Aws::Comprehend
6936
8090
  class TagResourceResponse < Aws::EmptyStructure; end
6937
8091
 
6938
8092
  # Provides information for filtering a list of dominant language
6939
- # detection jobs. For more information, see the operation.
8093
+ # detection jobs. For more information, see the
8094
+ # `ListTargetedSentimentDetectionJobs` operation.
6940
8095
  #
6941
8096
  # @!attribute [rw] job_name
6942
8097
  # Filters on the name of the job.
@@ -7028,16 +8183,16 @@ module Aws::Comprehend
7028
8183
  # @return [String]
7029
8184
  #
7030
8185
  # @!attribute [rw] data_access_role_arn
7031
- # The Amazon Resource Name (ARN) that gives Amazon Comprehend read
7032
- # access to your input data.
8186
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
8187
+ # Management (IAM) role that grants Amazon Comprehend read access to
8188
+ # your input data.
7033
8189
  # @return [String]
7034
8190
  #
7035
8191
  # @!attribute [rw] volume_kms_key_id
7036
- # ID for the AWS Key Management Service (KMS) key that Amazon
7037
- # Comprehend uses to encrypt data on the storage volume attached to
7038
- # the ML compute instance(s) that process the targeted sentiment
7039
- # detection job. The VolumeKmsKeyId can be either of the following
7040
- # formats:
8192
+ # ID for the KMS key that Amazon Comprehend uses to encrypt the data
8193
+ # on the storage volume attached to the ML compute instance(s) that
8194
+ # process the targeted sentiment detection job. The VolumeKmsKeyId can
8195
+ # be either of the following formats:
7041
8196
  #
7042
8197
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
7043
8198
  #
@@ -7169,6 +8324,31 @@ module Aws::Comprehend
7169
8324
  include Aws::Structure
7170
8325
  end
7171
8326
 
8327
+ # Configuration about the custom classifier associated with the
8328
+ # flywheel.
8329
+ #
8330
+ # @!attribute [rw] language_code
8331
+ # Language code for the language that the model supports.
8332
+ # @return [String]
8333
+ #
8334
+ # @!attribute [rw] document_classification_config
8335
+ # Configuration required for a classification model.
8336
+ # @return [Types::DocumentClassificationConfig]
8337
+ #
8338
+ # @!attribute [rw] entity_recognition_config
8339
+ # Configuration required for an entity recognition model.
8340
+ # @return [Types::EntityRecognitionConfig]
8341
+ #
8342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TaskConfig AWS API Documentation
8343
+ #
8344
+ class TaskConfig < Struct.new(
8345
+ :language_code,
8346
+ :document_classification_config,
8347
+ :entity_recognition_config)
8348
+ SENSITIVE = []
8349
+ include Aws::Structure
8350
+ end
8351
+
7172
8352
  # The size of the input text exceeds the limit. Use a smaller document.
7173
8353
  #
7174
8354
  # @!attribute [rw] message
@@ -7317,9 +8497,9 @@ module Aws::Comprehend
7317
8497
  # @return [Integer]
7318
8498
  #
7319
8499
  # @!attribute [rw] data_access_role_arn
7320
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
7321
- # (IAM) role that grants Amazon Comprehend read access to your job
7322
- # data.
8500
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
8501
+ # Management (IAM) role that grants Amazon Comprehend read access to
8502
+ # your job data.
7323
8503
  # @return [String]
7324
8504
  #
7325
8505
  # @!attribute [rw] volume_kms_key_id
@@ -7410,6 +8590,44 @@ module Aws::Comprehend
7410
8590
  #
7411
8591
  class UntagResourceResponse < Aws::EmptyStructure; end
7412
8592
 
8593
+ # Data security configuration.
8594
+ #
8595
+ # @!attribute [rw] model_kms_key_id
8596
+ # ID for the AWS Key Management Service (KMS) key that Amazon
8597
+ # Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
8598
+ # can be either of the following formats:
8599
+ #
8600
+ # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
8601
+ #
8602
+ # * Amazon Resource Name (ARN) of a KMS Key:
8603
+ # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
8604
+ # @return [String]
8605
+ #
8606
+ # @!attribute [rw] volume_kms_key_id
8607
+ # ID for the KMS key that Amazon Comprehend uses to encrypt the
8608
+ # volume.
8609
+ # @return [String]
8610
+ #
8611
+ # @!attribute [rw] vpc_config
8612
+ # Configuration parameters for an optional private Virtual Private
8613
+ # Cloud (VPC) containing the resources you are using for the job. For
8614
+ # more information, see [Amazon VPC][1].
8615
+ #
8616
+ #
8617
+ #
8618
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
8619
+ # @return [Types::VpcConfig]
8620
+ #
8621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateDataSecurityConfig AWS API Documentation
8622
+ #
8623
+ class UpdateDataSecurityConfig < Struct.new(
8624
+ :model_kms_key_id,
8625
+ :volume_kms_key_id,
8626
+ :vpc_config)
8627
+ SENSITIVE = []
8628
+ include Aws::Structure
8629
+ end
8630
+
7413
8631
  # @!attribute [rw] endpoint_arn
7414
8632
  # The Amazon Resource Number (ARN) of the endpoint being updated.
7415
8633
  # @return [String]
@@ -7429,20 +8647,74 @@ module Aws::Comprehend
7429
8647
  # a customer CMK.
7430
8648
  # @return [String]
7431
8649
  #
8650
+ # @!attribute [rw] flywheel_arn
8651
+ # The Amazon Resource Number (ARN) of the flywheel
8652
+ # @return [String]
8653
+ #
7432
8654
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointRequest AWS API Documentation
7433
8655
  #
7434
8656
  class UpdateEndpointRequest < Struct.new(
7435
8657
  :endpoint_arn,
7436
8658
  :desired_model_arn,
7437
8659
  :desired_inference_units,
7438
- :desired_data_access_role_arn)
8660
+ :desired_data_access_role_arn,
8661
+ :flywheel_arn)
7439
8662
  SENSITIVE = []
7440
8663
  include Aws::Structure
7441
8664
  end
7442
8665
 
8666
+ # @!attribute [rw] desired_model_arn
8667
+ # The Amazon Resource Number (ARN) of the new model.
8668
+ # @return [String]
8669
+ #
7443
8670
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointResponse AWS API Documentation
7444
8671
  #
7445
- class UpdateEndpointResponse < Aws::EmptyStructure; end
8672
+ class UpdateEndpointResponse < Struct.new(
8673
+ :desired_model_arn)
8674
+ SENSITIVE = []
8675
+ include Aws::Structure
8676
+ end
8677
+
8678
+ # @!attribute [rw] flywheel_arn
8679
+ # The Amazon Resource Number (ARN) of the flywheel to update.
8680
+ # @return [String]
8681
+ #
8682
+ # @!attribute [rw] active_model_arn
8683
+ # The Amazon Resource Number (ARN) of the active model version.
8684
+ # @return [String]
8685
+ #
8686
+ # @!attribute [rw] data_access_role_arn
8687
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
8688
+ # Management (IAM) role that grants Amazon Comprehend permission to
8689
+ # access the flywheel data.
8690
+ # @return [String]
8691
+ #
8692
+ # @!attribute [rw] data_security_config
8693
+ # Flywheel data security configuration.
8694
+ # @return [Types::UpdateDataSecurityConfig]
8695
+ #
8696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheelRequest AWS API Documentation
8697
+ #
8698
+ class UpdateFlywheelRequest < Struct.new(
8699
+ :flywheel_arn,
8700
+ :active_model_arn,
8701
+ :data_access_role_arn,
8702
+ :data_security_config)
8703
+ SENSITIVE = []
8704
+ include Aws::Structure
8705
+ end
8706
+
8707
+ # @!attribute [rw] flywheel_properties
8708
+ # The flywheel properties.
8709
+ # @return [Types::FlywheelProperties]
8710
+ #
8711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheelResponse AWS API Documentation
8712
+ #
8713
+ class UpdateFlywheelResponse < Struct.new(
8714
+ :flywheel_properties)
8715
+ SENSITIVE = []
8716
+ include Aws::Structure
8717
+ end
7446
8718
 
7447
8719
  # Configuration parameters for an optional private Virtual Private Cloud
7448
8720
  # (VPC) containing the resources you are using for the job. For more