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.
@@ -853,6 +853,104 @@ module Aws::Comprehend
853
853
  req.send_request(options)
854
854
  end
855
855
 
856
+ # Creates a dataset to upload training or test data for a model
857
+ # associated with a flywheel. For more information about datasets, see [
858
+ # Flywheel overview][1] in the *Amazon Comprehend Developer Guide*.
859
+ #
860
+ #
861
+ #
862
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
863
+ #
864
+ # @option params [required, String] :flywheel_arn
865
+ # The Amazon Resource Number (ARN) of the flywheel of the flywheel to
866
+ # receive the data.
867
+ #
868
+ # @option params [required, String] :dataset_name
869
+ # Name of the dataset.
870
+ #
871
+ # @option params [String] :dataset_type
872
+ # The dataset type. You can specify that the data in a dataset is for
873
+ # training the model or for testing the model.
874
+ #
875
+ # @option params [String] :description
876
+ # Description of the dataset.
877
+ #
878
+ # @option params [required, Types::DatasetInputDataConfig] :input_data_config
879
+ # Information about the input data configuration. The type of input data
880
+ # varies based on the format of the input and whether the data is for a
881
+ # classifier model or an entity recognition model.
882
+ #
883
+ # @option params [String] :client_request_token
884
+ # A unique identifier for the request. If you don't set the client
885
+ # request token, Amazon Comprehend generates one.
886
+ #
887
+ # **A suitable default value is auto-generated.** You should normally
888
+ # not need to pass this option.**
889
+ #
890
+ # @option params [Array<Types::Tag>] :tags
891
+ # Tags for the dataset.
892
+ #
893
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
894
+ #
895
+ # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
896
+ #
897
+ # @example Request syntax with placeholder values
898
+ #
899
+ # resp = client.create_dataset({
900
+ # flywheel_arn: "ComprehendFlywheelArn", # required
901
+ # dataset_name: "ComprehendArnName", # required
902
+ # dataset_type: "TRAIN", # accepts TRAIN, TEST
903
+ # description: "Description",
904
+ # input_data_config: { # required
905
+ # augmented_manifests: [
906
+ # {
907
+ # attribute_names: ["AttributeNamesListItem"], # required
908
+ # s3_uri: "S3Uri", # required
909
+ # annotation_data_s3_uri: "S3Uri",
910
+ # source_documents_s3_uri: "S3Uri",
911
+ # document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
912
+ # },
913
+ # ],
914
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
915
+ # document_classifier_input_data_config: {
916
+ # s3_uri: "S3Uri", # required
917
+ # label_delimiter: "LabelDelimiter",
918
+ # },
919
+ # entity_recognizer_input_data_config: {
920
+ # annotations: {
921
+ # s3_uri: "S3Uri", # required
922
+ # },
923
+ # documents: { # required
924
+ # s3_uri: "S3Uri", # required
925
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
926
+ # },
927
+ # entity_list: {
928
+ # s3_uri: "S3Uri", # required
929
+ # },
930
+ # },
931
+ # },
932
+ # client_request_token: "ClientRequestTokenString",
933
+ # tags: [
934
+ # {
935
+ # key: "TagKey", # required
936
+ # value: "TagValue",
937
+ # },
938
+ # ],
939
+ # })
940
+ #
941
+ # @example Response structure
942
+ #
943
+ # resp.dataset_arn #=> String
944
+ #
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDataset AWS API Documentation
946
+ #
947
+ # @overload create_dataset(params = {})
948
+ # @param [Hash] params ({})
949
+ def create_dataset(params = {}, options = {})
950
+ req = build_request(:create_dataset, params)
951
+ req.send_request(options)
952
+ end
953
+
856
954
  # Creates a new document classifier that you can use to categorize
857
955
  # documents. To create a classifier, you provide a set of training
858
956
  # documents that labeled with the categories that you want to use. After
@@ -875,15 +973,15 @@ module Aws::Comprehend
875
973
  # Region.
876
974
  #
877
975
  # @option params [required, String] :data_access_role_arn
878
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
879
- # (IAM) role that grants Amazon Comprehend read access to your input
880
- # data.
976
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
977
+ # Management (IAM) role that grants Amazon Comprehend read access to
978
+ # your input data.
881
979
  #
882
980
  # @option params [Array<Types::Tag>] :tags
883
- # Tags to be associated with the document classifier being created. A
884
- # tag is a key-value pair that adds as a metadata to a resource used by
885
- # Amazon Comprehend. For example, a tag with "Sales" as the key might
886
- # be added to a resource to indicate its use by the sales department.
981
+ # Tags to associate with the document classifier. A tag is a key-value
982
+ # pair that adds as a metadata to a resource used by Amazon Comprehend.
983
+ # For example, a tag with "Sales" as the key might be added to a
984
+ # resource to indicate its use by the sales department.
887
985
  #
888
986
  # @option params [required, Types::DocumentClassifierInputDataConfig] :input_data_config
889
987
  # Specifies the format and location of the input data for the job.
@@ -901,9 +999,8 @@ module Aws::Comprehend
901
999
  #
902
1000
  # @option params [required, String] :language_code
903
1001
  # The language of the input documents. You can specify any of the
904
- # following languages supported by Amazon Comprehend: German ("de"),
905
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
906
- # or Portuguese ("pt"). All documents must be in the same language.
1002
+ # languages supported by Amazon Comprehend. All documents must be in the
1003
+ # same language.
907
1004
  #
908
1005
  # @option params [String] :volume_kms_key_id
909
1006
  # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
@@ -996,6 +1093,7 @@ module Aws::Comprehend
996
1093
  # output_data_config: {
997
1094
  # s3_uri: "S3Uri",
998
1095
  # kms_key_id: "KmsKeyId",
1096
+ # flywheel_stats_s3_prefix: "S3Uri",
999
1097
  # },
1000
1098
  # client_request_token: "ClientRequestTokenString",
1001
1099
  # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
@@ -1034,7 +1132,7 @@ module Aws::Comprehend
1034
1132
  # This is the descriptive suffix that becomes part of the `EndpointArn`
1035
1133
  # used for all subsequent requests to this resource.
1036
1134
  #
1037
- # @option params [required, String] :model_arn
1135
+ # @option params [String] :model_arn
1038
1136
  # The Amazon Resource Number (ARN) of the model to which the endpoint
1039
1137
  # will be attached.
1040
1138
  #
@@ -1052,26 +1150,31 @@ module Aws::Comprehend
1052
1150
  # not need to pass this option.**
1053
1151
  #
1054
1152
  # @option params [Array<Types::Tag>] :tags
1055
- # Tags associated with the endpoint being created. A tag is a key-value
1056
- # pair that adds metadata to the endpoint. For example, a tag with
1057
- # "Sales" as the key might be added to an endpoint to indicate its use
1058
- # by the sales department.
1153
+ # Tags to associate with the endpoint. A tag is a key-value pair that
1154
+ # adds metadata to the endpoint. For example, a tag with "Sales" as
1155
+ # the key might be added to an endpoint to indicate its use by the sales
1156
+ # department.
1059
1157
  #
1060
1158
  # @option params [String] :data_access_role_arn
1061
- # The Amazon Resource Name (ARN) of the AWS identity and Access
1159
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1062
1160
  # Management (IAM) role that grants Amazon Comprehend read access to
1063
1161
  # trained custom models encrypted with a customer managed key
1064
1162
  # (ModelKmsKeyId).
1065
1163
  #
1164
+ # @option params [String] :flywheel_arn
1165
+ # The Amazon Resource Number (ARN) of the flywheel to which the endpoint
1166
+ # will be attached.
1167
+ #
1066
1168
  # @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1067
1169
  #
1068
1170
  # * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
1171
+ # * {Types::CreateEndpointResponse#model_arn #model_arn} => String
1069
1172
  #
1070
1173
  # @example Request syntax with placeholder values
1071
1174
  #
1072
1175
  # resp = client.create_endpoint({
1073
1176
  # endpoint_name: "ComprehendEndpointName", # required
1074
- # model_arn: "ComprehendModelArn", # required
1177
+ # model_arn: "ComprehendModelArn",
1075
1178
  # desired_inference_units: 1, # required
1076
1179
  # client_request_token: "ClientRequestTokenString",
1077
1180
  # tags: [
@@ -1081,11 +1184,13 @@ module Aws::Comprehend
1081
1184
  # },
1082
1185
  # ],
1083
1186
  # data_access_role_arn: "IamRoleArn",
1187
+ # flywheel_arn: "ComprehendFlywheelArn",
1084
1188
  # })
1085
1189
  #
1086
1190
  # @example Response structure
1087
1191
  #
1088
1192
  # resp.endpoint_arn #=> String
1193
+ # resp.model_arn #=> String
1089
1194
  #
1090
1195
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint AWS API Documentation
1091
1196
  #
@@ -1098,7 +1203,7 @@ module Aws::Comprehend
1098
1203
 
1099
1204
  # Creates an entity recognizer using submitted files. After your
1100
1205
  # `CreateEntityRecognizer` request is submitted, you can check job
1101
- # status using the API.
1206
+ # status using the `DescribeEntityRecognizer` API.
1102
1207
  #
1103
1208
  # @option params [required, String] :recognizer_name
1104
1209
  # The name given to the newly created recognizer. Recognizer names can
@@ -1114,15 +1219,15 @@ module Aws::Comprehend
1114
1219
  # Region.
1115
1220
  #
1116
1221
  # @option params [required, String] :data_access_role_arn
1117
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
1118
- # (IAM) role that grants Amazon Comprehend read access to your input
1119
- # data.
1222
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1223
+ # Management (IAM) role that grants Amazon Comprehend read access to
1224
+ # your input data.
1120
1225
  #
1121
1226
  # @option params [Array<Types::Tag>] :tags
1122
- # Tags to be associated with the entity recognizer being created. A tag
1123
- # is a key-value pair that adds as a metadata to a resource used by
1124
- # Amazon Comprehend. For example, a tag with "Sales" as the key might
1125
- # be added to a resource to indicate its use by the sales department.
1227
+ # Tags to associate with the entity recognizer. A tag is a key-value
1228
+ # pair that adds as a metadata to a resource used by Amazon Comprehend.
1229
+ # For example, a tag with "Sales" as the key might be added to a
1230
+ # resource to indicate its use by the sales department.
1126
1231
  #
1127
1232
  # @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
1128
1233
  # Specifies the format and location of the input data. The S3 bucket
@@ -1166,7 +1271,7 @@ module Aws::Comprehend
1166
1271
  # @option params [String] :model_kms_key_id
1167
1272
  # ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
1168
1273
  # uses to encrypt trained custom models. The ModelKmsKeyId can be either
1169
- # of the following formats
1274
+ # of the following formats:
1170
1275
  #
1171
1276
  # * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
1172
1277
  #
@@ -1261,6 +1366,126 @@ module Aws::Comprehend
1261
1366
  req.send_request(options)
1262
1367
  end
1263
1368
 
1369
+ # A flywheel is an AWS resource that orchestrates the ongoing training
1370
+ # of a model for custom classification or custom entity recognition. You
1371
+ # can create a flywheel to start with an existing trained model, or
1372
+ # Comprehend can create and train a new model.
1373
+ #
1374
+ # When you create the flywheel, Comprehend creates a data lake in your
1375
+ # account. The data lake holds the training data and test data for all
1376
+ # versions of the model.
1377
+ #
1378
+ # To use a flywheel with an existing trained model, you specify the
1379
+ # active model version. Comprehend copies the model's training data and
1380
+ # test data into the flywheel's data lake.
1381
+ #
1382
+ # To use the flywheel with a new model, you need to provide a dataset
1383
+ # for training data (and optional test data) when you create the
1384
+ # flywheel.
1385
+ #
1386
+ # For more information about flywheels, see [ Flywheel overview][1] in
1387
+ # the *Amazon Comprehend Developer Guide*.
1388
+ #
1389
+ #
1390
+ #
1391
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
1392
+ #
1393
+ # @option params [required, String] :flywheel_name
1394
+ # Name for the flywheel.
1395
+ #
1396
+ # @option params [String] :active_model_arn
1397
+ # To associate an existing model with the flywheel, specify the Amazon
1398
+ # Resource Number (ARN) of the model version.
1399
+ #
1400
+ # @option params [required, String] :data_access_role_arn
1401
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1402
+ # Management (IAM) role that grants Amazon Comprehend the permissions
1403
+ # required to access the flywheel data in the data lake.
1404
+ #
1405
+ # @option params [Types::TaskConfig] :task_config
1406
+ # Configuration about the custom classifier associated with the
1407
+ # flywheel.
1408
+ #
1409
+ # @option params [String] :model_type
1410
+ # The model type.
1411
+ #
1412
+ # @option params [required, String] :data_lake_s3_uri
1413
+ # Enter the S3 location for the data lake. You can specify a new S3
1414
+ # bucket or a new folder of an existing S3 bucket. The flywheel creates
1415
+ # the data lake at this location.
1416
+ #
1417
+ # @option params [Types::DataSecurityConfig] :data_security_config
1418
+ # Data security configurations.
1419
+ #
1420
+ # @option params [String] :client_request_token
1421
+ # A unique identifier for the request. If you don't set the client
1422
+ # request token, Amazon Comprehend generates one.
1423
+ #
1424
+ # **A suitable default value is auto-generated.** You should normally
1425
+ # not need to pass this option.**
1426
+ #
1427
+ # @option params [Array<Types::Tag>] :tags
1428
+ # The tags to associate with this flywheel.
1429
+ #
1430
+ # @return [Types::CreateFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1431
+ #
1432
+ # * {Types::CreateFlywheelResponse#flywheel_arn #flywheel_arn} => String
1433
+ # * {Types::CreateFlywheelResponse#active_model_arn #active_model_arn} => String
1434
+ #
1435
+ # @example Request syntax with placeholder values
1436
+ #
1437
+ # resp = client.create_flywheel({
1438
+ # flywheel_name: "ComprehendArnName", # required
1439
+ # active_model_arn: "ComprehendModelArn",
1440
+ # data_access_role_arn: "IamRoleArn", # required
1441
+ # task_config: {
1442
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1443
+ # document_classification_config: {
1444
+ # mode: "MULTI_CLASS", # required, accepts MULTI_CLASS, MULTI_LABEL
1445
+ # labels: ["LabelListItem"],
1446
+ # },
1447
+ # entity_recognition_config: {
1448
+ # entity_types: [ # required
1449
+ # {
1450
+ # type: "EntityTypeName", # required
1451
+ # },
1452
+ # ],
1453
+ # },
1454
+ # },
1455
+ # model_type: "DOCUMENT_CLASSIFIER", # accepts DOCUMENT_CLASSIFIER, ENTITY_RECOGNIZER
1456
+ # data_lake_s3_uri: "FlywheelS3Uri", # required
1457
+ # data_security_config: {
1458
+ # model_kms_key_id: "KmsKeyId",
1459
+ # volume_kms_key_id: "KmsKeyId",
1460
+ # data_lake_kms_key_id: "KmsKeyId",
1461
+ # vpc_config: {
1462
+ # security_group_ids: ["SecurityGroupId"], # required
1463
+ # subnets: ["SubnetId"], # required
1464
+ # },
1465
+ # },
1466
+ # client_request_token: "ClientRequestTokenString",
1467
+ # tags: [
1468
+ # {
1469
+ # key: "TagKey", # required
1470
+ # value: "TagValue",
1471
+ # },
1472
+ # ],
1473
+ # })
1474
+ #
1475
+ # @example Response structure
1476
+ #
1477
+ # resp.flywheel_arn #=> String
1478
+ # resp.active_model_arn #=> String
1479
+ #
1480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheel AWS API Documentation
1481
+ #
1482
+ # @overload create_flywheel(params = {})
1483
+ # @param [Hash] params ({})
1484
+ def create_flywheel(params = {}, options = {})
1485
+ req = build_request(:create_flywheel, params)
1486
+ req.send_request(options)
1487
+ end
1488
+
1264
1489
  # Deletes a previously created document classifier
1265
1490
  #
1266
1491
  # Only those classifiers that are in terminated states (IN\_ERROR,
@@ -1352,6 +1577,37 @@ module Aws::Comprehend
1352
1577
  req.send_request(options)
1353
1578
  end
1354
1579
 
1580
+ # Deletes a flywheel. When you delete the flywheel, Amazon Comprehend
1581
+ # does not delete the data lake or the model associated with the
1582
+ # flywheel.
1583
+ #
1584
+ # For more information about flywheels, see [ Flywheel overview][1] in
1585
+ # the *Amazon Comprehend Developer Guide*.
1586
+ #
1587
+ #
1588
+ #
1589
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
1590
+ #
1591
+ # @option params [required, String] :flywheel_arn
1592
+ # The Amazon Resource Number (ARN) of the flywheel to delete.
1593
+ #
1594
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1595
+ #
1596
+ # @example Request syntax with placeholder values
1597
+ #
1598
+ # resp = client.delete_flywheel({
1599
+ # flywheel_arn: "ComprehendFlywheelArn", # required
1600
+ # })
1601
+ #
1602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheel AWS API Documentation
1603
+ #
1604
+ # @overload delete_flywheel(params = {})
1605
+ # @param [Hash] params ({})
1606
+ def delete_flywheel(params = {}, options = {})
1607
+ req = build_request(:delete_flywheel, params)
1608
+ req.send_request(options)
1609
+ end
1610
+
1355
1611
  # Deletes a resource-based policy that is attached to a custom model.
1356
1612
  #
1357
1613
  # @option params [required, String] :resource_arn
@@ -1379,12 +1635,56 @@ module Aws::Comprehend
1379
1635
  req.send_request(options)
1380
1636
  end
1381
1637
 
1638
+ # Returns information about the dataset that you specify. For more
1639
+ # information about datasets, see [ Flywheel overview][1] in the *Amazon
1640
+ # Comprehend Developer Guide*.
1641
+ #
1642
+ #
1643
+ #
1644
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
1645
+ #
1646
+ # @option params [required, String] :dataset_arn
1647
+ # The ARN of the dataset.
1648
+ #
1649
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1650
+ #
1651
+ # * {Types::DescribeDatasetResponse#dataset_properties #dataset_properties} => Types::DatasetProperties
1652
+ #
1653
+ # @example Request syntax with placeholder values
1654
+ #
1655
+ # resp = client.describe_dataset({
1656
+ # dataset_arn: "ComprehendDatasetArn", # required
1657
+ # })
1658
+ #
1659
+ # @example Response structure
1660
+ #
1661
+ # resp.dataset_properties.dataset_arn #=> String
1662
+ # resp.dataset_properties.dataset_name #=> String
1663
+ # resp.dataset_properties.dataset_type #=> String, one of "TRAIN", "TEST"
1664
+ # resp.dataset_properties.dataset_s3_uri #=> String
1665
+ # resp.dataset_properties.description #=> String
1666
+ # resp.dataset_properties.status #=> String, one of "CREATING", "COMPLETED", "FAILED"
1667
+ # resp.dataset_properties.message #=> String
1668
+ # resp.dataset_properties.number_of_documents #=> Integer
1669
+ # resp.dataset_properties.creation_time #=> Time
1670
+ # resp.dataset_properties.end_time #=> Time
1671
+ #
1672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDataset AWS API Documentation
1673
+ #
1674
+ # @overload describe_dataset(params = {})
1675
+ # @param [Hash] params ({})
1676
+ def describe_dataset(params = {}, options = {})
1677
+ req = build_request(:describe_dataset, params)
1678
+ req.send_request(options)
1679
+ end
1680
+
1382
1681
  # Gets the properties associated with a document classification job. Use
1383
1682
  # this operation to get the status of a classification job.
1384
1683
  #
1385
1684
  # @option params [required, String] :job_id
1386
1685
  # The identifier that Amazon Comprehend generated for the job. The
1387
- # operation returns this identifier in its response.
1686
+ # `StartDocumentClassificationJob` operation returns this identifier in
1687
+ # its response.
1388
1688
  #
1389
1689
  # @return [Types::DescribeDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1390
1690
  #
@@ -1420,6 +1720,7 @@ module Aws::Comprehend
1420
1720
  # resp.document_classification_job_properties.vpc_config.security_group_ids[0] #=> String
1421
1721
  # resp.document_classification_job_properties.vpc_config.subnets #=> Array
1422
1722
  # resp.document_classification_job_properties.vpc_config.subnets[0] #=> String
1723
+ # resp.document_classification_job_properties.flywheel_arn #=> String
1423
1724
  #
1424
1725
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob AWS API Documentation
1425
1726
  #
@@ -1434,7 +1735,8 @@ module Aws::Comprehend
1434
1735
  #
1435
1736
  # @option params [required, String] :document_classifier_arn
1436
1737
  # The Amazon Resource Name (ARN) that identifies the document
1437
- # classifier. The operation returns this identifier in its response.
1738
+ # classifier. The `CreateDocumentClassifier` operation returns this
1739
+ # identifier in its response.
1438
1740
  #
1439
1741
  # @return [Types::DescribeDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1440
1742
  #
@@ -1470,6 +1772,7 @@ module Aws::Comprehend
1470
1772
  # resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
1471
1773
  # resp.document_classifier_properties.output_data_config.s3_uri #=> String
1472
1774
  # resp.document_classifier_properties.output_data_config.kms_key_id #=> String
1775
+ # resp.document_classifier_properties.output_data_config.flywheel_stats_s3_prefix #=> String
1473
1776
  # resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
1474
1777
  # resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
1475
1778
  # resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
@@ -1491,6 +1794,7 @@ module Aws::Comprehend
1491
1794
  # resp.document_classifier_properties.model_kms_key_id #=> String
1492
1795
  # resp.document_classifier_properties.version_name #=> String
1493
1796
  # resp.document_classifier_properties.source_model_arn #=> String
1797
+ # resp.document_classifier_properties.flywheel_arn #=> String
1494
1798
  #
1495
1799
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
1496
1800
  #
@@ -1506,7 +1810,8 @@ module Aws::Comprehend
1506
1810
  #
1507
1811
  # @option params [required, String] :job_id
1508
1812
  # The identifier that Amazon Comprehend generated for the job. The
1509
- # operation returns this identifier in its response.
1813
+ # `StartDominantLanguageDetectionJob` operation returns this identifier
1814
+ # in its response.
1510
1815
  #
1511
1816
  # @return [Types::DescribeDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1512
1817
  #
@@ -1585,6 +1890,7 @@ module Aws::Comprehend
1585
1890
  # resp.endpoint_properties.last_modified_time #=> Time
1586
1891
  # resp.endpoint_properties.data_access_role_arn #=> String
1587
1892
  # resp.endpoint_properties.desired_data_access_role_arn #=> String
1893
+ # resp.endpoint_properties.flywheel_arn #=> String
1588
1894
  #
1589
1895
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
1590
1896
  #
@@ -1600,7 +1906,8 @@ module Aws::Comprehend
1600
1906
  #
1601
1907
  # @option params [required, String] :job_id
1602
1908
  # The identifier that Amazon Comprehend generated for the job. The
1603
- # operation returns this identifier in its response.
1909
+ # `StartEntitiesDetectionJob` operation returns this identifier in its
1910
+ # response.
1604
1911
  #
1605
1912
  # @return [Types::DescribeEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1606
1913
  #
@@ -1711,6 +2018,8 @@ module Aws::Comprehend
1711
2018
  # resp.entity_recognizer_properties.model_kms_key_id #=> String
1712
2019
  # resp.entity_recognizer_properties.version_name #=> String
1713
2020
  # resp.entity_recognizer_properties.source_model_arn #=> String
2021
+ # resp.entity_recognizer_properties.flywheel_arn #=> String
2022
+ # resp.entity_recognizer_properties.output_data_config.flywheel_stats_s3_prefix #=> String
1714
2023
  #
1715
2024
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
1716
2025
  #
@@ -1767,12 +2076,121 @@ module Aws::Comprehend
1767
2076
  req.send_request(options)
1768
2077
  end
1769
2078
 
2079
+ # Provides configuration information about the flywheel. For more
2080
+ # information about flywheels, see [ Flywheel overview][1] in the
2081
+ # *Amazon Comprehend Developer Guide*.
2082
+ #
2083
+ #
2084
+ #
2085
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
2086
+ #
2087
+ # @option params [required, String] :flywheel_arn
2088
+ # The Amazon Resource Number (ARN) of the flywheel.
2089
+ #
2090
+ # @return [Types::DescribeFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2091
+ #
2092
+ # * {Types::DescribeFlywheelResponse#flywheel_properties #flywheel_properties} => Types::FlywheelProperties
2093
+ #
2094
+ # @example Request syntax with placeholder values
2095
+ #
2096
+ # resp = client.describe_flywheel({
2097
+ # flywheel_arn: "ComprehendFlywheelArn", # required
2098
+ # })
2099
+ #
2100
+ # @example Response structure
2101
+ #
2102
+ # resp.flywheel_properties.flywheel_arn #=> String
2103
+ # resp.flywheel_properties.active_model_arn #=> String
2104
+ # resp.flywheel_properties.data_access_role_arn #=> String
2105
+ # resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
2106
+ # resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
2107
+ # resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
2108
+ # resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
2109
+ # resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
2110
+ # resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
2111
+ # resp.flywheel_properties.data_lake_s3_uri #=> String
2112
+ # resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
2113
+ # resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
2114
+ # resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
2115
+ # resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
2116
+ # resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
2117
+ # resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
2118
+ # resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
2119
+ # resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
2120
+ # resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
2121
+ # resp.flywheel_properties.message #=> String
2122
+ # resp.flywheel_properties.creation_time #=> Time
2123
+ # resp.flywheel_properties.last_modified_time #=> Time
2124
+ # resp.flywheel_properties.latest_flywheel_iteration #=> String
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel AWS API Documentation
2127
+ #
2128
+ # @overload describe_flywheel(params = {})
2129
+ # @param [Hash] params ({})
2130
+ def describe_flywheel(params = {}, options = {})
2131
+ req = build_request(:describe_flywheel, params)
2132
+ req.send_request(options)
2133
+ end
2134
+
2135
+ # Retrieve the configuration properties of a flywheel iteration. For
2136
+ # more information about flywheels, see [ Flywheel overview][1] in the
2137
+ # *Amazon Comprehend Developer Guide*.
2138
+ #
2139
+ #
2140
+ #
2141
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
2142
+ #
2143
+ # @option params [required, String] :flywheel_arn
2144
+ #
2145
+ # @option params [required, String] :flywheel_iteration_id
2146
+ #
2147
+ # @return [Types::DescribeFlywheelIterationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2148
+ #
2149
+ # * {Types::DescribeFlywheelIterationResponse#flywheel_iteration_properties #flywheel_iteration_properties} => Types::FlywheelIterationProperties
2150
+ #
2151
+ # @example Request syntax with placeholder values
2152
+ #
2153
+ # resp = client.describe_flywheel_iteration({
2154
+ # flywheel_arn: "ComprehendFlywheelArn", # required
2155
+ # flywheel_iteration_id: "FlywheelIterationId", # required
2156
+ # })
2157
+ #
2158
+ # @example Response structure
2159
+ #
2160
+ # resp.flywheel_iteration_properties.flywheel_arn #=> String
2161
+ # resp.flywheel_iteration_properties.flywheel_iteration_id #=> String
2162
+ # resp.flywheel_iteration_properties.creation_time #=> Time
2163
+ # resp.flywheel_iteration_properties.end_time #=> Time
2164
+ # resp.flywheel_iteration_properties.status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
2165
+ # resp.flywheel_iteration_properties.message #=> String
2166
+ # resp.flywheel_iteration_properties.evaluated_model_arn #=> String
2167
+ # resp.flywheel_iteration_properties.evaluated_model_metrics.average_f1_score #=> Float
2168
+ # resp.flywheel_iteration_properties.evaluated_model_metrics.average_precision #=> Float
2169
+ # resp.flywheel_iteration_properties.evaluated_model_metrics.average_recall #=> Float
2170
+ # resp.flywheel_iteration_properties.evaluated_model_metrics.average_accuracy #=> Float
2171
+ # resp.flywheel_iteration_properties.trained_model_arn #=> String
2172
+ # resp.flywheel_iteration_properties.trained_model_metrics.average_f1_score #=> Float
2173
+ # resp.flywheel_iteration_properties.trained_model_metrics.average_precision #=> Float
2174
+ # resp.flywheel_iteration_properties.trained_model_metrics.average_recall #=> Float
2175
+ # resp.flywheel_iteration_properties.trained_model_metrics.average_accuracy #=> Float
2176
+ # resp.flywheel_iteration_properties.evaluation_manifest_s3_prefix #=> String
2177
+ #
2178
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration AWS API Documentation
2179
+ #
2180
+ # @overload describe_flywheel_iteration(params = {})
2181
+ # @param [Hash] params ({})
2182
+ def describe_flywheel_iteration(params = {}, options = {})
2183
+ req = build_request(:describe_flywheel_iteration, params)
2184
+ req.send_request(options)
2185
+ end
2186
+
1770
2187
  # Gets the properties associated with a key phrases detection job. Use
1771
2188
  # this operation to get the status of a detection job.
1772
2189
  #
1773
2190
  # @option params [required, String] :job_id
1774
2191
  # The identifier that Amazon Comprehend generated for the job. The
1775
- # operation returns this identifier in its response.
2192
+ # `StartKeyPhrasesDetectionJob` operation returns this identifier in its
2193
+ # response.
1776
2194
  #
1777
2195
  # @return [Types::DescribeKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1778
2196
  #
@@ -1961,7 +2379,8 @@ module Aws::Comprehend
1961
2379
  #
1962
2380
  # @option params [required, String] :job_id
1963
2381
  # The identifier that Amazon Comprehend generated for the job. The
1964
- # operation returns this identifier in its response.
2382
+ # `StartTargetedSentimentDetectionJob` operation returns this identifier
2383
+ # in its response.
1965
2384
  #
1966
2385
  # @return [Types::DescribeTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1967
2386
  #
@@ -2516,12 +2935,13 @@ module Aws::Comprehend
2516
2935
  # `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
2517
2936
  #
2518
2937
  # @option params [String] :data_access_role_arn
2519
- # The Amazon Resource Name (ARN) of the AWS Identity and Management
2520
- # (IAM) role that allows Amazon Comprehend to use Amazon Key Management
2521
- # Service (KMS) to encrypt or decrypt the custom model.
2938
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
2939
+ # Management (IAM) role that grants Amazon Comprehend permission to use
2940
+ # Amazon Key Management Service (KMS) to encrypt or decrypt the custom
2941
+ # model.
2522
2942
  #
2523
2943
  # @option params [Array<Types::Tag>] :tags
2524
- # Tags to be associated with the custom model that is created by this
2944
+ # Tags to associate with the custom model that is created by this
2525
2945
  # import. A tag is a key-value pair that adds as a metadata to a
2526
2946
  # resource used by Amazon Comprehend. For example, a tag with "Sales"
2527
2947
  # as the key might be added to a resource to indicate its use by the
@@ -2560,6 +2980,71 @@ module Aws::Comprehend
2560
2980
  req.send_request(options)
2561
2981
  end
2562
2982
 
2983
+ # List the datasets that you have configured in this region. For more
2984
+ # information about datasets, see [ Flywheel overview][1] in the *Amazon
2985
+ # Comprehend Developer Guide*.
2986
+ #
2987
+ #
2988
+ #
2989
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
2990
+ #
2991
+ # @option params [String] :flywheel_arn
2992
+ # The Amazon Resource Number (ARN) of the flywheel.
2993
+ #
2994
+ # @option params [Types::DatasetFilter] :filter
2995
+ # Filters the datasets to be returned in the response.
2996
+ #
2997
+ # @option params [String] :next_token
2998
+ # Identifies the next page of results to return.
2999
+ #
3000
+ # @option params [Integer] :max_results
3001
+ # Maximum number of results to return in a response. The default is 100.
3002
+ #
3003
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3004
+ #
3005
+ # * {Types::ListDatasetsResponse#dataset_properties_list #dataset_properties_list} => Array&lt;Types::DatasetProperties&gt;
3006
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
3007
+ #
3008
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3009
+ #
3010
+ # @example Request syntax with placeholder values
3011
+ #
3012
+ # resp = client.list_datasets({
3013
+ # flywheel_arn: "ComprehendFlywheelArn",
3014
+ # filter: {
3015
+ # status: "CREATING", # accepts CREATING, COMPLETED, FAILED
3016
+ # dataset_type: "TRAIN", # accepts TRAIN, TEST
3017
+ # creation_time_after: Time.now,
3018
+ # creation_time_before: Time.now,
3019
+ # },
3020
+ # next_token: "String",
3021
+ # max_results: 1,
3022
+ # })
3023
+ #
3024
+ # @example Response structure
3025
+ #
3026
+ # resp.dataset_properties_list #=> Array
3027
+ # resp.dataset_properties_list[0].dataset_arn #=> String
3028
+ # resp.dataset_properties_list[0].dataset_name #=> String
3029
+ # resp.dataset_properties_list[0].dataset_type #=> String, one of "TRAIN", "TEST"
3030
+ # resp.dataset_properties_list[0].dataset_s3_uri #=> String
3031
+ # resp.dataset_properties_list[0].description #=> String
3032
+ # resp.dataset_properties_list[0].status #=> String, one of "CREATING", "COMPLETED", "FAILED"
3033
+ # resp.dataset_properties_list[0].message #=> String
3034
+ # resp.dataset_properties_list[0].number_of_documents #=> Integer
3035
+ # resp.dataset_properties_list[0].creation_time #=> Time
3036
+ # resp.dataset_properties_list[0].end_time #=> Time
3037
+ # resp.next_token #=> String
3038
+ #
3039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets AWS API Documentation
3040
+ #
3041
+ # @overload list_datasets(params = {})
3042
+ # @param [Hash] params ({})
3043
+ def list_datasets(params = {}, options = {})
3044
+ req = build_request(:list_datasets, params)
3045
+ req.send_request(options)
3046
+ end
3047
+
2563
3048
  # Gets a list of the documentation classification jobs that you have
2564
3049
  # submitted.
2565
3050
  #
@@ -2620,6 +3105,7 @@ module Aws::Comprehend
2620
3105
  # resp.document_classification_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
2621
3106
  # resp.document_classification_job_properties_list[0].vpc_config.subnets #=> Array
2622
3107
  # resp.document_classification_job_properties_list[0].vpc_config.subnets[0] #=> String
3108
+ # resp.document_classification_job_properties_list[0].flywheel_arn #=> String
2623
3109
  # resp.next_token #=> String
2624
3110
  #
2625
3111
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs AWS API Documentation
@@ -2733,6 +3219,7 @@ module Aws::Comprehend
2733
3219
  # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
2734
3220
  # resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
2735
3221
  # resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
3222
+ # resp.document_classifier_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
2736
3223
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
2737
3224
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
2738
3225
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
@@ -2754,6 +3241,7 @@ module Aws::Comprehend
2754
3241
  # resp.document_classifier_properties_list[0].model_kms_key_id #=> String
2755
3242
  # resp.document_classifier_properties_list[0].version_name #=> String
2756
3243
  # resp.document_classifier_properties_list[0].source_model_arn #=> String
3244
+ # resp.document_classifier_properties_list[0].flywheel_arn #=> String
2757
3245
  # resp.next_token #=> String
2758
3246
  #
2759
3247
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
@@ -2888,6 +3376,7 @@ module Aws::Comprehend
2888
3376
  # resp.endpoint_properties_list[0].last_modified_time #=> Time
2889
3377
  # resp.endpoint_properties_list[0].data_access_role_arn #=> String
2890
3378
  # resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
3379
+ # resp.endpoint_properties_list[0].flywheel_arn #=> String
2891
3380
  # resp.next_token #=> String
2892
3381
  #
2893
3382
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
@@ -3102,6 +3591,8 @@ module Aws::Comprehend
3102
3591
  # resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
3103
3592
  # resp.entity_recognizer_properties_list[0].version_name #=> String
3104
3593
  # resp.entity_recognizer_properties_list[0].source_model_arn #=> String
3594
+ # resp.entity_recognizer_properties_list[0].flywheel_arn #=> String
3595
+ # resp.entity_recognizer_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
3105
3596
  # resp.next_token #=> String
3106
3597
  #
3107
3598
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
@@ -3179,6 +3670,131 @@ module Aws::Comprehend
3179
3670
  req.send_request(options)
3180
3671
  end
3181
3672
 
3673
+ # Information about the history of a flywheel iteration. For more
3674
+ # information about flywheels, see [ Flywheel overview][1] in the
3675
+ # *Amazon Comprehend Developer Guide*.
3676
+ #
3677
+ #
3678
+ #
3679
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
3680
+ #
3681
+ # @option params [required, String] :flywheel_arn
3682
+ # The ARN of the flywheel.
3683
+ #
3684
+ # @option params [Types::FlywheelIterationFilter] :filter
3685
+ # Filter the flywheel iteration history based on creation time.
3686
+ #
3687
+ # @option params [String] :next_token
3688
+ # Next token
3689
+ #
3690
+ # @option params [Integer] :max_results
3691
+ # Maximum number of iteration history results to return
3692
+ #
3693
+ # @return [Types::ListFlywheelIterationHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3694
+ #
3695
+ # * {Types::ListFlywheelIterationHistoryResponse#flywheel_iteration_properties_list #flywheel_iteration_properties_list} => Array&lt;Types::FlywheelIterationProperties&gt;
3696
+ # * {Types::ListFlywheelIterationHistoryResponse#next_token #next_token} => String
3697
+ #
3698
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3699
+ #
3700
+ # @example Request syntax with placeholder values
3701
+ #
3702
+ # resp = client.list_flywheel_iteration_history({
3703
+ # flywheel_arn: "ComprehendFlywheelArn", # required
3704
+ # filter: {
3705
+ # creation_time_after: Time.now,
3706
+ # creation_time_before: Time.now,
3707
+ # },
3708
+ # next_token: "String",
3709
+ # max_results: 1,
3710
+ # })
3711
+ #
3712
+ # @example Response structure
3713
+ #
3714
+ # resp.flywheel_iteration_properties_list #=> Array
3715
+ # resp.flywheel_iteration_properties_list[0].flywheel_arn #=> String
3716
+ # resp.flywheel_iteration_properties_list[0].flywheel_iteration_id #=> String
3717
+ # resp.flywheel_iteration_properties_list[0].creation_time #=> Time
3718
+ # resp.flywheel_iteration_properties_list[0].end_time #=> Time
3719
+ # resp.flywheel_iteration_properties_list[0].status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
3720
+ # resp.flywheel_iteration_properties_list[0].message #=> String
3721
+ # resp.flywheel_iteration_properties_list[0].evaluated_model_arn #=> String
3722
+ # resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_f1_score #=> Float
3723
+ # resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_precision #=> Float
3724
+ # resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_recall #=> Float
3725
+ # resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_accuracy #=> Float
3726
+ # resp.flywheel_iteration_properties_list[0].trained_model_arn #=> String
3727
+ # resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_f1_score #=> Float
3728
+ # resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_precision #=> Float
3729
+ # resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_recall #=> Float
3730
+ # resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_accuracy #=> Float
3731
+ # resp.flywheel_iteration_properties_list[0].evaluation_manifest_s3_prefix #=> String
3732
+ # resp.next_token #=> String
3733
+ #
3734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory AWS API Documentation
3735
+ #
3736
+ # @overload list_flywheel_iteration_history(params = {})
3737
+ # @param [Hash] params ({})
3738
+ def list_flywheel_iteration_history(params = {}, options = {})
3739
+ req = build_request(:list_flywheel_iteration_history, params)
3740
+ req.send_request(options)
3741
+ end
3742
+
3743
+ # Gets a list of the flywheels that you have created.
3744
+ #
3745
+ # @option params [Types::FlywheelFilter] :filter
3746
+ # Filters the flywheels that are returned. You can filter flywheels on
3747
+ # their status, or the date and time that they were submitted. You can
3748
+ # only set one filter at a time.
3749
+ #
3750
+ # @option params [String] :next_token
3751
+ # Identifies the next page of results to return.
3752
+ #
3753
+ # @option params [Integer] :max_results
3754
+ # Maximum number of results to return in a response. The default is 100.
3755
+ #
3756
+ # @return [Types::ListFlywheelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3757
+ #
3758
+ # * {Types::ListFlywheelsResponse#flywheel_summary_list #flywheel_summary_list} => Array&lt;Types::FlywheelSummary&gt;
3759
+ # * {Types::ListFlywheelsResponse#next_token #next_token} => String
3760
+ #
3761
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3762
+ #
3763
+ # @example Request syntax with placeholder values
3764
+ #
3765
+ # resp = client.list_flywheels({
3766
+ # filter: {
3767
+ # status: "CREATING", # accepts CREATING, ACTIVE, UPDATING, DELETING, FAILED
3768
+ # creation_time_after: Time.now,
3769
+ # creation_time_before: Time.now,
3770
+ # },
3771
+ # next_token: "String",
3772
+ # max_results: 1,
3773
+ # })
3774
+ #
3775
+ # @example Response structure
3776
+ #
3777
+ # resp.flywheel_summary_list #=> Array
3778
+ # resp.flywheel_summary_list[0].flywheel_arn #=> String
3779
+ # resp.flywheel_summary_list[0].active_model_arn #=> String
3780
+ # resp.flywheel_summary_list[0].data_lake_s3_uri #=> String
3781
+ # resp.flywheel_summary_list[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
3782
+ # resp.flywheel_summary_list[0].model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
3783
+ # resp.flywheel_summary_list[0].message #=> String
3784
+ # resp.flywheel_summary_list[0].creation_time #=> Time
3785
+ # resp.flywheel_summary_list[0].last_modified_time #=> Time
3786
+ # resp.flywheel_summary_list[0].latest_flywheel_iteration #=> String
3787
+ # resp.next_token #=> String
3788
+ #
3789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels AWS API Documentation
3790
+ #
3791
+ # @overload list_flywheels(params = {})
3792
+ # @param [Hash] params ({})
3793
+ def list_flywheels(params = {}, options = {})
3794
+ req = build_request(:list_flywheels, params)
3795
+ req.send_request(options)
3796
+ end
3797
+
3182
3798
  # Get a list of key phrase detection jobs that you have submitted.
3183
3799
  #
3184
3800
  # @option params [Types::KeyPhrasesDetectionJobFilter] :filter
@@ -3616,13 +4232,14 @@ module Aws::Comprehend
3616
4232
  req.send_request(options)
3617
4233
  end
3618
4234
 
3619
- # Starts an asynchronous document classification job. Use the operation
3620
- # to track the progress of the job.
4235
+ # Starts an asynchronous document classification job. Use the
4236
+ # `DescribeDocumentClassificationJob` operation to track the progress of
4237
+ # the job.
3621
4238
  #
3622
4239
  # @option params [String] :job_name
3623
4240
  # The identifier of the job.
3624
4241
  #
3625
- # @option params [required, String] :document_classifier_arn
4242
+ # @option params [String] :document_classifier_arn
3626
4243
  # The Amazon Resource Name (ARN) of the document classifier to use to
3627
4244
  # process the job.
3628
4245
  #
@@ -3665,22 +4282,27 @@ module Aws::Comprehend
3665
4282
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
3666
4283
  #
3667
4284
  # @option params [Array<Types::Tag>] :tags
3668
- # Tags to be associated with the document classification job. A tag is a
4285
+ # Tags to associate with the document classification job. A tag is a
3669
4286
  # key-value pair that adds metadata to a resource used by Amazon
3670
4287
  # Comprehend. For example, a tag with "Sales" as the key might be
3671
4288
  # added to a resource to indicate its use by the sales department.
3672
4289
  #
4290
+ # @option params [String] :flywheel_arn
4291
+ # The Amazon Resource Number (ARN) of the flywheel associated with the
4292
+ # model to use.
4293
+ #
3673
4294
  # @return [Types::StartDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3674
4295
  #
3675
4296
  # * {Types::StartDocumentClassificationJobResponse#job_id #job_id} => String
3676
4297
  # * {Types::StartDocumentClassificationJobResponse#job_arn #job_arn} => String
3677
4298
  # * {Types::StartDocumentClassificationJobResponse#job_status #job_status} => String
4299
+ # * {Types::StartDocumentClassificationJobResponse#document_classifier_arn #document_classifier_arn} => String
3678
4300
  #
3679
4301
  # @example Request syntax with placeholder values
3680
4302
  #
3681
4303
  # resp = client.start_document_classification_job({
3682
4304
  # job_name: "JobName",
3683
- # document_classifier_arn: "DocumentClassifierArn", # required
4305
+ # document_classifier_arn: "DocumentClassifierArn",
3684
4306
  # input_data_config: { # required
3685
4307
  # s3_uri: "S3Uri", # required
3686
4308
  # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
@@ -3707,6 +4329,7 @@ module Aws::Comprehend
3707
4329
  # value: "TagValue",
3708
4330
  # },
3709
4331
  # ],
4332
+ # flywheel_arn: "ComprehendFlywheelArn",
3710
4333
  # })
3711
4334
  #
3712
4335
  # @example Response structure
@@ -3714,6 +4337,7 @@ module Aws::Comprehend
3714
4337
  # resp.job_id #=> String
3715
4338
  # resp.job_arn #=> String
3716
4339
  # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4340
+ # resp.document_classifier_arn #=> String
3717
4341
  #
3718
4342
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob AWS API Documentation
3719
4343
  #
@@ -3775,8 +4399,8 @@ module Aws::Comprehend
3775
4399
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
3776
4400
  #
3777
4401
  # @option params [Array<Types::Tag>] :tags
3778
- # Tags to be associated with the dominant language detection job. A tag
3779
- # is a key-value pair that adds metadata to a resource used by Amazon
4402
+ # Tags to associate with the dominant language detection job. A tag is a
4403
+ # key-value pair that adds metadata to a resource used by Amazon
3780
4404
  # Comprehend. For example, a tag with "Sales" as the key might be
3781
4405
  # added to a resource to indicate its use by the sales department.
3782
4406
  #
@@ -3899,16 +4523,21 @@ module Aws::Comprehend
3899
4523
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
3900
4524
  #
3901
4525
  # @option params [Array<Types::Tag>] :tags
3902
- # Tags to be associated with the entities detection job. A tag is a
4526
+ # Tags to associate with the entities detection job. A tag is a
3903
4527
  # key-value pair that adds metadata to a resource used by Amazon
3904
4528
  # Comprehend. For example, a tag with "Sales" as the key might be
3905
4529
  # added to a resource to indicate its use by the sales department.
3906
4530
  #
4531
+ # @option params [String] :flywheel_arn
4532
+ # The Amazon Resource Number (ARN) of the flywheel associated with the
4533
+ # model to use.
4534
+ #
3907
4535
  # @return [Types::StartEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3908
4536
  #
3909
4537
  # * {Types::StartEntitiesDetectionJobResponse#job_id #job_id} => String
3910
4538
  # * {Types::StartEntitiesDetectionJobResponse#job_arn #job_arn} => String
3911
4539
  # * {Types::StartEntitiesDetectionJobResponse#job_status #job_status} => String
4540
+ # * {Types::StartEntitiesDetectionJobResponse#entity_recognizer_arn #entity_recognizer_arn} => String
3912
4541
  #
3913
4542
  # @example Request syntax with placeholder values
3914
4543
  #
@@ -3942,6 +4571,7 @@ module Aws::Comprehend
3942
4571
  # value: "TagValue",
3943
4572
  # },
3944
4573
  # ],
4574
+ # flywheel_arn: "ComprehendFlywheelArn",
3945
4575
  # })
3946
4576
  #
3947
4577
  # @example Response structure
@@ -3949,6 +4579,7 @@ module Aws::Comprehend
3949
4579
  # resp.job_id #=> String
3950
4580
  # resp.job_arn #=> String
3951
4581
  # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
4582
+ # resp.entity_recognizer_arn #=> String
3952
4583
  #
3953
4584
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob AWS API Documentation
3954
4585
  #
@@ -3990,10 +4621,10 @@ module Aws::Comprehend
3990
4621
  # The types of events to detect in the input documents.
3991
4622
  #
3992
4623
  # @option params [Array<Types::Tag>] :tags
3993
- # Tags to be associated with the events detection job. A tag is a
3994
- # key-value pair that adds metadata to a resource used by Amazon
3995
- # Comprehend. For example, a tag with "Sales" as the key might be
3996
- # added to a resource to indicate its use by the sales department.
4624
+ # Tags to associate with the events detection job. A tag is a key-value
4625
+ # pair that adds metadata to a resource used by Amazon Comprehend. For
4626
+ # example, a tag with "Sales" as the key might be added to a resource
4627
+ # to indicate its use by the sales department.
3997
4628
  #
3998
4629
  # @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3999
4630
  #
@@ -4045,6 +4676,47 @@ module Aws::Comprehend
4045
4676
  req.send_request(options)
4046
4677
  end
4047
4678
 
4679
+ # Start the flywheel iteration.This operation uses any new datasets to
4680
+ # train a new model version. For more information about flywheels, see [
4681
+ # Flywheel overview][1] in the *Amazon Comprehend Developer Guide*.
4682
+ #
4683
+ #
4684
+ #
4685
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
4686
+ #
4687
+ # @option params [required, String] :flywheel_arn
4688
+ # The ARN of the flywheel.
4689
+ #
4690
+ # @option params [String] :client_request_token
4691
+ # A unique identifier for the request. If you don't set the client
4692
+ # request token, Amazon Comprehend generates one.
4693
+ #
4694
+ # @return [Types::StartFlywheelIterationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4695
+ #
4696
+ # * {Types::StartFlywheelIterationResponse#flywheel_arn #flywheel_arn} => String
4697
+ # * {Types::StartFlywheelIterationResponse#flywheel_iteration_id #flywheel_iteration_id} => String
4698
+ #
4699
+ # @example Request syntax with placeholder values
4700
+ #
4701
+ # resp = client.start_flywheel_iteration({
4702
+ # flywheel_arn: "ComprehendFlywheelArn", # required
4703
+ # client_request_token: "ClientRequestTokenString",
4704
+ # })
4705
+ #
4706
+ # @example Response structure
4707
+ #
4708
+ # resp.flywheel_arn #=> String
4709
+ # resp.flywheel_iteration_id #=> String
4710
+ #
4711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration AWS API Documentation
4712
+ #
4713
+ # @overload start_flywheel_iteration(params = {})
4714
+ # @param [Hash] params ({})
4715
+ def start_flywheel_iteration(params = {}, options = {})
4716
+ req = build_request(:start_flywheel_iteration, params)
4717
+ req.send_request(options)
4718
+ end
4719
+
4048
4720
  # Starts an asynchronous key phrase detection job for a collection of
4049
4721
  # documents. Use the operation to track the status of a job.
4050
4722
  #
@@ -4100,7 +4772,7 @@ module Aws::Comprehend
4100
4772
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4101
4773
  #
4102
4774
  # @option params [Array<Types::Tag>] :tags
4103
- # Tags to be associated with the key phrases detection job. A tag is a
4775
+ # Tags to associate with the key phrases detection job. A tag is a
4104
4776
  # key-value pair that adds metadata to a resource used by Amazon
4105
4777
  # Comprehend. For example, a tag with "Sales" as the key might be
4106
4778
  # added to a resource to indicate its use by the sales department.
@@ -4200,7 +4872,7 @@ module Aws::Comprehend
4200
4872
  # not need to pass this option.**
4201
4873
  #
4202
4874
  # @option params [Array<Types::Tag>] :tags
4203
- # Tags to be associated with the PII entities detection job. A tag is a
4875
+ # Tags to associate with the PII entities detection job. A tag is a
4204
4876
  # key-value pair that adds metadata to a resource used by Amazon
4205
4877
  # Comprehend. For example, a tag with "Sales" as the key might be
4206
4878
  # added to a resource to indicate its use by the sales department.
@@ -4315,7 +4987,7 @@ module Aws::Comprehend
4315
4987
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4316
4988
  #
4317
4989
  # @option params [Array<Types::Tag>] :tags
4318
- # Tags to be associated with the sentiment detection job. A tag is a
4990
+ # Tags to associate with the sentiment detection job. A tag is a
4319
4991
  # key-value pair that adds metadata to a resource used by Amazon
4320
4992
  # Comprehend. For example, a tag with "Sales" as the key might be
4321
4993
  # added to a resource to indicate its use by the sales department.
@@ -4375,8 +5047,9 @@ module Aws::Comprehend
4375
5047
  end
4376
5048
 
4377
5049
  # Starts an asynchronous targeted sentiment detection job for a
4378
- # collection of documents. Use the operation to track the status of a
4379
- # job.
5050
+ # collection of documents. Use the
5051
+ # `DescribeTargetedSentimentDetectionJob` operation to track the status
5052
+ # of a job.
4380
5053
  #
4381
5054
  # @option params [required, Types::InputDataConfig] :input_data_config
4382
5055
  # The input properties for an inference job. The document reader config
@@ -4430,8 +5103,8 @@ module Aws::Comprehend
4430
5103
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4431
5104
  #
4432
5105
  # @option params [Array<Types::Tag>] :tags
4433
- # Tags to be associated with the targeted sentiment detection job. A tag
4434
- # is a key-value pair that adds metadata to a resource used by Amazon
5106
+ # Tags to associate with the targeted sentiment detection job. A tag is
5107
+ # a key-value pair that adds metadata to a resource used by Amazon
4435
5108
  # Comprehend. For example, a tag with "Sales" as the key might be
4436
5109
  # added to a resource to indicate its use by the sales department.
4437
5110
  #
@@ -4545,10 +5218,10 @@ module Aws::Comprehend
4545
5218
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
4546
5219
  #
4547
5220
  # @option params [Array<Types::Tag>] :tags
4548
- # Tags to be associated with the topics detection job. A tag is a
4549
- # key-value pair that adds metadata to a resource used by Amazon
4550
- # Comprehend. For example, a tag with "Sales" as the key might be
4551
- # added to a resource to indicate its use by the sales department.
5221
+ # Tags to associate with the topics detection job. A tag is a key-value
5222
+ # pair that adds metadata to a resource used by Amazon Comprehend. For
5223
+ # example, a tag with "Sales" as the key might be added to a resource
5224
+ # to indicate its use by the sales department.
4552
5225
  #
4553
5226
  # @return [Types::StartTopicsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4554
5227
  #
@@ -5024,7 +5697,12 @@ module Aws::Comprehend
5024
5697
  # Data access role ARN to use in case the new model is encrypted with a
5025
5698
  # customer CMK.
5026
5699
  #
5027
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5700
+ # @option params [String] :flywheel_arn
5701
+ # The Amazon Resource Number (ARN) of the flywheel
5702
+ #
5703
+ # @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5704
+ #
5705
+ # * {Types::UpdateEndpointResponse#desired_model_arn #desired_model_arn} => String
5028
5706
  #
5029
5707
  # @example Request syntax with placeholder values
5030
5708
  #
@@ -5033,8 +5711,13 @@ module Aws::Comprehend
5033
5711
  # desired_model_arn: "ComprehendModelArn",
5034
5712
  # desired_inference_units: 1,
5035
5713
  # desired_data_access_role_arn: "IamRoleArn",
5714
+ # flywheel_arn: "ComprehendFlywheelArn",
5036
5715
  # })
5037
5716
  #
5717
+ # @example Response structure
5718
+ #
5719
+ # resp.desired_model_arn #=> String
5720
+ #
5038
5721
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint AWS API Documentation
5039
5722
  #
5040
5723
  # @overload update_endpoint(params = {})
@@ -5044,6 +5727,77 @@ module Aws::Comprehend
5044
5727
  req.send_request(options)
5045
5728
  end
5046
5729
 
5730
+ # Update the configuration information for an existing flywheel.
5731
+ #
5732
+ # @option params [required, String] :flywheel_arn
5733
+ # The Amazon Resource Number (ARN) of the flywheel to update.
5734
+ #
5735
+ # @option params [String] :active_model_arn
5736
+ # The Amazon Resource Number (ARN) of the active model version.
5737
+ #
5738
+ # @option params [String] :data_access_role_arn
5739
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
5740
+ # Management (IAM) role that grants Amazon Comprehend permission to
5741
+ # access the flywheel data.
5742
+ #
5743
+ # @option params [Types::UpdateDataSecurityConfig] :data_security_config
5744
+ # Flywheel data security configuration.
5745
+ #
5746
+ # @return [Types::UpdateFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5747
+ #
5748
+ # * {Types::UpdateFlywheelResponse#flywheel_properties #flywheel_properties} => Types::FlywheelProperties
5749
+ #
5750
+ # @example Request syntax with placeholder values
5751
+ #
5752
+ # resp = client.update_flywheel({
5753
+ # flywheel_arn: "ComprehendFlywheelArn", # required
5754
+ # active_model_arn: "ComprehendModelArn",
5755
+ # data_access_role_arn: "IamRoleArn",
5756
+ # data_security_config: {
5757
+ # model_kms_key_id: "KmsKeyId",
5758
+ # volume_kms_key_id: "KmsKeyId",
5759
+ # vpc_config: {
5760
+ # security_group_ids: ["SecurityGroupId"], # required
5761
+ # subnets: ["SubnetId"], # required
5762
+ # },
5763
+ # },
5764
+ # })
5765
+ #
5766
+ # @example Response structure
5767
+ #
5768
+ # resp.flywheel_properties.flywheel_arn #=> String
5769
+ # resp.flywheel_properties.active_model_arn #=> String
5770
+ # resp.flywheel_properties.data_access_role_arn #=> String
5771
+ # resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
5772
+ # resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
5773
+ # resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
5774
+ # resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
5775
+ # resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
5776
+ # resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
5777
+ # resp.flywheel_properties.data_lake_s3_uri #=> String
5778
+ # resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
5779
+ # resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
5780
+ # resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
5781
+ # resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
5782
+ # resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
5783
+ # resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
5784
+ # resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
5785
+ # resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
5786
+ # resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
5787
+ # resp.flywheel_properties.message #=> String
5788
+ # resp.flywheel_properties.creation_time #=> Time
5789
+ # resp.flywheel_properties.last_modified_time #=> Time
5790
+ # resp.flywheel_properties.latest_flywheel_iteration #=> String
5791
+ #
5792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheel AWS API Documentation
5793
+ #
5794
+ # @overload update_flywheel(params = {})
5795
+ # @param [Hash] params ({})
5796
+ def update_flywheel(params = {}, options = {})
5797
+ req = build_request(:update_flywheel, params)
5798
+ req.send_request(options)
5799
+ end
5800
+
5047
5801
  # @!endgroup
5048
5802
 
5049
5803
  # @param params ({})
@@ -5057,7 +5811,7 @@ module Aws::Comprehend
5057
5811
  params: params,
5058
5812
  config: config)
5059
5813
  context[:gem_name] = 'aws-sdk-comprehend'
5060
- context[:gem_version] = '1.64.0'
5814
+ context[:gem_version] = '1.66.0'
5061
5815
  Seahorse::Client::Request.new(handlers, context)
5062
5816
  end
5063
5817