cdk-docker-image-deployment 0.0.178 → 0.0.179

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -75,6 +75,14 @@ declare class Comprehend extends Service {
75
75
  * Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
76
76
  */
77
77
  containsPiiEntities(callback?: (err: AWSError, data: Comprehend.Types.ContainsPiiEntitiesResponse) => void): Request<Comprehend.Types.ContainsPiiEntitiesResponse, AWSError>;
78
+ /**
79
+ * Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
80
+ */
81
+ createDataset(params: Comprehend.Types.CreateDatasetRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateDatasetResponse) => void): Request<Comprehend.Types.CreateDatasetResponse, AWSError>;
82
+ /**
83
+ * Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
84
+ */
85
+ createDataset(callback?: (err: AWSError, data: Comprehend.Types.CreateDatasetResponse) => void): Request<Comprehend.Types.CreateDatasetResponse, AWSError>;
78
86
  /**
79
87
  * Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.
80
88
  */
@@ -92,13 +100,21 @@ declare class Comprehend extends Service {
92
100
  */
93
101
  createEndpoint(callback?: (err: AWSError, data: Comprehend.Types.CreateEndpointResponse) => void): Request<Comprehend.Types.CreateEndpointResponse, AWSError>;
94
102
  /**
95
- * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
103
+ * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
96
104
  */
97
105
  createEntityRecognizer(params: Comprehend.Types.CreateEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request<Comprehend.Types.CreateEntityRecognizerResponse, AWSError>;
98
106
  /**
99
- * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
107
+ * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
100
108
  */
101
109
  createEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request<Comprehend.Types.CreateEntityRecognizerResponse, AWSError>;
110
+ /**
111
+ * A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
112
+ */
113
+ createFlywheel(params: Comprehend.Types.CreateFlywheelRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateFlywheelResponse) => void): Request<Comprehend.Types.CreateFlywheelResponse, AWSError>;
114
+ /**
115
+ * A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
116
+ */
117
+ createFlywheel(callback?: (err: AWSError, data: Comprehend.Types.CreateFlywheelResponse) => void): Request<Comprehend.Types.CreateFlywheelResponse, AWSError>;
102
118
  /**
103
119
  * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
104
120
  */
@@ -123,6 +139,14 @@ declare class Comprehend extends Service {
123
139
  * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
124
140
  */
125
141
  deleteEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request<Comprehend.Types.DeleteEntityRecognizerResponse, AWSError>;
142
+ /**
143
+ * Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
144
+ */
145
+ deleteFlywheel(params: Comprehend.Types.DeleteFlywheelRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteFlywheelResponse) => void): Request<Comprehend.Types.DeleteFlywheelResponse, AWSError>;
146
+ /**
147
+ * Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
148
+ */
149
+ deleteFlywheel(callback?: (err: AWSError, data: Comprehend.Types.DeleteFlywheelResponse) => void): Request<Comprehend.Types.DeleteFlywheelResponse, AWSError>;
126
150
  /**
127
151
  * Deletes a resource-based policy that is attached to a custom model.
128
152
  */
@@ -131,6 +155,14 @@ declare class Comprehend extends Service {
131
155
  * Deletes a resource-based policy that is attached to a custom model.
132
156
  */
133
157
  deleteResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.DeleteResourcePolicyResponse) => void): Request<Comprehend.Types.DeleteResourcePolicyResponse, AWSError>;
158
+ /**
159
+ * Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
160
+ */
161
+ describeDataset(params: Comprehend.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDatasetResponse) => void): Request<Comprehend.Types.DescribeDatasetResponse, AWSError>;
162
+ /**
163
+ * Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
164
+ */
165
+ describeDataset(callback?: (err: AWSError, data: Comprehend.Types.DescribeDatasetResponse) => void): Request<Comprehend.Types.DescribeDatasetResponse, AWSError>;
134
166
  /**
135
167
  * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
136
168
  */
@@ -187,6 +219,22 @@ declare class Comprehend extends Service {
187
219
  * Gets the status and details of an events detection job.
188
220
  */
189
221
  describeEventsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeEventsDetectionJobResponse) => void): Request<Comprehend.Types.DescribeEventsDetectionJobResponse, AWSError>;
222
+ /**
223
+ * Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
224
+ */
225
+ describeFlywheel(params: Comprehend.Types.DescribeFlywheelRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeFlywheelResponse) => void): Request<Comprehend.Types.DescribeFlywheelResponse, AWSError>;
226
+ /**
227
+ * Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
228
+ */
229
+ describeFlywheel(callback?: (err: AWSError, data: Comprehend.Types.DescribeFlywheelResponse) => void): Request<Comprehend.Types.DescribeFlywheelResponse, AWSError>;
230
+ /**
231
+ * Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
232
+ */
233
+ describeFlywheelIteration(params: Comprehend.Types.DescribeFlywheelIterationRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeFlywheelIterationResponse) => void): Request<Comprehend.Types.DescribeFlywheelIterationResponse, AWSError>;
234
+ /**
235
+ * Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
236
+ */
237
+ describeFlywheelIteration(callback?: (err: AWSError, data: Comprehend.Types.DescribeFlywheelIterationResponse) => void): Request<Comprehend.Types.DescribeFlywheelIterationResponse, AWSError>;
190
238
  /**
191
239
  * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
192
240
  */
@@ -299,6 +347,14 @@ declare class Comprehend extends Service {
299
347
  * Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one. If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
300
348
  */
301
349
  importModel(callback?: (err: AWSError, data: Comprehend.Types.ImportModelResponse) => void): Request<Comprehend.Types.ImportModelResponse, AWSError>;
350
+ /**
351
+ * List the datasets that you have configured in this region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
352
+ */
353
+ listDatasets(params: Comprehend.Types.ListDatasetsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDatasetsResponse) => void): Request<Comprehend.Types.ListDatasetsResponse, AWSError>;
354
+ /**
355
+ * List the datasets that you have configured in this region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
356
+ */
357
+ listDatasets(callback?: (err: AWSError, data: Comprehend.Types.ListDatasetsResponse) => void): Request<Comprehend.Types.ListDatasetsResponse, AWSError>;
302
358
  /**
303
359
  * Gets a list of the documentation classification jobs that you have submitted.
304
360
  */
@@ -371,6 +427,22 @@ declare class Comprehend extends Service {
371
427
  * Gets a list of the events detection jobs that you have submitted.
372
428
  */
373
429
  listEventsDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListEventsDetectionJobsResponse) => void): Request<Comprehend.Types.ListEventsDetectionJobsResponse, AWSError>;
430
+ /**
431
+ * Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
432
+ */
433
+ listFlywheelIterationHistory(params: Comprehend.Types.ListFlywheelIterationHistoryRequest, callback?: (err: AWSError, data: Comprehend.Types.ListFlywheelIterationHistoryResponse) => void): Request<Comprehend.Types.ListFlywheelIterationHistoryResponse, AWSError>;
434
+ /**
435
+ * Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
436
+ */
437
+ listFlywheelIterationHistory(callback?: (err: AWSError, data: Comprehend.Types.ListFlywheelIterationHistoryResponse) => void): Request<Comprehend.Types.ListFlywheelIterationHistoryResponse, AWSError>;
438
+ /**
439
+ * Gets a list of the flywheels that you have created.
440
+ */
441
+ listFlywheels(params: Comprehend.Types.ListFlywheelsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListFlywheelsResponse) => void): Request<Comprehend.Types.ListFlywheelsResponse, AWSError>;
442
+ /**
443
+ * Gets a list of the flywheels that you have created.
444
+ */
445
+ listFlywheels(callback?: (err: AWSError, data: Comprehend.Types.ListFlywheelsResponse) => void): Request<Comprehend.Types.ListFlywheelsResponse, AWSError>;
374
446
  /**
375
447
  * Get a list of key phrase detection jobs that you have submitted.
376
448
  */
@@ -428,11 +500,11 @@ declare class Comprehend extends Service {
428
500
  */
429
501
  putResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.PutResourcePolicyResponse) => void): Request<Comprehend.Types.PutResourcePolicyResponse, AWSError>;
430
502
  /**
431
- * Starts an asynchronous document classification job. Use the operation to track the progress of the job.
503
+ * Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
432
504
  */
433
505
  startDocumentClassificationJob(params: Comprehend.Types.StartDocumentClassificationJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request<Comprehend.Types.StartDocumentClassificationJobResponse, AWSError>;
434
506
  /**
435
- * Starts an asynchronous document classification job. Use the operation to track the progress of the job.
507
+ * Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.
436
508
  */
437
509
  startDocumentClassificationJob(callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request<Comprehend.Types.StartDocumentClassificationJobResponse, AWSError>;
438
510
  /**
@@ -459,6 +531,14 @@ declare class Comprehend extends Service {
459
531
  * Starts an asynchronous event detection job for a collection of documents.
460
532
  */
461
533
  startEventsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartEventsDetectionJobResponse) => void): Request<Comprehend.Types.StartEventsDetectionJobResponse, AWSError>;
534
+ /**
535
+ * Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
536
+ */
537
+ startFlywheelIteration(params: Comprehend.Types.StartFlywheelIterationRequest, callback?: (err: AWSError, data: Comprehend.Types.StartFlywheelIterationResponse) => void): Request<Comprehend.Types.StartFlywheelIterationResponse, AWSError>;
538
+ /**
539
+ * Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
540
+ */
541
+ startFlywheelIteration(callback?: (err: AWSError, data: Comprehend.Types.StartFlywheelIterationResponse) => void): Request<Comprehend.Types.StartFlywheelIterationResponse, AWSError>;
462
542
  /**
463
543
  * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
464
544
  */
@@ -484,11 +564,11 @@ declare class Comprehend extends Service {
484
564
  */
485
565
  startSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StartSentimentDetectionJobResponse, AWSError>;
486
566
  /**
487
- * Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
567
+ * Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
488
568
  */
489
569
  startTargetedSentimentDetectionJob(params: Comprehend.Types.StartTargetedSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartTargetedSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StartTargetedSentimentDetectionJobResponse, AWSError>;
490
570
  /**
491
- * Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
571
+ * Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
492
572
  */
493
573
  startTargetedSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartTargetedSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StartTargetedSentimentDetectionJobResponse, AWSError>;
494
574
  /**
@@ -595,6 +675,14 @@ declare class Comprehend extends Service {
595
675
  * Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
596
676
  */
597
677
  updateEndpoint(callback?: (err: AWSError, data: Comprehend.Types.UpdateEndpointResponse) => void): Request<Comprehend.Types.UpdateEndpointResponse, AWSError>;
678
+ /**
679
+ * Update the configuration information for an existing flywheel.
680
+ */
681
+ updateFlywheel(params: Comprehend.Types.UpdateFlywheelRequest, callback?: (err: AWSError, data: Comprehend.Types.UpdateFlywheelResponse) => void): Request<Comprehend.Types.UpdateFlywheelResponse, AWSError>;
682
+ /**
683
+ * Update the configuration information for an existing flywheel.
684
+ */
685
+ updateFlywheel(callback?: (err: AWSError, data: Comprehend.Types.UpdateFlywheelResponse) => void): Request<Comprehend.Types.UpdateFlywheelResponse, AWSError>;
598
686
  }
599
687
  declare namespace Comprehend {
600
688
  export type AnyLengthString = string;
@@ -994,8 +1082,10 @@ declare namespace Comprehend {
994
1082
  export type ClientRequestTokenString = string;
995
1083
  export type ComprehendArn = string;
996
1084
  export type ComprehendArnName = string;
1085
+ export type ComprehendDatasetArn = string;
997
1086
  export type ComprehendEndpointArn = string;
998
1087
  export type ComprehendEndpointName = string;
1088
+ export type ComprehendFlywheelArn = string;
999
1089
  export type ComprehendModelArn = string;
1000
1090
  export interface ContainsPiiEntitiesRequest {
1001
1091
  /**
@@ -1013,6 +1103,42 @@ declare namespace Comprehend {
1013
1103
  */
1014
1104
  Labels?: ListOfEntityLabels;
1015
1105
  }
1106
+ export interface CreateDatasetRequest {
1107
+ /**
1108
+ * The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
1109
+ */
1110
+ FlywheelArn: ComprehendFlywheelArn;
1111
+ /**
1112
+ * Name of the dataset.
1113
+ */
1114
+ DatasetName: ComprehendArnName;
1115
+ /**
1116
+ * The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
1117
+ */
1118
+ DatasetType?: DatasetType;
1119
+ /**
1120
+ * Description of the dataset.
1121
+ */
1122
+ Description?: Description;
1123
+ /**
1124
+ * Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.
1125
+ */
1126
+ InputDataConfig: DatasetInputDataConfig;
1127
+ /**
1128
+ * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
1129
+ */
1130
+ ClientRequestToken?: ClientRequestTokenString;
1131
+ /**
1132
+ * Tags for the dataset.
1133
+ */
1134
+ Tags?: TagList;
1135
+ }
1136
+ export interface CreateDatasetResponse {
1137
+ /**
1138
+ * The ARN of the dataset.
1139
+ */
1140
+ DatasetArn?: ComprehendDatasetArn;
1141
+ }
1016
1142
  export interface CreateDocumentClassifierRequest {
1017
1143
  /**
1018
1144
  * The name of the document classifier.
@@ -1023,11 +1149,11 @@ declare namespace Comprehend {
1023
1149
  */
1024
1150
  VersionName?: VersionName;
1025
1151
  /**
1026
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
1152
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1027
1153
  */
1028
1154
  DataAccessRoleArn: IamRoleArn;
1029
1155
  /**
1030
- * Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
1156
+ * Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
1031
1157
  */
1032
1158
  Tags?: TagList;
1033
1159
  /**
@@ -1043,7 +1169,7 @@ declare namespace Comprehend {
1043
1169
  */
1044
1170
  ClientRequestToken?: ClientRequestTokenString;
1045
1171
  /**
1046
- * The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
1172
+ * The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
1047
1173
  */
1048
1174
  LanguageCode: LanguageCode;
1049
1175
  /**
@@ -1081,7 +1207,7 @@ declare namespace Comprehend {
1081
1207
  /**
1082
1208
  * The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
1083
1209
  */
1084
- ModelArn: ComprehendModelArn;
1210
+ ModelArn?: ComprehendModelArn;
1085
1211
  /**
1086
1212
  * The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
1087
1213
  */
@@ -1091,19 +1217,27 @@ declare namespace Comprehend {
1091
1217
  */
1092
1218
  ClientRequestToken?: ClientRequestTokenString;
1093
1219
  /**
1094
- * Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
1220
+ * Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
1095
1221
  */
1096
1222
  Tags?: TagList;
1097
1223
  /**
1098
- * The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
1224
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
1099
1225
  */
1100
1226
  DataAccessRoleArn?: IamRoleArn;
1227
+ /**
1228
+ * The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
1229
+ */
1230
+ FlywheelArn?: ComprehendFlywheelArn;
1101
1231
  }
1102
1232
  export interface CreateEndpointResponse {
1103
1233
  /**
1104
1234
  * The Amazon Resource Number (ARN) of the endpoint being created.
1105
1235
  */
1106
1236
  EndpointArn?: ComprehendEndpointArn;
1237
+ /**
1238
+ * The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
1239
+ */
1240
+ ModelArn?: ComprehendModelArn;
1107
1241
  }
1108
1242
  export interface CreateEntityRecognizerRequest {
1109
1243
  /**
@@ -1115,11 +1249,11 @@ declare namespace Comprehend {
1115
1249
  */
1116
1250
  VersionName?: VersionName;
1117
1251
  /**
1118
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
1252
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1119
1253
  */
1120
1254
  DataAccessRoleArn: IamRoleArn;
1121
1255
  /**
1122
- * Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
1256
+ * Tags to associate with the entity recognizer. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
1123
1257
  */
1124
1258
  Tags?: TagList;
1125
1259
  /**
@@ -1143,7 +1277,7 @@ declare namespace Comprehend {
1143
1277
  */
1144
1278
  VpcConfig?: VpcConfig;
1145
1279
  /**
1146
- * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1280
+ * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1147
1281
  */
1148
1282
  ModelKmsKeyId?: KmsKeyId;
1149
1283
  /**
@@ -1157,8 +1291,222 @@ declare namespace Comprehend {
1157
1291
  */
1158
1292
  EntityRecognizerArn?: EntityRecognizerArn;
1159
1293
  }
1294
+ export interface CreateFlywheelRequest {
1295
+ /**
1296
+ * Name for the flywheel.
1297
+ */
1298
+ FlywheelName: ComprehendArnName;
1299
+ /**
1300
+ * To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
1301
+ */
1302
+ ActiveModelArn?: ComprehendModelArn;
1303
+ /**
1304
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
1305
+ */
1306
+ DataAccessRoleArn: IamRoleArn;
1307
+ /**
1308
+ * Configuration about the custom classifier associated with the flywheel.
1309
+ */
1310
+ TaskConfig?: TaskConfig;
1311
+ /**
1312
+ * The model type.
1313
+ */
1314
+ ModelType?: ModelType;
1315
+ /**
1316
+ * Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
1317
+ */
1318
+ DataLakeS3Uri: FlywheelS3Uri;
1319
+ /**
1320
+ * Data security configurations.
1321
+ */
1322
+ DataSecurityConfig?: DataSecurityConfig;
1323
+ /**
1324
+ * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
1325
+ */
1326
+ ClientRequestToken?: ClientRequestTokenString;
1327
+ /**
1328
+ * The tags to associate with this flywheel.
1329
+ */
1330
+ Tags?: TagList;
1331
+ }
1332
+ export interface CreateFlywheelResponse {
1333
+ /**
1334
+ * The Amazon Resource Number (ARN) of the flywheel.
1335
+ */
1336
+ FlywheelArn?: ComprehendFlywheelArn;
1337
+ /**
1338
+ * The Amazon Resource Number (ARN) of the active model version.
1339
+ */
1340
+ ActiveModelArn?: ComprehendModelArn;
1341
+ }
1160
1342
  export type CustomerInputString = string;
1161
1343
  export type CustomerInputStringList = CustomerInputString[];
1344
+ export interface DataSecurityConfig {
1345
+ /**
1346
+ * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1347
+ */
1348
+ ModelKmsKeyId?: KmsKeyId;
1349
+ /**
1350
+ * ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
1351
+ */
1352
+ VolumeKmsKeyId?: KmsKeyId;
1353
+ /**
1354
+ * ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
1355
+ */
1356
+ DataLakeKmsKeyId?: KmsKeyId;
1357
+ VpcConfig?: VpcConfig;
1358
+ }
1359
+ export type DatasetAugmentedManifestsList = DatasetAugmentedManifestsListItem[];
1360
+ export interface DatasetAugmentedManifestsListItem {
1361
+ /**
1362
+ * The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job. If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth. If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
1363
+ */
1364
+ AttributeNames: AttributeNamesList;
1365
+ /**
1366
+ * The Amazon S3 location of the augmented manifest file.
1367
+ */
1368
+ S3Uri: S3Uri;
1369
+ /**
1370
+ * The S3 prefix to the annotation files that are referred in the augmented manifest file.
1371
+ */
1372
+ AnnotationDataS3Uri?: S3Uri;
1373
+ /**
1374
+ * The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
1375
+ */
1376
+ SourceDocumentsS3Uri?: S3Uri;
1377
+ /**
1378
+ * The type of augmented manifest. If you don't specify, the default is PlainTextDocument. PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
1379
+ */
1380
+ DocumentType?: AugmentedManifestsDocumentTypeFormat;
1381
+ }
1382
+ export type DatasetDataFormat = "COMPREHEND_CSV"|"AUGMENTED_MANIFEST"|string;
1383
+ export interface DatasetDocumentClassifierInputDataConfig {
1384
+ /**
1385
+ * The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files. For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input. This parameter is required if you set DataFormat to COMPREHEND_CSV.
1386
+ */
1387
+ S3Uri: S3Uri;
1388
+ /**
1389
+ * Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
1390
+ */
1391
+ LabelDelimiter?: LabelDelimiter;
1392
+ }
1393
+ export interface DatasetEntityRecognizerAnnotations {
1394
+ /**
1395
+ * Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
1396
+ */
1397
+ S3Uri: S3Uri;
1398
+ }
1399
+ export interface DatasetEntityRecognizerDocuments {
1400
+ /**
1401
+ * Specifies the Amazon S3 location where the documents for the dataset are located.
1402
+ */
1403
+ S3Uri: S3Uri;
1404
+ /**
1405
+ * Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
1406
+ */
1407
+ InputFormat?: InputFormat;
1408
+ }
1409
+ export interface DatasetEntityRecognizerEntityList {
1410
+ /**
1411
+ * Specifies the Amazon S3 location where the entity list is located.
1412
+ */
1413
+ S3Uri: S3Uri;
1414
+ }
1415
+ export interface DatasetEntityRecognizerInputDataConfig {
1416
+ /**
1417
+ * The S3 location of the annotation documents for your custom entity recognizer.
1418
+ */
1419
+ Annotations?: DatasetEntityRecognizerAnnotations;
1420
+ /**
1421
+ * The format and location of the training documents for your custom entity recognizer.
1422
+ */
1423
+ Documents: DatasetEntityRecognizerDocuments;
1424
+ /**
1425
+ * The S3 location of the entity list for your custom entity recognizer.
1426
+ */
1427
+ EntityList?: DatasetEntityRecognizerEntityList;
1428
+ }
1429
+ export interface DatasetFilter {
1430
+ /**
1431
+ * Filter the datasets based on the dataset status.
1432
+ */
1433
+ Status?: DatasetStatus;
1434
+ /**
1435
+ * Filter the datasets based on the dataset type.
1436
+ */
1437
+ DatasetType?: DatasetType;
1438
+ /**
1439
+ * Filter the datasets to include datasets created after the specified time.
1440
+ */
1441
+ CreationTimeAfter?: Timestamp;
1442
+ /**
1443
+ * Filter the datasets to include datasets created before the specified time.
1444
+ */
1445
+ CreationTimeBefore?: Timestamp;
1446
+ }
1447
+ export interface DatasetInputDataConfig {
1448
+ /**
1449
+ * A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
1450
+ */
1451
+ AugmentedManifests?: DatasetAugmentedManifestsList;
1452
+ /**
1453
+ * COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents. AUGMENTED_MANIFEST: The data format
1454
+ */
1455
+ DataFormat?: DatasetDataFormat;
1456
+ /**
1457
+ * The input properties for training a document classifier model. For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
1458
+ */
1459
+ DocumentClassifierInputDataConfig?: DatasetDocumentClassifierInputDataConfig;
1460
+ /**
1461
+ * The input properties for training an entity recognizer model.
1462
+ */
1463
+ EntityRecognizerInputDataConfig?: DatasetEntityRecognizerInputDataConfig;
1464
+ }
1465
+ export interface DatasetProperties {
1466
+ /**
1467
+ * The ARN of the dataset.
1468
+ */
1469
+ DatasetArn?: ComprehendDatasetArn;
1470
+ /**
1471
+ * The name of the dataset.
1472
+ */
1473
+ DatasetName?: ComprehendArnName;
1474
+ /**
1475
+ * The dataset type (training data or test data).
1476
+ */
1477
+ DatasetType?: DatasetType;
1478
+ /**
1479
+ * The S3 URI where the dataset is stored.
1480
+ */
1481
+ DatasetS3Uri?: S3Uri;
1482
+ /**
1483
+ * Description of the dataset.
1484
+ */
1485
+ Description?: Description;
1486
+ /**
1487
+ * The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
1488
+ */
1489
+ Status?: DatasetStatus;
1490
+ /**
1491
+ * A description of the status of the dataset.
1492
+ */
1493
+ Message?: AnyLengthString;
1494
+ /**
1495
+ * The number of documents in the dataset.
1496
+ */
1497
+ NumberOfDocuments?: NumberOfDocuments;
1498
+ /**
1499
+ * Creation time of the dataset.
1500
+ */
1501
+ CreationTime?: Timestamp;
1502
+ /**
1503
+ * Time when the data from the dataset becomes available in the data lake.
1504
+ */
1505
+ EndTime?: Timestamp;
1506
+ }
1507
+ export type DatasetPropertiesList = DatasetProperties[];
1508
+ export type DatasetStatus = "CREATING"|"COMPLETED"|"FAILED"|string;
1509
+ export type DatasetType = "TRAIN"|"TEST"|string;
1162
1510
  export interface DeleteDocumentClassifierRequest {
1163
1511
  /**
1164
1512
  * The Amazon Resource Name (ARN) that identifies the document classifier.
@@ -1183,6 +1531,14 @@ declare namespace Comprehend {
1183
1531
  }
1184
1532
  export interface DeleteEntityRecognizerResponse {
1185
1533
  }
1534
+ export interface DeleteFlywheelRequest {
1535
+ /**
1536
+ * The Amazon Resource Number (ARN) of the flywheel to delete.
1537
+ */
1538
+ FlywheelArn: ComprehendFlywheelArn;
1539
+ }
1540
+ export interface DeleteFlywheelResponse {
1541
+ }
1186
1542
  export interface DeleteResourcePolicyRequest {
1187
1543
  /**
1188
1544
  * The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
@@ -1195,9 +1551,21 @@ declare namespace Comprehend {
1195
1551
  }
1196
1552
  export interface DeleteResourcePolicyResponse {
1197
1553
  }
1554
+ export interface DescribeDatasetRequest {
1555
+ /**
1556
+ * The ARN of the dataset.
1557
+ */
1558
+ DatasetArn: ComprehendDatasetArn;
1559
+ }
1560
+ export interface DescribeDatasetResponse {
1561
+ /**
1562
+ * The dataset properties.
1563
+ */
1564
+ DatasetProperties?: DatasetProperties;
1565
+ }
1198
1566
  export interface DescribeDocumentClassificationJobRequest {
1199
1567
  /**
1200
- * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
1568
+ * The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob operation returns this identifier in its response.
1201
1569
  */
1202
1570
  JobId: JobId;
1203
1571
  }
@@ -1209,7 +1577,7 @@ declare namespace Comprehend {
1209
1577
  }
1210
1578
  export interface DescribeDocumentClassifierRequest {
1211
1579
  /**
1212
- * The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
1580
+ * The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.
1213
1581
  */
1214
1582
  DocumentClassifierArn: DocumentClassifierArn;
1215
1583
  }
@@ -1221,7 +1589,7 @@ declare namespace Comprehend {
1221
1589
  }
1222
1590
  export interface DescribeDominantLanguageDetectionJobRequest {
1223
1591
  /**
1224
- * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
1592
+ * The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob operation returns this identifier in its response.
1225
1593
  */
1226
1594
  JobId: JobId;
1227
1595
  }
@@ -1245,7 +1613,7 @@ declare namespace Comprehend {
1245
1613
  }
1246
1614
  export interface DescribeEntitiesDetectionJobRequest {
1247
1615
  /**
1248
- * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
1616
+ * The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.
1249
1617
  */
1250
1618
  JobId: JobId;
1251
1619
  }
@@ -1279,9 +1647,37 @@ declare namespace Comprehend {
1279
1647
  */
1280
1648
  EventsDetectionJobProperties?: EventsDetectionJobProperties;
1281
1649
  }
1650
+ export interface DescribeFlywheelIterationRequest {
1651
+ /**
1652
+ *
1653
+ */
1654
+ FlywheelArn: ComprehendFlywheelArn;
1655
+ /**
1656
+ *
1657
+ */
1658
+ FlywheelIterationId: FlywheelIterationId;
1659
+ }
1660
+ export interface DescribeFlywheelIterationResponse {
1661
+ /**
1662
+ * The configuration properties of a flywheel iteration.
1663
+ */
1664
+ FlywheelIterationProperties?: FlywheelIterationProperties;
1665
+ }
1666
+ export interface DescribeFlywheelRequest {
1667
+ /**
1668
+ * The Amazon Resource Number (ARN) of the flywheel.
1669
+ */
1670
+ FlywheelArn: ComprehendFlywheelArn;
1671
+ }
1672
+ export interface DescribeFlywheelResponse {
1673
+ /**
1674
+ * The flywheel properties.
1675
+ */
1676
+ FlywheelProperties?: FlywheelProperties;
1677
+ }
1282
1678
  export interface DescribeKeyPhrasesDetectionJobRequest {
1283
1679
  /**
1284
- * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
1680
+ * The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.
1285
1681
  */
1286
1682
  JobId: JobId;
1287
1683
  }
@@ -1338,7 +1734,7 @@ declare namespace Comprehend {
1338
1734
  }
1339
1735
  export interface DescribeTargetedSentimentDetectionJobRequest {
1340
1736
  /**
1341
- * The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
1737
+ * The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.
1342
1738
  */
1343
1739
  JobId: JobId;
1344
1740
  }
@@ -1360,6 +1756,7 @@ declare namespace Comprehend {
1360
1756
  */
1361
1757
  TopicsDetectionJobProperties?: TopicsDetectionJobProperties;
1362
1758
  }
1759
+ export type Description = string;
1363
1760
  export interface DetectDominantLanguageRequest {
1364
1761
  /**
1365
1762
  * A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
@@ -1514,6 +1911,16 @@ declare namespace Comprehend {
1514
1911
  */
1515
1912
  Page?: Integer;
1516
1913
  }
1914
+ export interface DocumentClassificationConfig {
1915
+ /**
1916
+ * Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
1917
+ */
1918
+ Mode: DocumentClassifierMode;
1919
+ /**
1920
+ * One or more labels to associate with the custom classifier.
1921
+ */
1922
+ Labels?: LabelsList;
1923
+ }
1517
1924
  export interface DocumentClassificationJobFilter {
1518
1925
  /**
1519
1926
  * Filters on the name of the job.
@@ -1574,7 +1981,7 @@ declare namespace Comprehend {
1574
1981
  */
1575
1982
  OutputDataConfig?: OutputDataConfig;
1576
1983
  /**
1577
- * The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1984
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1578
1985
  */
1579
1986
  DataAccessRoleArn?: IamRoleArn;
1580
1987
  /**
@@ -1585,6 +1992,10 @@ declare namespace Comprehend {
1585
1992
  * Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
1586
1993
  */
1587
1994
  VpcConfig?: VpcConfig;
1995
+ /**
1996
+ * The Amazon Resource Number (ARN) of the flywheel
1997
+ */
1998
+ FlywheelArn?: ComprehendFlywheelArn;
1588
1999
  }
1589
2000
  export type DocumentClassificationJobPropertiesList = DocumentClassificationJobProperties[];
1590
2001
  export type DocumentClassifierArn = string;
@@ -1641,6 +2052,10 @@ declare namespace Comprehend {
1641
2052
  * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
1642
2053
  */
1643
2054
  KmsKeyId?: KmsKeyId;
2055
+ /**
2056
+ * The Amazon S3 prefix for the data lake location of the flywheel statistics.
2057
+ */
2058
+ FlywheelStatsS3Prefix?: S3Uri;
1644
2059
  }
1645
2060
  export interface DocumentClassifierProperties {
1646
2061
  /**
@@ -1688,7 +2103,7 @@ declare namespace Comprehend {
1688
2103
  */
1689
2104
  ClassifierMetadata?: ClassifierMetadata;
1690
2105
  /**
1691
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
2106
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1692
2107
  */
1693
2108
  DataAccessRoleArn?: IamRoleArn;
1694
2109
  /**
@@ -1715,6 +2130,10 @@ declare namespace Comprehend {
1715
2130
  * The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
1716
2131
  */
1717
2132
  SourceModelArn?: DocumentClassifierArn;
2133
+ /**
2134
+ * The Amazon Resource Number (ARN) of the flywheel
2135
+ */
2136
+ FlywheelArn?: ComprehendFlywheelArn;
1718
2137
  }
1719
2138
  export type DocumentClassifierPropertiesList = DocumentClassifierProperties[];
1720
2139
  export type DocumentClassifierSummariesList = DocumentClassifierSummary[];
@@ -1858,7 +2277,7 @@ declare namespace Comprehend {
1858
2277
  */
1859
2278
  OutputDataConfig?: OutputDataConfig;
1860
2279
  /**
1861
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
2280
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
1862
2281
  */
1863
2282
  DataAccessRoleArn?: IamRoleArn;
1864
2283
  /**
@@ -1928,13 +2347,17 @@ declare namespace Comprehend {
1928
2347
  */
1929
2348
  LastModifiedTime?: Timestamp;
1930
2349
  /**
1931
- * The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
2350
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
1932
2351
  */
1933
2352
  DataAccessRoleArn?: IamRoleArn;
1934
2353
  /**
1935
2354
  * Data access role ARN to use in case the new model is encrypted with a customer KMS key.
1936
2355
  */
1937
2356
  DesiredDataAccessRoleArn?: IamRoleArn;
2357
+ /**
2358
+ * The Amazon Resource Number (ARN) of the flywheel
2359
+ */
2360
+ FlywheelArn?: ComprehendFlywheelArn;
1938
2361
  }
1939
2362
  export type EndpointPropertiesList = EndpointProperties[];
1940
2363
  export type EndpointStatus = "CREATING"|"DELETING"|"FAILED"|"IN_SERVICE"|"UPDATING"|string;
@@ -2002,7 +2425,7 @@ declare namespace Comprehend {
2002
2425
  */
2003
2426
  LanguageCode?: LanguageCode;
2004
2427
  /**
2005
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
2428
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
2006
2429
  */
2007
2430
  DataAccessRoleArn?: IamRoleArn;
2008
2431
  /**
@@ -2051,6 +2474,12 @@ declare namespace Comprehend {
2051
2474
  */
2052
2475
  Score?: Float;
2053
2476
  }
2477
+ export interface EntityRecognitionConfig {
2478
+ /**
2479
+ * Up to 25 entity types that the model is trained to recognize.
2480
+ */
2481
+ EntityTypes: EntityTypesList;
2482
+ }
2054
2483
  export interface EntityRecognizerAnnotations {
2055
2484
  /**
2056
2485
  * Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
@@ -2176,6 +2605,12 @@ declare namespace Comprehend {
2176
2605
  */
2177
2606
  NumberOfTrainMentions?: Integer;
2178
2607
  }
2608
+ export interface EntityRecognizerOutputDataConfig {
2609
+ /**
2610
+ * The Amazon S3 prefix for the data lake location of the flywheel statistics.
2611
+ */
2612
+ FlywheelStatsS3Prefix?: S3Uri;
2613
+ }
2179
2614
  export interface EntityRecognizerProperties {
2180
2615
  /**
2181
2616
  * The Amazon Resource Name (ARN) that identifies the entity recognizer.
@@ -2218,7 +2653,7 @@ declare namespace Comprehend {
2218
2653
  */
2219
2654
  RecognizerMetadata?: EntityRecognizerMetadata;
2220
2655
  /**
2221
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
2656
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
2222
2657
  */
2223
2658
  DataAccessRoleArn?: IamRoleArn;
2224
2659
  /**
@@ -2230,7 +2665,7 @@ declare namespace Comprehend {
2230
2665
  */
2231
2666
  VpcConfig?: VpcConfig;
2232
2667
  /**
2233
- * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
2668
+ * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
2234
2669
  */
2235
2670
  ModelKmsKeyId?: KmsKeyId;
2236
2671
  /**
@@ -2241,6 +2676,14 @@ declare namespace Comprehend {
2241
2676
  * The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
2242
2677
  */
2243
2678
  SourceModelArn?: EntityRecognizerArn;
2679
+ /**
2680
+ * The Amazon Resource Number (ARN) of the flywheel
2681
+ */
2682
+ FlywheelArn?: ComprehendFlywheelArn;
2683
+ /**
2684
+ * Output data configuration.
2685
+ */
2686
+ OutputDataConfig?: EntityRecognizerOutputDataConfig;
2244
2687
  }
2245
2688
  export type EntityRecognizerPropertiesList = EntityRecognizerProperties[];
2246
2689
  export type EntityRecognizerSummariesList = EntityRecognizerSummary[];
@@ -2364,7 +2807,7 @@ declare namespace Comprehend {
2364
2807
  */
2365
2808
  LanguageCode?: LanguageCode;
2366
2809
  /**
2367
- * The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
2810
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
2368
2811
  */
2369
2812
  DataAccessRoleArn?: IamRoleArn;
2370
2813
  /**
@@ -2384,6 +2827,185 @@ declare namespace Comprehend {
2384
2827
  Count?: Integer;
2385
2828
  }
2386
2829
  export type Float = number;
2830
+ export interface FlywheelFilter {
2831
+ /**
2832
+ * Filter the flywheels based on the flywheel status.
2833
+ */
2834
+ Status?: FlywheelStatus;
2835
+ /**
2836
+ * Filter the flywheels to include flywheels created after the specified time.
2837
+ */
2838
+ CreationTimeAfter?: Timestamp;
2839
+ /**
2840
+ * Filter the flywheels to include flywheels created before the specified time.
2841
+ */
2842
+ CreationTimeBefore?: Timestamp;
2843
+ }
2844
+ export interface FlywheelIterationFilter {
2845
+ /**
2846
+ * Filter the flywheel iterations to include iterations created after the specified time.
2847
+ */
2848
+ CreationTimeAfter?: Timestamp;
2849
+ /**
2850
+ * Filter the flywheel iterations to include iterations created before the specified time.
2851
+ */
2852
+ CreationTimeBefore?: Timestamp;
2853
+ }
2854
+ export type FlywheelIterationId = string;
2855
+ export interface FlywheelIterationProperties {
2856
+ /**
2857
+ *
2858
+ */
2859
+ FlywheelArn?: ComprehendFlywheelArn;
2860
+ /**
2861
+ *
2862
+ */
2863
+ FlywheelIterationId?: FlywheelIterationId;
2864
+ /**
2865
+ * The creation start time of the flywheel iteration.
2866
+ */
2867
+ CreationTime?: Timestamp;
2868
+ /**
2869
+ * The completion time of this flywheel iteration.
2870
+ */
2871
+ EndTime?: Timestamp;
2872
+ /**
2873
+ * The status of the flywheel iteration.
2874
+ */
2875
+ Status?: FlywheelIterationStatus;
2876
+ /**
2877
+ * A description of the status of the flywheel iteration.
2878
+ */
2879
+ Message?: AnyLengthString;
2880
+ /**
2881
+ * The ARN of the evaluated model associated with this flywheel iteration.
2882
+ */
2883
+ EvaluatedModelArn?: ComprehendModelArn;
2884
+ EvaluatedModelMetrics?: FlywheelModelEvaluationMetrics;
2885
+ /**
2886
+ * The ARN of the trained model associated with this flywheel iteration.
2887
+ */
2888
+ TrainedModelArn?: ComprehendModelArn;
2889
+ /**
2890
+ * The metrics associated with the trained model.
2891
+ */
2892
+ TrainedModelMetrics?: FlywheelModelEvaluationMetrics;
2893
+ /**
2894
+ *
2895
+ */
2896
+ EvaluationManifestS3Prefix?: S3Uri;
2897
+ }
2898
+ export type FlywheelIterationPropertiesList = FlywheelIterationProperties[];
2899
+ export type FlywheelIterationStatus = "TRAINING"|"EVALUATING"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED"|string;
2900
+ export interface FlywheelModelEvaluationMetrics {
2901
+ /**
2902
+ * The average F1 score from the evaluation metrics.
2903
+ */
2904
+ AverageF1Score?: Double;
2905
+ /**
2906
+ * Average precision metric for the model.
2907
+ */
2908
+ AveragePrecision?: Double;
2909
+ /**
2910
+ * Average recall metric for the model.
2911
+ */
2912
+ AverageRecall?: Double;
2913
+ /**
2914
+ * Average accuracy metric for the model.
2915
+ */
2916
+ AverageAccuracy?: Double;
2917
+ }
2918
+ export interface FlywheelProperties {
2919
+ /**
2920
+ * The Amazon Resource Number (ARN) of the flywheel.
2921
+ */
2922
+ FlywheelArn?: ComprehendFlywheelArn;
2923
+ /**
2924
+ * The Amazon Resource Number (ARN) of the active model version.
2925
+ */
2926
+ ActiveModelArn?: ComprehendModelArn;
2927
+ /**
2928
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
2929
+ */
2930
+ DataAccessRoleArn?: IamRoleArn;
2931
+ /**
2932
+ * Configuration about the custom classifier associated with the flywheel.
2933
+ */
2934
+ TaskConfig?: TaskConfig;
2935
+ /**
2936
+ * Amazon S3 URI of the data lake location.
2937
+ */
2938
+ DataLakeS3Uri?: S3Uri;
2939
+ /**
2940
+ * Data security configuration.
2941
+ */
2942
+ DataSecurityConfig?: DataSecurityConfig;
2943
+ /**
2944
+ * The status of the flywheel.
2945
+ */
2946
+ Status?: FlywheelStatus;
2947
+ /**
2948
+ * Model type of the flywheel's model.
2949
+ */
2950
+ ModelType?: ModelType;
2951
+ /**
2952
+ * A description of the status of the flywheel.
2953
+ */
2954
+ Message?: AnyLengthString;
2955
+ /**
2956
+ * Creation time of the flywheel.
2957
+ */
2958
+ CreationTime?: Timestamp;
2959
+ /**
2960
+ * Last modified time for the flywheel.
2961
+ */
2962
+ LastModifiedTime?: Timestamp;
2963
+ /**
2964
+ * The most recent flywheel iteration.
2965
+ */
2966
+ LatestFlywheelIteration?: FlywheelIterationId;
2967
+ }
2968
+ export type FlywheelS3Uri = string;
2969
+ export type FlywheelStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|string;
2970
+ export interface FlywheelSummary {
2971
+ /**
2972
+ * The Amazon Resource Number (ARN) of the flywheel
2973
+ */
2974
+ FlywheelArn?: ComprehendFlywheelArn;
2975
+ /**
2976
+ * ARN of the active model version for the flywheel.
2977
+ */
2978
+ ActiveModelArn?: ComprehendModelArn;
2979
+ /**
2980
+ * Amazon S3 URI of the data lake location.
2981
+ */
2982
+ DataLakeS3Uri?: S3Uri;
2983
+ /**
2984
+ * The status of the flywheel.
2985
+ */
2986
+ Status?: FlywheelStatus;
2987
+ /**
2988
+ * Model type of the flywheel's model.
2989
+ */
2990
+ ModelType?: ModelType;
2991
+ /**
2992
+ * A description of the status of the flywheel.
2993
+ */
2994
+ Message?: AnyLengthString;
2995
+ /**
2996
+ * Creation time of the flywheel.
2997
+ */
2998
+ CreationTime?: Timestamp;
2999
+ /**
3000
+ * Last modified time for the flywheel.
3001
+ */
3002
+ LastModifiedTime?: Timestamp;
3003
+ /**
3004
+ * The most recent flywheel iteration.
3005
+ */
3006
+ LatestFlywheelIteration?: FlywheelIterationId;
3007
+ }
3008
+ export type FlywheelSummaryList = FlywheelSummary[];
2387
3009
  export interface Geometry {
2388
3010
  /**
2389
3011
  * An axis-aligned coarse representation of the location of the recognized item on the document page.
@@ -2413,11 +3035,11 @@ declare namespace Comprehend {
2413
3035
  */
2414
3036
  ModelKmsKeyId?: KmsKeyId;
2415
3037
  /**
2416
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
3038
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
2417
3039
  */
2418
3040
  DataAccessRoleArn?: IamRoleArn;
2419
3041
  /**
2420
- * Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3042
+ * Tags to associate with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
2421
3043
  */
2422
3044
  Tags?: TagList;
2423
3045
  }
@@ -2525,7 +3147,7 @@ declare namespace Comprehend {
2525
3147
  */
2526
3148
  LanguageCode?: LanguageCode;
2527
3149
  /**
2528
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
3150
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
2529
3151
  */
2530
3152
  DataAccessRoleArn?: IamRoleArn;
2531
3153
  /**
@@ -2540,7 +3162,37 @@ declare namespace Comprehend {
2540
3162
  export type KeyPhrasesDetectionJobPropertiesList = KeyPhrasesDetectionJobProperties[];
2541
3163
  export type KmsKeyId = string;
2542
3164
  export type LabelDelimiter = string;
3165
+ export type LabelListItem = string;
3166
+ export type LabelsList = LabelListItem[];
2543
3167
  export type LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW"|string;
3168
+ export interface ListDatasetsRequest {
3169
+ /**
3170
+ * The Amazon Resource Number (ARN) of the flywheel.
3171
+ */
3172
+ FlywheelArn?: ComprehendFlywheelArn;
3173
+ /**
3174
+ * Filters the datasets to be returned in the response.
3175
+ */
3176
+ Filter?: DatasetFilter;
3177
+ /**
3178
+ * Identifies the next page of results to return.
3179
+ */
3180
+ NextToken?: String;
3181
+ /**
3182
+ * Maximum number of results to return in a response. The default is 100.
3183
+ */
3184
+ MaxResults?: MaxResultsInteger;
3185
+ }
3186
+ export interface ListDatasetsResponse {
3187
+ /**
3188
+ * The dataset properties list.
3189
+ */
3190
+ DatasetPropertiesList?: DatasetPropertiesList;
3191
+ /**
3192
+ * Identifies the next page of results to return.
3193
+ */
3194
+ NextToken?: String;
3195
+ }
2544
3196
  export interface ListDocumentClassificationJobsRequest {
2545
3197
  /**
2546
3198
  * Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
@@ -2697,7 +3349,7 @@ declare namespace Comprehend {
2697
3349
  */
2698
3350
  EntityRecognizerSummariesList?: EntityRecognizerSummariesList;
2699
3351
  /**
2700
- * The list entity recognizer summaries.
3352
+ * Identifies the next page of results to return.
2701
3353
  */
2702
3354
  NextToken?: String;
2703
3355
  }
@@ -2749,6 +3401,58 @@ declare namespace Comprehend {
2749
3401
  */
2750
3402
  NextToken?: String;
2751
3403
  }
3404
+ export interface ListFlywheelIterationHistoryRequest {
3405
+ /**
3406
+ * The ARN of the flywheel.
3407
+ */
3408
+ FlywheelArn: ComprehendFlywheelArn;
3409
+ /**
3410
+ * Filter the flywheel iteration history based on creation time.
3411
+ */
3412
+ Filter?: FlywheelIterationFilter;
3413
+ /**
3414
+ * Next token
3415
+ */
3416
+ NextToken?: String;
3417
+ /**
3418
+ * Maximum number of iteration history results to return
3419
+ */
3420
+ MaxResults?: MaxResultsInteger;
3421
+ }
3422
+ export interface ListFlywheelIterationHistoryResponse {
3423
+ /**
3424
+ * List of flywheel iteration properties
3425
+ */
3426
+ FlywheelIterationPropertiesList?: FlywheelIterationPropertiesList;
3427
+ /**
3428
+ * Next token
3429
+ */
3430
+ NextToken?: String;
3431
+ }
3432
+ export interface ListFlywheelsRequest {
3433
+ /**
3434
+ * Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.
3435
+ */
3436
+ Filter?: FlywheelFilter;
3437
+ /**
3438
+ * Identifies the next page of results to return.
3439
+ */
3440
+ NextToken?: String;
3441
+ /**
3442
+ * Maximum number of results to return in a response. The default is 100.
3443
+ */
3444
+ MaxResults?: MaxResultsInteger;
3445
+ }
3446
+ export interface ListFlywheelsResponse {
3447
+ /**
3448
+ * A list of flywheel properties retrieved by the service in response to the request.
3449
+ */
3450
+ FlywheelSummaryList?: FlywheelSummaryList;
3451
+ /**
3452
+ * Identifies the next page of results to return.
3453
+ */
3454
+ NextToken?: String;
3455
+ }
2752
3456
  export interface ListKeyPhrasesDetectionJobsRequest {
2753
3457
  /**
2754
3458
  * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
@@ -2921,6 +3625,8 @@ declare namespace Comprehend {
2921
3625
  SentimentScore?: SentimentScore;
2922
3626
  }
2923
3627
  export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|string;
3628
+ export type ModelType = "DOCUMENT_CLASSIFIER"|"ENTITY_RECOGNIZER"|string;
3629
+ export type NumberOfDocuments = number;
2924
3630
  export type NumberOfTopicsInteger = number;
2925
3631
  export interface OutputDataConfig {
2926
3632
  /**
@@ -3008,7 +3714,7 @@ declare namespace Comprehend {
3008
3714
  */
3009
3715
  LanguageCode?: LanguageCode;
3010
3716
  /**
3011
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
3717
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
3012
3718
  */
3013
3719
  DataAccessRoleArn?: IamRoleArn;
3014
3720
  /**
@@ -3170,7 +3876,7 @@ declare namespace Comprehend {
3170
3876
  */
3171
3877
  LanguageCode?: LanguageCode;
3172
3878
  /**
3173
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
3879
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
3174
3880
  */
3175
3881
  DataAccessRoleArn?: IamRoleArn;
3176
3882
  /**
@@ -3211,7 +3917,7 @@ declare namespace Comprehend {
3211
3917
  /**
3212
3918
  * The Amazon Resource Name (ARN) of the document classifier to use to process the job.
3213
3919
  */
3214
- DocumentClassifierArn: DocumentClassifierArn;
3920
+ DocumentClassifierArn?: DocumentClassifierArn;
3215
3921
  /**
3216
3922
  * Specifies the format and location of the input data for the job.
3217
3923
  */
@@ -3237,13 +3943,17 @@ declare namespace Comprehend {
3237
3943
  */
3238
3944
  VpcConfig?: VpcConfig;
3239
3945
  /**
3240
- * Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3946
+ * Tags to associate with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3241
3947
  */
3242
3948
  Tags?: TagList;
3949
+ /**
3950
+ * The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
3951
+ */
3952
+ FlywheelArn?: ComprehendFlywheelArn;
3243
3953
  }
3244
3954
  export interface StartDocumentClassificationJobResponse {
3245
3955
  /**
3246
- * The identifier generated for the job. To get the status of the job, use this identifier with the operation.
3956
+ * The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.
3247
3957
  */
3248
3958
  JobId?: JobId;
3249
3959
  /**
@@ -3251,9 +3961,13 @@ declare namespace Comprehend {
3251
3961
  */
3252
3962
  JobArn?: ComprehendArn;
3253
3963
  /**
3254
- * The status of the job: SUBMITTED - The job has been received and queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. For details, use the operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing.
3964
+ * The status of the job: SUBMITTED - The job has been received and queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing.
3255
3965
  */
3256
3966
  JobStatus?: JobStatus;
3967
+ /**
3968
+ * The ARN of the custom classification model.
3969
+ */
3970
+ DocumentClassifierArn?: DocumentClassifierArn;
3257
3971
  }
3258
3972
  export interface StartDominantLanguageDetectionJobRequest {
3259
3973
  /**
@@ -3285,7 +3999,7 @@ declare namespace Comprehend {
3285
3999
  */
3286
4000
  VpcConfig?: VpcConfig;
3287
4001
  /**
3288
- * Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4002
+ * Tags to associate with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3289
4003
  */
3290
4004
  Tags?: TagList;
3291
4005
  }
@@ -3341,9 +4055,13 @@ declare namespace Comprehend {
3341
4055
  */
3342
4056
  VpcConfig?: VpcConfig;
3343
4057
  /**
3344
- * Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4058
+ * Tags to associate with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3345
4059
  */
3346
4060
  Tags?: TagList;
4061
+ /**
4062
+ * The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
4063
+ */
4064
+ FlywheelArn?: ComprehendFlywheelArn;
3347
4065
  }
3348
4066
  export interface StartEntitiesDetectionJobResponse {
3349
4067
  /**
@@ -3358,6 +4076,10 @@ declare namespace Comprehend {
3358
4076
  * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing.
3359
4077
  */
3360
4078
  JobStatus?: JobStatus;
4079
+ /**
4080
+ * The ARN of the custom entity recognition model.
4081
+ */
4082
+ EntityRecognizerArn?: EntityRecognizerArn;
3361
4083
  }
3362
4084
  export interface StartEventsDetectionJobRequest {
3363
4085
  /**
@@ -3389,7 +4111,7 @@ declare namespace Comprehend {
3389
4111
  */
3390
4112
  TargetEventTypes: TargetEventTypes;
3391
4113
  /**
3392
- * Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4114
+ * Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3393
4115
  */
3394
4116
  Tags?: TagList;
3395
4117
  }
@@ -3407,6 +4129,26 @@ declare namespace Comprehend {
3407
4129
  */
3408
4130
  JobStatus?: JobStatus;
3409
4131
  }
4132
+ export interface StartFlywheelIterationRequest {
4133
+ /**
4134
+ * The ARN of the flywheel.
4135
+ */
4136
+ FlywheelArn: ComprehendFlywheelArn;
4137
+ /**
4138
+ * A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
4139
+ */
4140
+ ClientRequestToken?: ClientRequestTokenString;
4141
+ }
4142
+ export interface StartFlywheelIterationResponse {
4143
+ /**
4144
+ *
4145
+ */
4146
+ FlywheelArn?: ComprehendFlywheelArn;
4147
+ /**
4148
+ *
4149
+ */
4150
+ FlywheelIterationId?: FlywheelIterationId;
4151
+ }
3410
4152
  export interface StartKeyPhrasesDetectionJobRequest {
3411
4153
  /**
3412
4154
  * Specifies the format and location of the input data for the job.
@@ -3441,7 +4183,7 @@ declare namespace Comprehend {
3441
4183
  */
3442
4184
  VpcConfig?: VpcConfig;
3443
4185
  /**
3444
- * Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4186
+ * Tags to associate with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3445
4187
  */
3446
4188
  Tags?: TagList;
3447
4189
  }
@@ -3493,7 +4235,7 @@ declare namespace Comprehend {
3493
4235
  */
3494
4236
  ClientRequestToken?: ClientRequestTokenString;
3495
4237
  /**
3496
- * Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4238
+ * Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3497
4239
  */
3498
4240
  Tags?: TagList;
3499
4241
  }
@@ -3545,7 +4287,7 @@ declare namespace Comprehend {
3545
4287
  */
3546
4288
  VpcConfig?: VpcConfig;
3547
4289
  /**
3548
- * Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4290
+ * Tags to associate with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3549
4291
  */
3550
4292
  Tags?: TagList;
3551
4293
  }
@@ -3591,13 +4333,13 @@ declare namespace Comprehend {
3591
4333
  VolumeKmsKeyId?: KmsKeyId;
3592
4334
  VpcConfig?: VpcConfig;
3593
4335
  /**
3594
- * Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4336
+ * Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3595
4337
  */
3596
4338
  Tags?: TagList;
3597
4339
  }
3598
4340
  export interface StartTargetedSentimentDetectionJobResponse {
3599
4341
  /**
3600
- * The identifier generated for the job. To get the status of a job, use this identifier with the operation.
4342
+ * The identifier generated for the job. To get the status of a job, use this identifier with the DescribeTargetedSentimentDetectionJob operation.
3601
4343
  */
3602
4344
  JobId?: JobId;
3603
4345
  /**
@@ -3605,7 +4347,7 @@ declare namespace Comprehend {
3605
4347
  */
3606
4348
  JobArn?: ComprehendArn;
3607
4349
  /**
3608
- * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation.
4350
+ * The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.
3609
4351
  */
3610
4352
  JobStatus?: JobStatus;
3611
4353
  }
@@ -3643,7 +4385,7 @@ declare namespace Comprehend {
3643
4385
  */
3644
4386
  VpcConfig?: VpcConfig;
3645
4387
  /**
3646
- * Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
4388
+ * Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
3647
4389
  */
3648
4390
  Tags?: TagList;
3649
4391
  }
@@ -3897,11 +4639,11 @@ declare namespace Comprehend {
3897
4639
  */
3898
4640
  LanguageCode?: LanguageCode;
3899
4641
  /**
3900
- * The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
4642
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
3901
4643
  */
3902
4644
  DataAccessRoleArn?: IamRoleArn;
3903
4645
  /**
3904
- * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
4646
+ * ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
3905
4647
  */
3906
4648
  VolumeKmsKeyId?: KmsKeyId;
3907
4649
  VpcConfig?: VpcConfig;
@@ -3948,6 +4690,20 @@ declare namespace Comprehend {
3948
4690
  */
3949
4691
  EndOffset?: Integer;
3950
4692
  }
4693
+ export interface TaskConfig {
4694
+ /**
4695
+ * Language code for the language that the model supports.
4696
+ */
4697
+ LanguageCode: LanguageCode;
4698
+ /**
4699
+ * Configuration required for a classification model.
4700
+ */
4701
+ DocumentClassificationConfig?: DocumentClassificationConfig;
4702
+ /**
4703
+ * Configuration required for an entity recognition model.
4704
+ */
4705
+ EntityRecognitionConfig?: EntityRecognitionConfig;
4706
+ }
3951
4707
  export type Timestamp = Date;
3952
4708
  export interface TopicsDetectionJobFilter {
3953
4709
  /**
@@ -4009,7 +4765,7 @@ declare namespace Comprehend {
4009
4765
  */
4010
4766
  NumberOfTopics?: Integer;
4011
4767
  /**
4012
- * The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
4768
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your job data.
4013
4769
  */
4014
4770
  DataAccessRoleArn?: IamRoleArn;
4015
4771
  /**
@@ -4034,6 +4790,17 @@ declare namespace Comprehend {
4034
4790
  }
4035
4791
  export interface UntagResourceResponse {
4036
4792
  }
4793
+ export interface UpdateDataSecurityConfig {
4794
+ /**
4795
+ * ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
4796
+ */
4797
+ ModelKmsKeyId?: KmsKeyId;
4798
+ /**
4799
+ * ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
4800
+ */
4801
+ VolumeKmsKeyId?: KmsKeyId;
4802
+ VpcConfig?: VpcConfig;
4803
+ }
4037
4804
  export interface UpdateEndpointRequest {
4038
4805
  /**
4039
4806
  * The Amazon Resource Number (ARN) of the endpoint being updated.
@@ -4051,8 +4818,40 @@ declare namespace Comprehend {
4051
4818
  * Data access role ARN to use in case the new model is encrypted with a customer CMK.
4052
4819
  */
4053
4820
  DesiredDataAccessRoleArn?: IamRoleArn;
4821
+ /**
4822
+ * The Amazon Resource Number (ARN) of the flywheel
4823
+ */
4824
+ FlywheelArn?: ComprehendFlywheelArn;
4054
4825
  }
4055
4826
  export interface UpdateEndpointResponse {
4827
+ /**
4828
+ * The Amazon Resource Number (ARN) of the new model.
4829
+ */
4830
+ DesiredModelArn?: ComprehendModelArn;
4831
+ }
4832
+ export interface UpdateFlywheelRequest {
4833
+ /**
4834
+ * The Amazon Resource Number (ARN) of the flywheel to update.
4835
+ */
4836
+ FlywheelArn: ComprehendFlywheelArn;
4837
+ /**
4838
+ * The Amazon Resource Number (ARN) of the active model version.
4839
+ */
4840
+ ActiveModelArn?: ComprehendModelArn;
4841
+ /**
4842
+ * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend permission to access the flywheel data.
4843
+ */
4844
+ DataAccessRoleArn?: IamRoleArn;
4845
+ /**
4846
+ * Flywheel data security configuration.
4847
+ */
4848
+ DataSecurityConfig?: UpdateDataSecurityConfig;
4849
+ }
4850
+ export interface UpdateFlywheelResponse {
4851
+ /**
4852
+ * The flywheel properties.
4853
+ */
4854
+ FlywheelProperties?: FlywheelProperties;
4056
4855
  }
4057
4856
  export type VersionName = string;
4058
4857
  export interface VpcConfig {