@aws-sdk/client-comprehend 3.933.0 → 3.935.0

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.
Files changed (45) hide show
  1. package/dist-cjs/index.js +281 -281
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +267 -0
  4. package/dist-es/models/errors.js +229 -0
  5. package/dist-es/models/models_0.js +1 -468
  6. package/dist-es/schemas/schemas_0.js +1 -1
  7. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +1 -1
  8. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +1 -1
  9. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +1 -1
  10. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +1 -1
  11. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +1 -1
  12. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +1 -1
  13. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +1 -1
  14. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +1 -1
  15. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  16. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  17. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  18. package/dist-types/commands/UpdateFlywheelCommand.d.ts +1 -1
  19. package/dist-types/index.d.ts +3 -1
  20. package/dist-types/models/enums.d.ts +555 -0
  21. package/dist-types/models/errors.d.ts +230 -0
  22. package/dist-types/models/models_0.d.ts +352 -757
  23. package/dist-types/ts3.4/commands/StopEntitiesDetectionJobCommand.d.ts +1 -1
  24. package/dist-types/ts3.4/commands/StopEventsDetectionJobCommand.d.ts +1 -1
  25. package/dist-types/ts3.4/commands/StopKeyPhrasesDetectionJobCommand.d.ts +1 -1
  26. package/dist-types/ts3.4/commands/StopPiiEntitiesDetectionJobCommand.d.ts +1 -1
  27. package/dist-types/ts3.4/commands/StopSentimentDetectionJobCommand.d.ts +1 -1
  28. package/dist-types/ts3.4/commands/StopTargetedSentimentDetectionJobCommand.d.ts +1 -1
  29. package/dist-types/ts3.4/commands/StopTrainingDocumentClassifierCommand.d.ts +1 -1
  30. package/dist-types/ts3.4/commands/StopTrainingEntityRecognizerCommand.d.ts +1 -1
  31. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  32. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  33. package/dist-types/ts3.4/commands/UpdateEndpointCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/UpdateFlywheelCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/index.d.ts +3 -1
  36. package/dist-types/ts3.4/models/enums.d.ts +326 -0
  37. package/dist-types/ts3.4/models/errors.d.ts +140 -0
  38. package/dist-types/ts3.4/models/models_0.d.ts +121 -445
  39. package/package.json +12 -12
  40. package/dist-es/models/index.js +0 -2
  41. package/dist-es/models/models_1.js +0 -29
  42. package/dist-types/models/index.d.ts +0 -2
  43. package/dist-types/models/models_1.d.ts +0 -380
  44. package/dist-types/ts3.4/models/index.d.ts +0 -2
  45. package/dist-types/ts3.4/models/models_1.d.ts +0 -106
@@ -1,29 +1,4 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { ComprehendServiceException as __BaseException } from "./ComprehendServiceException";
3
- /**
4
- * @public
5
- * @enum
6
- */
7
- export declare const AugmentedManifestsDocumentTypeFormat: {
8
- readonly PLAIN_TEXT_DOCUMENT: "PLAIN_TEXT_DOCUMENT";
9
- readonly SEMI_STRUCTURED_DOCUMENT: "SEMI_STRUCTURED_DOCUMENT";
10
- };
11
- /**
12
- * @public
13
- */
14
- export type AugmentedManifestsDocumentTypeFormat = (typeof AugmentedManifestsDocumentTypeFormat)[keyof typeof AugmentedManifestsDocumentTypeFormat];
15
- /**
16
- * @public
17
- * @enum
18
- */
19
- export declare const Split: {
20
- readonly TEST: "TEST";
21
- readonly TRAIN: "TRAIN";
22
- };
23
- /**
24
- * @public
25
- */
26
- export type Split = (typeof Split)[keyof typeof Split];
1
+ import { AugmentedManifestsDocumentTypeFormat, BlockType, DatasetDataFormat, DatasetStatus, DatasetType, DocumentClassifierDataFormat, DocumentClassifierDocumentTypeFormat, DocumentClassifierMode, DocumentReadAction, DocumentReadFeatureTypes, DocumentReadMode, DocumentType, EndpointStatus, EntityRecognizerDataFormat, EntityType, FlywheelIterationStatus, FlywheelStatus, InputFormat, InvalidRequestDetailReason, JobStatus, LanguageCode, ModelStatus, ModelType, PageBasedErrorCode, PageBasedWarningCode, PartOfSpeechTagType, PiiEntitiesDetectionMaskMode, PiiEntitiesDetectionMode, PiiEntityType, RelationshipType, SentimentType, Split, SyntaxLanguageCode, TargetedSentimentEntityType, ToxicContentType } from "./enums";
27
2
  /**
28
3
  * <p>An augmented manifest file that provides training data for your custom model. An augmented
29
4
  * manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>
@@ -183,47 +158,6 @@ export interface BatchDetectDominantLanguageResponse {
183
158
  */
184
159
  ErrorList: BatchItemError[] | undefined;
185
160
  }
186
- /**
187
- * <p>The number of documents in the request exceeds the limit of 25. Try your request again
188
- * with fewer documents.</p>
189
- * @public
190
- */
191
- export declare class BatchSizeLimitExceededException extends __BaseException {
192
- readonly name: "BatchSizeLimitExceededException";
193
- readonly $fault: "client";
194
- Message?: string | undefined;
195
- /**
196
- * @internal
197
- */
198
- constructor(opts: __ExceptionOptionType<BatchSizeLimitExceededException, __BaseException>);
199
- }
200
- /**
201
- * <p>An internal server error occurred. Retry your request.</p>
202
- * @public
203
- */
204
- export declare class InternalServerException extends __BaseException {
205
- readonly name: "InternalServerException";
206
- readonly $fault: "server";
207
- Message?: string | undefined;
208
- /**
209
- * @internal
210
- */
211
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
212
- }
213
- /**
214
- * @public
215
- * @enum
216
- */
217
- export declare const InvalidRequestDetailReason: {
218
- readonly DOCUMENT_SIZE_EXCEEDED: "DOCUMENT_SIZE_EXCEEDED";
219
- readonly PAGE_LIMIT_EXCEEDED: "PAGE_LIMIT_EXCEEDED";
220
- readonly TEXTRACT_ACCESS_DENIED: "TEXTRACT_ACCESS_DENIED";
221
- readonly UNSUPPORTED_DOC_TYPE: "UNSUPPORTED_DOC_TYPE";
222
- };
223
- /**
224
- * @public
225
- */
226
- export type InvalidRequestDetailReason = (typeof InvalidRequestDetailReason)[keyof typeof InvalidRequestDetailReason];
227
161
  /**
228
162
  * <p>Provides additional detail about why the request failed.</p>
229
163
  * @public
@@ -258,71 +192,6 @@ export interface InvalidRequestDetail {
258
192
  */
259
193
  Reason?: InvalidRequestDetailReason | undefined;
260
194
  }
261
- /**
262
- * @public
263
- * @enum
264
- */
265
- export declare const InvalidRequestReason: {
266
- readonly INVALID_DOCUMENT: "INVALID_DOCUMENT";
267
- };
268
- /**
269
- * @public
270
- */
271
- export type InvalidRequestReason = (typeof InvalidRequestReason)[keyof typeof InvalidRequestReason];
272
- /**
273
- * <p>The request is invalid.</p>
274
- * @public
275
- */
276
- export declare class InvalidRequestException extends __BaseException {
277
- readonly name: "InvalidRequestException";
278
- readonly $fault: "client";
279
- Message?: string | undefined;
280
- Reason?: InvalidRequestReason | undefined;
281
- /**
282
- * <p>Provides additional detail about why the request failed.</p>
283
- * @public
284
- */
285
- Detail?: InvalidRequestDetail | undefined;
286
- /**
287
- * @internal
288
- */
289
- constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
290
- }
291
- /**
292
- * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
293
- * @public
294
- */
295
- export declare class TextSizeLimitExceededException extends __BaseException {
296
- readonly name: "TextSizeLimitExceededException";
297
- readonly $fault: "client";
298
- Message?: string | undefined;
299
- /**
300
- * @internal
301
- */
302
- constructor(opts: __ExceptionOptionType<TextSizeLimitExceededException, __BaseException>);
303
- }
304
- /**
305
- * @public
306
- * @enum
307
- */
308
- export declare const LanguageCode: {
309
- readonly AR: "ar";
310
- readonly DE: "de";
311
- readonly EN: "en";
312
- readonly ES: "es";
313
- readonly FR: "fr";
314
- readonly HI: "hi";
315
- readonly IT: "it";
316
- readonly JA: "ja";
317
- readonly KO: "ko";
318
- readonly PT: "pt";
319
- readonly ZH: "zh";
320
- readonly ZH_TW: "zh-TW";
321
- };
322
- /**
323
- * @public
324
- */
325
- export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
326
195
  /**
327
196
  * @public
328
197
  */
@@ -387,25 +256,6 @@ export interface BlockReference {
387
256
  */
388
257
  ChildBlocks?: ChildBlock[] | undefined;
389
258
  }
390
- /**
391
- * @public
392
- * @enum
393
- */
394
- export declare const EntityType: {
395
- readonly COMMERCIAL_ITEM: "COMMERCIAL_ITEM";
396
- readonly DATE: "DATE";
397
- readonly EVENT: "EVENT";
398
- readonly LOCATION: "LOCATION";
399
- readonly ORGANIZATION: "ORGANIZATION";
400
- readonly OTHER: "OTHER";
401
- readonly PERSON: "PERSON";
402
- readonly QUANTITY: "QUANTITY";
403
- readonly TITLE: "TITLE";
404
- };
405
- /**
406
- * @public
407
- */
408
- export type EntityType = (typeof EntityType)[keyof typeof EntityType];
409
259
  /**
410
260
  * <p>Provides information about an entity. </p>
411
261
  * <p> </p>
@@ -491,21 +341,6 @@ export interface BatchDetectEntitiesResponse {
491
341
  */
492
342
  ErrorList: BatchItemError[] | undefined;
493
343
  }
494
- /**
495
- * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
496
- * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
497
- * </p>
498
- * @public
499
- */
500
- export declare class UnsupportedLanguageException extends __BaseException {
501
- readonly name: "UnsupportedLanguageException";
502
- readonly $fault: "client";
503
- Message?: string | undefined;
504
- /**
505
- * @internal
506
- */
507
- constructor(opts: __ExceptionOptionType<UnsupportedLanguageException, __BaseException>);
508
- }
509
344
  /**
510
345
  * @public
511
346
  */
@@ -609,20 +444,6 @@ export interface BatchDetectSentimentRequest {
609
444
  */
610
445
  LanguageCode: LanguageCode | undefined;
611
446
  }
612
- /**
613
- * @public
614
- * @enum
615
- */
616
- export declare const SentimentType: {
617
- readonly MIXED: "MIXED";
618
- readonly NEGATIVE: "NEGATIVE";
619
- readonly NEUTRAL: "NEUTRAL";
620
- readonly POSITIVE: "POSITIVE";
621
- };
622
- /**
623
- * @public
624
- */
625
- export type SentimentType = (typeof SentimentType)[keyof typeof SentimentType];
626
447
  /**
627
448
  * <p>Describes the level of confidence that Amazon Comprehend has in the accuracy of its
628
449
  * detection of sentiments.</p>
@@ -699,22 +520,6 @@ export interface BatchDetectSentimentResponse {
699
520
  */
700
521
  ErrorList: BatchItemError[] | undefined;
701
522
  }
702
- /**
703
- * @public
704
- * @enum
705
- */
706
- export declare const SyntaxLanguageCode: {
707
- readonly DE: "de";
708
- readonly EN: "en";
709
- readonly ES: "es";
710
- readonly FR: "fr";
711
- readonly IT: "it";
712
- readonly PT: "pt";
713
- };
714
- /**
715
- * @public
716
- */
717
- export type SyntaxLanguageCode = (typeof SyntaxLanguageCode)[keyof typeof SyntaxLanguageCode];
718
523
  /**
719
524
  * @public
720
525
  */
@@ -733,34 +538,6 @@ export interface BatchDetectSyntaxRequest {
733
538
  */
734
539
  LanguageCode: SyntaxLanguageCode | undefined;
735
540
  }
736
- /**
737
- * @public
738
- * @enum
739
- */
740
- export declare const PartOfSpeechTagType: {
741
- readonly ADJ: "ADJ";
742
- readonly ADP: "ADP";
743
- readonly ADV: "ADV";
744
- readonly AUX: "AUX";
745
- readonly CCONJ: "CCONJ";
746
- readonly CONJ: "CONJ";
747
- readonly DET: "DET";
748
- readonly INTJ: "INTJ";
749
- readonly NOUN: "NOUN";
750
- readonly NUM: "NUM";
751
- readonly O: "O";
752
- readonly PART: "PART";
753
- readonly PRON: "PRON";
754
- readonly PROPN: "PROPN";
755
- readonly PUNCT: "PUNCT";
756
- readonly SCONJ: "SCONJ";
757
- readonly SYM: "SYM";
758
- readonly VERB: "VERB";
759
- };
760
- /**
761
- * @public
762
- */
763
- export type PartOfSpeechTagType = (typeof PartOfSpeechTagType)[keyof typeof PartOfSpeechTagType];
764
541
  /**
765
542
  * <p>Identifies the part of speech represented by the token and gives the confidence that
766
543
  * Amazon Comprehend has that the part of speech was correctly identified. For more information
@@ -891,33 +668,6 @@ export interface MentionSentiment {
891
668
  */
892
669
  SentimentScore?: SentimentScore | undefined;
893
670
  }
894
- /**
895
- * @public
896
- * @enum
897
- */
898
- export declare const TargetedSentimentEntityType: {
899
- readonly ATTRIBUTE: "ATTRIBUTE";
900
- readonly BOOK: "BOOK";
901
- readonly BRAND: "BRAND";
902
- readonly COMMERCIAL_ITEM: "COMMERCIAL_ITEM";
903
- readonly DATE: "DATE";
904
- readonly EVENT: "EVENT";
905
- readonly FACILITY: "FACILITY";
906
- readonly GAME: "GAME";
907
- readonly LOCATION: "LOCATION";
908
- readonly MOVIE: "MOVIE";
909
- readonly MUSIC: "MUSIC";
910
- readonly ORGANIZATION: "ORGANIZATION";
911
- readonly OTHER: "OTHER";
912
- readonly PERSON: "PERSON";
913
- readonly PERSONAL_TITLE: "PERSONAL_TITLE";
914
- readonly QUANTITY: "QUANTITY";
915
- readonly SOFTWARE: "SOFTWARE";
916
- };
917
- /**
918
- * @public
919
- */
920
- export type TargetedSentimentEntityType = (typeof TargetedSentimentEntityType)[keyof typeof TargetedSentimentEntityType];
921
671
  /**
922
672
  * <p>Information about one mention of an entity. The mention information includes the location of the mention
923
673
  * in the text and the sentiment of the mention.</p>
@@ -1013,18 +763,6 @@ export interface BatchDetectTargetedSentimentResponse {
1013
763
  */
1014
764
  ErrorList: BatchItemError[] | undefined;
1015
765
  }
1016
- /**
1017
- * @public
1018
- * @enum
1019
- */
1020
- export declare const BlockType: {
1021
- readonly LINE: "LINE";
1022
- readonly WORD: "WORD";
1023
- };
1024
- /**
1025
- * @public
1026
- */
1027
- export type BlockType = (typeof BlockType)[keyof typeof BlockType];
1028
766
  /**
1029
767
  * <p>The bounding box around the detected page
1030
768
  * or around an element on a document page.
@@ -1091,17 +829,6 @@ export interface Geometry {
1091
829
  */
1092
830
  Polygon?: Point[] | undefined;
1093
831
  }
1094
- /**
1095
- * @public
1096
- * @enum
1097
- */
1098
- export declare const RelationshipType: {
1099
- readonly CHILD: "CHILD";
1100
- };
1101
- /**
1102
- * @public
1103
- */
1104
- export type RelationshipType = (typeof RelationshipType)[keyof typeof RelationshipType];
1105
832
  /**
1106
833
  * <p>List of child blocks for the current block.</p>
1107
834
  * @public
@@ -1262,42 +989,6 @@ export interface ClassifierMetadata {
1262
989
  */
1263
990
  EvaluationMetrics?: ClassifierEvaluationMetrics | undefined;
1264
991
  }
1265
- /**
1266
- * @public
1267
- * @enum
1268
- */
1269
- export declare const DocumentReadAction: {
1270
- readonly TEXTRACT_ANALYZE_DOCUMENT: "TEXTRACT_ANALYZE_DOCUMENT";
1271
- readonly TEXTRACT_DETECT_DOCUMENT_TEXT: "TEXTRACT_DETECT_DOCUMENT_TEXT";
1272
- };
1273
- /**
1274
- * @public
1275
- */
1276
- export type DocumentReadAction = (typeof DocumentReadAction)[keyof typeof DocumentReadAction];
1277
- /**
1278
- * @public
1279
- * @enum
1280
- */
1281
- export declare const DocumentReadMode: {
1282
- readonly FORCE_DOCUMENT_READ_ACTION: "FORCE_DOCUMENT_READ_ACTION";
1283
- readonly SERVICE_DEFAULT: "SERVICE_DEFAULT";
1284
- };
1285
- /**
1286
- * @public
1287
- */
1288
- export type DocumentReadMode = (typeof DocumentReadMode)[keyof typeof DocumentReadMode];
1289
- /**
1290
- * @public
1291
- * @enum
1292
- */
1293
- export declare const DocumentReadFeatureTypes: {
1294
- readonly FORMS: "FORMS";
1295
- readonly TABLES: "TABLES";
1296
- };
1297
- /**
1298
- * @public
1299
- */
1300
- export type DocumentReadFeatureTypes = (typeof DocumentReadFeatureTypes)[keyof typeof DocumentReadFeatureTypes];
1301
992
  /**
1302
993
  * <p>Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. </p>
1303
994
  * <p> By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type: </p>
@@ -1472,23 +1163,6 @@ export interface DocumentMetadata {
1472
1163
  */
1473
1164
  ExtractedCharacters?: ExtractedCharactersListItem[] | undefined;
1474
1165
  }
1475
- /**
1476
- * @public
1477
- * @enum
1478
- */
1479
- export declare const DocumentType: {
1480
- readonly IMAGE: "IMAGE";
1481
- readonly MS_WORD: "MS_WORD";
1482
- readonly NATIVE_PDF: "NATIVE_PDF";
1483
- readonly PLAIN_TEXT: "PLAIN_TEXT";
1484
- readonly SCANNED_PDF: "SCANNED_PDF";
1485
- readonly TEXTRACT_ANALYZE_DOCUMENT_JSON: "TEXTRACT_ANALYZE_DOCUMENT_JSON";
1486
- readonly TEXTRACT_DETECT_DOCUMENT_TEXT_JSON: "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON";
1487
- };
1488
- /**
1489
- * @public
1490
- */
1491
- export type DocumentType = (typeof DocumentType)[keyof typeof DocumentType];
1492
1166
  /**
1493
1167
  * <p>Document type for each page in the document.</p>
1494
1168
  * @public
@@ -1505,21 +1179,6 @@ export interface DocumentTypeListItem {
1505
1179
  */
1506
1180
  Type?: DocumentType | undefined;
1507
1181
  }
1508
- /**
1509
- * @public
1510
- * @enum
1511
- */
1512
- export declare const PageBasedErrorCode: {
1513
- readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
1514
- readonly PAGE_CHARACTERS_EXCEEDED: "PAGE_CHARACTERS_EXCEEDED";
1515
- readonly PAGE_SIZE_EXCEEDED: "PAGE_SIZE_EXCEEDED";
1516
- readonly TEXTRACT_BAD_PAGE: "TEXTRACT_BAD_PAGE";
1517
- readonly TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED: "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED";
1518
- };
1519
- /**
1520
- * @public
1521
- */
1522
- export type PageBasedErrorCode = (typeof PageBasedErrorCode)[keyof typeof PageBasedErrorCode];
1523
1182
  /**
1524
1183
  * <p>Text extraction encountered one or more page-level errors in the input document.</p>
1525
1184
  * <p>The <code>ErrorCode</code> contains one of the following values:</p>
@@ -1585,18 +1244,6 @@ export interface DocumentLabel {
1585
1244
  */
1586
1245
  Page?: number | undefined;
1587
1246
  }
1588
- /**
1589
- * @public
1590
- * @enum
1591
- */
1592
- export declare const PageBasedWarningCode: {
1593
- readonly INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL: "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL";
1594
- readonly INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL: "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL";
1595
- };
1596
- /**
1597
- * @public
1598
- */
1599
- export type PageBasedWarningCode = (typeof PageBasedWarningCode)[keyof typeof PageBasedWarningCode];
1600
1247
  /**
1601
1248
  * <p>The system identified one of the following warnings while processing the input document:</p>
1602
1249
  * <ul>
@@ -1676,20 +1323,6 @@ export interface ClassifyDocumentResponse {
1676
1323
  */
1677
1324
  Warnings?: WarningsListItem[] | undefined;
1678
1325
  }
1679
- /**
1680
- * <p>The specified resource is not available. Check the resource and try your request
1681
- * again.</p>
1682
- * @public
1683
- */
1684
- export declare class ResourceUnavailableException extends __BaseException {
1685
- readonly name: "ResourceUnavailableException";
1686
- readonly $fault: "client";
1687
- Message?: string | undefined;
1688
- /**
1689
- * @internal
1690
- */
1691
- constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
1692
- }
1693
1326
  /**
1694
1327
  * @public
1695
1328
  */
@@ -1705,53 +1338,6 @@ export interface ContainsPiiEntitiesRequest {
1705
1338
  */
1706
1339
  LanguageCode: LanguageCode | undefined;
1707
1340
  }
1708
- /**
1709
- * @public
1710
- * @enum
1711
- */
1712
- export declare const PiiEntityType: {
1713
- readonly ADDRESS: "ADDRESS";
1714
- readonly AGE: "AGE";
1715
- readonly ALL: "ALL";
1716
- readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
1717
- readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
1718
- readonly BANK_ACCOUNT_NUMBER: "BANK_ACCOUNT_NUMBER";
1719
- readonly BANK_ROUTING: "BANK_ROUTING";
1720
- readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
1721
- readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
1722
- readonly CREDIT_DEBIT_CVV: "CREDIT_DEBIT_CVV";
1723
- readonly CREDIT_DEBIT_EXPIRY: "CREDIT_DEBIT_EXPIRY";
1724
- readonly CREDIT_DEBIT_NUMBER: "CREDIT_DEBIT_NUMBER";
1725
- readonly DATE_TIME: "DATE_TIME";
1726
- readonly DRIVER_ID: "DRIVER_ID";
1727
- readonly EMAIL: "EMAIL";
1728
- readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
1729
- readonly IN_AADHAAR: "IN_AADHAAR";
1730
- readonly IN_NREGA: "IN_NREGA";
1731
- readonly IN_PERMANENT_ACCOUNT_NUMBER: "IN_PERMANENT_ACCOUNT_NUMBER";
1732
- readonly IN_VOTER_NUMBER: "IN_VOTER_NUMBER";
1733
- readonly IP_ADDRESS: "IP_ADDRESS";
1734
- readonly LICENSE_PLATE: "LICENSE_PLATE";
1735
- readonly MAC_ADDRESS: "MAC_ADDRESS";
1736
- readonly NAME: "NAME";
1737
- readonly PASSPORT_NUMBER: "PASSPORT_NUMBER";
1738
- readonly PASSWORD: "PASSWORD";
1739
- readonly PHONE: "PHONE";
1740
- readonly PIN: "PIN";
1741
- readonly SSN: "SSN";
1742
- readonly SWIFT_CODE: "SWIFT_CODE";
1743
- readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
1744
- readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
1745
- readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
1746
- readonly URL: "URL";
1747
- readonly USERNAME: "USERNAME";
1748
- readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
1749
- readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
1750
- };
1751
- /**
1752
- * @public
1753
- */
1754
- export type PiiEntityType = (typeof PiiEntityType)[keyof typeof PiiEntityType];
1755
1341
  /**
1756
1342
  * <p>Specifies one of the label or labels that categorize the personally identifiable
1757
1343
  * information (PII) entity being analyzed.</p>
@@ -1781,18 +1367,6 @@ export interface ContainsPiiEntitiesResponse {
1781
1367
  */
1782
1368
  Labels?: EntityLabel[] | undefined;
1783
1369
  }
1784
- /**
1785
- * @public
1786
- * @enum
1787
- */
1788
- export declare const DatasetType: {
1789
- readonly TEST: "TEST";
1790
- readonly TRAIN: "TRAIN";
1791
- };
1792
- /**
1793
- * @public
1794
- */
1795
- export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
1796
1370
  /**
1797
1371
  * <p>An augmented manifest file that provides training data for your custom model.
1798
1372
  * An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>
@@ -1837,18 +1411,6 @@ export interface DatasetAugmentedManifestsListItem {
1837
1411
  */
1838
1412
  DocumentType?: AugmentedManifestsDocumentTypeFormat | undefined;
1839
1413
  }
1840
- /**
1841
- * @public
1842
- * @enum
1843
- */
1844
- export declare const DatasetDataFormat: {
1845
- readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
1846
- readonly COMPREHEND_CSV: "COMPREHEND_CSV";
1847
- };
1848
- /**
1849
- * @public
1850
- */
1851
- export type DatasetDataFormat = (typeof DatasetDataFormat)[keyof typeof DatasetDataFormat];
1852
1414
  /**
1853
1415
  * <p>Describes the dataset input data configuration for a document classifier model.</p>
1854
1416
  * <p>For more information on how the input file is formatted, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html">Preparing training data</a>
@@ -1892,18 +1454,6 @@ export interface DatasetEntityRecognizerAnnotations {
1892
1454
  */
1893
1455
  S3Uri: string | undefined;
1894
1456
  }
1895
- /**
1896
- * @public
1897
- * @enum
1898
- */
1899
- export declare const InputFormat: {
1900
- readonly ONE_DOC_PER_FILE: "ONE_DOC_PER_FILE";
1901
- readonly ONE_DOC_PER_LINE: "ONE_DOC_PER_LINE";
1902
- };
1903
- /**
1904
- * @public
1905
- */
1906
- export type InputFormat = (typeof InputFormat)[keyof typeof InputFormat];
1907
1457
  /**
1908
1458
  * <p>Describes the documents submitted with a dataset for an entity recognizer model.</p>
1909
1459
  * @public
@@ -2072,87 +1622,6 @@ export interface CreateDatasetResponse {
2072
1622
  */
2073
1623
  DatasetArn?: string | undefined;
2074
1624
  }
2075
- /**
2076
- * <p>The specified resource name is already in use. Use a different name and try your request
2077
- * again.</p>
2078
- * @public
2079
- */
2080
- export declare class ResourceInUseException extends __BaseException {
2081
- readonly name: "ResourceInUseException";
2082
- readonly $fault: "client";
2083
- Message?: string | undefined;
2084
- /**
2085
- * @internal
2086
- */
2087
- constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
2088
- }
2089
- /**
2090
- * <p>The maximum number of resources per account has been exceeded. Review the resources, and
2091
- * then try your request again.</p>
2092
- * @public
2093
- */
2094
- export declare class ResourceLimitExceededException extends __BaseException {
2095
- readonly name: "ResourceLimitExceededException";
2096
- readonly $fault: "client";
2097
- Message?: string | undefined;
2098
- /**
2099
- * @internal
2100
- */
2101
- constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
2102
- }
2103
- /**
2104
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
2105
- * @public
2106
- */
2107
- export declare class ResourceNotFoundException extends __BaseException {
2108
- readonly name: "ResourceNotFoundException";
2109
- readonly $fault: "client";
2110
- Message?: string | undefined;
2111
- /**
2112
- * @internal
2113
- */
2114
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
2115
- }
2116
- /**
2117
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
2118
- * @public
2119
- */
2120
- export declare class TooManyRequestsException extends __BaseException {
2121
- readonly name: "TooManyRequestsException";
2122
- readonly $fault: "client";
2123
- Message?: string | undefined;
2124
- /**
2125
- * @internal
2126
- */
2127
- constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
2128
- }
2129
- /**
2130
- * <p>The request contains more tags than can be associated with a resource (50 tags per
2131
- * resource). The maximum number of tags includes both existing tags and those included in your
2132
- * current request. </p>
2133
- * @public
2134
- */
2135
- export declare class TooManyTagsException extends __BaseException {
2136
- readonly name: "TooManyTagsException";
2137
- readonly $fault: "client";
2138
- Message?: string | undefined;
2139
- /**
2140
- * @internal
2141
- */
2142
- constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
2143
- }
2144
- /**
2145
- * @public
2146
- * @enum
2147
- */
2148
- export declare const DocumentClassifierDataFormat: {
2149
- readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
2150
- readonly COMPREHEND_CSV: "COMPREHEND_CSV";
2151
- };
2152
- /**
2153
- * @public
2154
- */
2155
- export type DocumentClassifierDataFormat = (typeof DocumentClassifierDataFormat)[keyof typeof DocumentClassifierDataFormat];
2156
1625
  /**
2157
1626
  * <p>The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.</p>
2158
1627
  * @public
@@ -2170,18 +1639,6 @@ export interface DocumentClassifierDocuments {
2170
1639
  */
2171
1640
  TestS3Uri?: string | undefined;
2172
1641
  }
2173
- /**
2174
- * @public
2175
- * @enum
2176
- */
2177
- export declare const DocumentClassifierDocumentTypeFormat: {
2178
- readonly PLAIN_TEXT_DOCUMENT: "PLAIN_TEXT_DOCUMENT";
2179
- readonly SEMI_STRUCTURED_DOCUMENT: "SEMI_STRUCTURED_DOCUMENT";
2180
- };
2181
- /**
2182
- * @public
2183
- */
2184
- export type DocumentClassifierDocumentTypeFormat = (typeof DocumentClassifierDocumentTypeFormat)[keyof typeof DocumentClassifierDocumentTypeFormat];
2185
1642
  /**
2186
1643
  * <p>The input properties for training a document classifier. </p>
2187
1644
  * <p>For more information on how the input file is formatted, see
@@ -2291,18 +1748,6 @@ export interface DocumentClassifierInputDataConfig {
2291
1748
  */
2292
1749
  DocumentReaderConfig?: DocumentReaderConfig | undefined;
2293
1750
  }
2294
- /**
2295
- * @public
2296
- * @enum
2297
- */
2298
- export declare const DocumentClassifierMode: {
2299
- readonly MULTI_CLASS: "MULTI_CLASS";
2300
- readonly MULTI_LABEL: "MULTI_LABEL";
2301
- };
2302
- /**
2303
- * @public
2304
- */
2305
- export type DocumentClassifierMode = (typeof DocumentClassifierMode)[keyof typeof DocumentClassifierMode];
2306
1751
  /**
2307
1752
  * <p>Provide the location for output data from a custom classifier job. This field is mandatory
2308
1753
  * if you are training a native document model.</p>
@@ -2514,20 +1959,6 @@ export interface CreateDocumentClassifierResponse {
2514
1959
  */
2515
1960
  DocumentClassifierArn?: string | undefined;
2516
1961
  }
2517
- /**
2518
- * <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
2519
- * re-enter it.</p>
2520
- * @public
2521
- */
2522
- export declare class KmsKeyValidationException extends __BaseException {
2523
- readonly name: "KmsKeyValidationException";
2524
- readonly $fault: "client";
2525
- Message?: string | undefined;
2526
- /**
2527
- * @internal
2528
- */
2529
- constructor(opts: __ExceptionOptionType<KmsKeyValidationException, __BaseException>);
2530
- }
2531
1962
  /**
2532
1963
  * @public
2533
1964
  */
@@ -2613,18 +2044,6 @@ export interface EntityRecognizerAnnotations {
2613
2044
  */
2614
2045
  TestS3Uri?: string | undefined;
2615
2046
  }
2616
- /**
2617
- * @public
2618
- * @enum
2619
- */
2620
- export declare const EntityRecognizerDataFormat: {
2621
- readonly AUGMENTED_MANIFEST: "AUGMENTED_MANIFEST";
2622
- readonly COMPREHEND_CSV: "COMPREHEND_CSV";
2623
- };
2624
- /**
2625
- * @public
2626
- */
2627
- export type EntityRecognizerDataFormat = (typeof EntityRecognizerDataFormat)[keyof typeof EntityRecognizerDataFormat];
2628
2047
  /**
2629
2048
  * <p>Describes the training documents submitted with an entity recognizer.</p>
2630
2049
  * @public
@@ -2919,18 +2338,6 @@ export interface DataSecurityConfig {
2919
2338
  */
2920
2339
  VpcConfig?: VpcConfig | undefined;
2921
2340
  }
2922
- /**
2923
- * @public
2924
- * @enum
2925
- */
2926
- export declare const ModelType: {
2927
- readonly DOCUMENT_CLASSIFIER: "DOCUMENT_CLASSIFIER";
2928
- readonly ENTITY_RECOGNIZER: "ENTITY_RECOGNIZER";
2929
- };
2930
- /**
2931
- * @public
2932
- */
2933
- export type ModelType = (typeof ModelType)[keyof typeof ModelType];
2934
2341
  /**
2935
2342
  * <p>Configuration required for a document classification model.</p>
2936
2343
  * @public
@@ -3139,19 +2546,6 @@ export interface DescribeDatasetRequest {
3139
2546
  */
3140
2547
  DatasetArn: string | undefined;
3141
2548
  }
3142
- /**
3143
- * @public
3144
- * @enum
3145
- */
3146
- export declare const DatasetStatus: {
3147
- readonly COMPLETED: "COMPLETED";
3148
- readonly CREATING: "CREATING";
3149
- readonly FAILED: "FAILED";
3150
- };
3151
- /**
3152
- * @public
3153
- */
3154
- export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
3155
2549
  /**
3156
2550
  * <p>Properties associated with the dataset.</p>
3157
2551
  * @public
@@ -3273,24 +2667,8 @@ export interface InputDataConfig {
3273
2667
  DocumentReaderConfig?: DocumentReaderConfig | undefined;
3274
2668
  }
3275
2669
  /**
3276
- * @public
3277
- * @enum
3278
- */
3279
- export declare const JobStatus: {
3280
- readonly COMPLETED: "COMPLETED";
3281
- readonly FAILED: "FAILED";
3282
- readonly IN_PROGRESS: "IN_PROGRESS";
3283
- readonly STOPPED: "STOPPED";
3284
- readonly STOP_REQUESTED: "STOP_REQUESTED";
3285
- readonly SUBMITTED: "SUBMITTED";
3286
- };
3287
- /**
3288
- * @public
3289
- */
3290
- export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
3291
- /**
3292
- * <p>Provides configuration parameters for the output of inference jobs.</p>
3293
- * <p></p>
2670
+ * <p>Provides configuration parameters for the output of inference jobs.</p>
2671
+ * <p></p>
3294
2672
  * @public
3295
2673
  */
3296
2674
  export interface OutputDataConfig {
@@ -3454,19 +2832,6 @@ export interface DescribeDocumentClassificationJobResponse {
3454
2832
  */
3455
2833
  DocumentClassificationJobProperties?: DocumentClassificationJobProperties | undefined;
3456
2834
  }
3457
- /**
3458
- * <p>The specified job was not found. Check the job ID and try again.</p>
3459
- * @public
3460
- */
3461
- export declare class JobNotFoundException extends __BaseException {
3462
- readonly name: "JobNotFoundException";
3463
- readonly $fault: "client";
3464
- Message?: string | undefined;
3465
- /**
3466
- * @internal
3467
- */
3468
- constructor(opts: __ExceptionOptionType<JobNotFoundException, __BaseException>);
3469
- }
3470
2835
  /**
3471
2836
  * @public
3472
2837
  */
@@ -3478,24 +2843,6 @@ export interface DescribeDocumentClassifierRequest {
3478
2843
  */
3479
2844
  DocumentClassifierArn: string | undefined;
3480
2845
  }
3481
- /**
3482
- * @public
3483
- * @enum
3484
- */
3485
- export declare const ModelStatus: {
3486
- readonly DELETING: "DELETING";
3487
- readonly IN_ERROR: "IN_ERROR";
3488
- readonly STOPPED: "STOPPED";
3489
- readonly STOP_REQUESTED: "STOP_REQUESTED";
3490
- readonly SUBMITTED: "SUBMITTED";
3491
- readonly TRAINED: "TRAINED";
3492
- readonly TRAINED_WITH_WARNING: "TRAINED_WITH_WARNING";
3493
- readonly TRAINING: "TRAINING";
3494
- };
3495
- /**
3496
- * @public
3497
- */
3498
- export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
3499
2846
  /**
3500
2847
  * <p>Provides information about a document classifier.</p>
3501
2848
  * @public
@@ -3777,21 +3124,6 @@ export interface DescribeEndpointRequest {
3777
3124
  */
3778
3125
  EndpointArn: string | undefined;
3779
3126
  }
3780
- /**
3781
- * @public
3782
- * @enum
3783
- */
3784
- export declare const EndpointStatus: {
3785
- readonly CREATING: "CREATING";
3786
- readonly DELETING: "DELETING";
3787
- readonly FAILED: "FAILED";
3788
- readonly IN_SERVICE: "IN_SERVICE";
3789
- readonly UPDATING: "UPDATING";
3790
- };
3791
- /**
3792
- * @public
3793
- */
3794
- export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus];
3795
3127
  /**
3796
3128
  * <p>Specifies information about the specified endpoint.
3797
3129
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
@@ -4381,21 +3713,6 @@ export interface DescribeFlywheelRequest {
4381
3713
  */
4382
3714
  FlywheelArn: string | undefined;
4383
3715
  }
4384
- /**
4385
- * @public
4386
- * @enum
4387
- */
4388
- export declare const FlywheelStatus: {
4389
- readonly ACTIVE: "ACTIVE";
4390
- readonly CREATING: "CREATING";
4391
- readonly DELETING: "DELETING";
4392
- readonly FAILED: "FAILED";
4393
- readonly UPDATING: "UPDATING";
4394
- };
4395
- /**
4396
- * @public
4397
- */
4398
- export type FlywheelStatus = (typeof FlywheelStatus)[keyof typeof FlywheelStatus];
4399
3716
  /**
4400
3717
  * <p>The flywheel properties.</p>
4401
3718
  * @public
@@ -4514,22 +3831,6 @@ export interface FlywheelModelEvaluationMetrics {
4514
3831
  */
4515
3832
  AverageAccuracy?: number | undefined;
4516
3833
  }
4517
- /**
4518
- * @public
4519
- * @enum
4520
- */
4521
- export declare const FlywheelIterationStatus: {
4522
- readonly COMPLETED: "COMPLETED";
4523
- readonly EVALUATING: "EVALUATING";
4524
- readonly FAILED: "FAILED";
4525
- readonly STOPPED: "STOPPED";
4526
- readonly STOP_REQUESTED: "STOP_REQUESTED";
4527
- readonly TRAINING: "TRAINING";
4528
- };
4529
- /**
4530
- * @public
4531
- */
4532
- export type FlywheelIterationStatus = (typeof FlywheelIterationStatus)[keyof typeof FlywheelIterationStatus];
4533
3834
  /**
4534
3835
  * <p>The configuration properties of a flywheel iteration.</p>
4535
3836
  * @public
@@ -4734,18 +4035,6 @@ export interface DescribePiiEntitiesDetectionJobRequest {
4734
4035
  */
4735
4036
  JobId: string | undefined;
4736
4037
  }
4737
- /**
4738
- * @public
4739
- * @enum
4740
- */
4741
- export declare const PiiEntitiesDetectionMode: {
4742
- readonly ONLY_OFFSETS: "ONLY_OFFSETS";
4743
- readonly ONLY_REDACTION: "ONLY_REDACTION";
4744
- };
4745
- /**
4746
- * @public
4747
- */
4748
- export type PiiEntitiesDetectionMode = (typeof PiiEntitiesDetectionMode)[keyof typeof PiiEntitiesDetectionMode];
4749
4038
  /**
4750
4039
  * <p>Provides configuration parameters for the output of PII entity detection jobs.</p>
4751
4040
  * @public
@@ -4768,18 +4057,6 @@ export interface PiiOutputDataConfig {
4768
4057
  */
4769
4058
  KmsKeyId?: string | undefined;
4770
4059
  }
4771
- /**
4772
- * @public
4773
- * @enum
4774
- */
4775
- export declare const PiiEntitiesDetectionMaskMode: {
4776
- readonly MASK: "MASK";
4777
- readonly REPLACE_WITH_PII_ENTITY_TYPE: "REPLACE_WITH_PII_ENTITY_TYPE";
4778
- };
4779
- /**
4780
- * @public
4781
- */
4782
- export type PiiEntitiesDetectionMaskMode = (typeof PiiEntitiesDetectionMaskMode)[keyof typeof PiiEntitiesDetectionMaskMode];
4783
4060
  /**
4784
4061
  * <p>Provides configuration parameters for PII entity redaction.</p>
4785
4062
  * @public
@@ -5626,23 +4903,6 @@ export interface DetectToxicContentRequest {
5626
4903
  */
5627
4904
  LanguageCode: LanguageCode | undefined;
5628
4905
  }
5629
- /**
5630
- * @public
5631
- * @enum
5632
- */
5633
- export declare const ToxicContentType: {
5634
- readonly GRAPHIC: "GRAPHIC";
5635
- readonly HARASSMENT_OR_ABUSE: "HARASSMENT_OR_ABUSE";
5636
- readonly HATE_SPEECH: "HATE_SPEECH";
5637
- readonly INSULT: "INSULT";
5638
- readonly PROFANITY: "PROFANITY";
5639
- readonly SEXUAL: "SEXUAL";
5640
- readonly VIOLENCE_OR_THREAT: "VIOLENCE_OR_THREAT";
5641
- };
5642
- /**
5643
- * @public
5644
- */
5645
- export type ToxicContentType = (typeof ToxicContentType)[keyof typeof ToxicContentType];
5646
4906
  /**
5647
4907
  * <p>Toxic content analysis result for one string. For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>
5648
4908
  * </p>
@@ -5757,20 +5017,6 @@ export interface ImportModelResponse {
5757
5017
  */
5758
5018
  ModelArn?: string | undefined;
5759
5019
  }
5760
- /**
5761
- * <p>The filter specified for the operation is invalid. Specify a different
5762
- * filter.</p>
5763
- * @public
5764
- */
5765
- export declare class InvalidFilterException extends __BaseException {
5766
- readonly name: "InvalidFilterException";
5767
- readonly $fault: "client";
5768
- Message?: string | undefined;
5769
- /**
5770
- * @internal
5771
- */
5772
- constructor(opts: __ExceptionOptionType<InvalidFilterException, __BaseException>);
5773
- }
5774
5020
  /**
5775
5021
  * <p>Filter the datasets based on creation time or dataset status.</p>
5776
5022
  * @public
@@ -8081,3 +7327,352 @@ export interface StopDominantLanguageDetectionJobResponse {
8081
7327
  */
8082
7328
  JobStatus?: JobStatus | undefined;
8083
7329
  }
7330
+ /**
7331
+ * @public
7332
+ */
7333
+ export interface StopEntitiesDetectionJobRequest {
7334
+ /**
7335
+ * <p>The identifier of the entities detection job to stop.</p>
7336
+ * @public
7337
+ */
7338
+ JobId: string | undefined;
7339
+ }
7340
+ /**
7341
+ * @public
7342
+ */
7343
+ export interface StopEntitiesDetectionJobResponse {
7344
+ /**
7345
+ * <p>The identifier of the entities detection job to stop.</p>
7346
+ * @public
7347
+ */
7348
+ JobId?: string | undefined;
7349
+ /**
7350
+ * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
7351
+ * <code>STOPPED</code> if the job was previously stopped with the
7352
+ * <code>StopEntitiesDetectionJob</code> operation.</p>
7353
+ * @public
7354
+ */
7355
+ JobStatus?: JobStatus | undefined;
7356
+ }
7357
+ /**
7358
+ * @public
7359
+ */
7360
+ export interface StopEventsDetectionJobRequest {
7361
+ /**
7362
+ * <p>The identifier of the events detection job to stop.</p>
7363
+ * @public
7364
+ */
7365
+ JobId: string | undefined;
7366
+ }
7367
+ /**
7368
+ * @public
7369
+ */
7370
+ export interface StopEventsDetectionJobResponse {
7371
+ /**
7372
+ * <p>The identifier of the events detection job to stop.</p>
7373
+ * @public
7374
+ */
7375
+ JobId?: string | undefined;
7376
+ /**
7377
+ * <p>The status of the events detection job.</p>
7378
+ * @public
7379
+ */
7380
+ JobStatus?: JobStatus | undefined;
7381
+ }
7382
+ /**
7383
+ * @public
7384
+ */
7385
+ export interface StopKeyPhrasesDetectionJobRequest {
7386
+ /**
7387
+ * <p>The identifier of the key phrases detection job to stop.</p>
7388
+ * @public
7389
+ */
7390
+ JobId: string | undefined;
7391
+ }
7392
+ /**
7393
+ * @public
7394
+ */
7395
+ export interface StopKeyPhrasesDetectionJobResponse {
7396
+ /**
7397
+ * <p>The identifier of the key phrases detection job to stop.</p>
7398
+ * @public
7399
+ */
7400
+ JobId?: string | undefined;
7401
+ /**
7402
+ * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
7403
+ * <code>STOPPED</code> if the job was previously stopped with the
7404
+ * <code>StopKeyPhrasesDetectionJob</code> operation.</p>
7405
+ * @public
7406
+ */
7407
+ JobStatus?: JobStatus | undefined;
7408
+ }
7409
+ /**
7410
+ * @public
7411
+ */
7412
+ export interface StopPiiEntitiesDetectionJobRequest {
7413
+ /**
7414
+ * <p>The identifier of the PII entities detection job to stop.</p>
7415
+ * @public
7416
+ */
7417
+ JobId: string | undefined;
7418
+ }
7419
+ /**
7420
+ * @public
7421
+ */
7422
+ export interface StopPiiEntitiesDetectionJobResponse {
7423
+ /**
7424
+ * <p>The identifier of the PII entities detection job to stop.</p>
7425
+ * @public
7426
+ */
7427
+ JobId?: string | undefined;
7428
+ /**
7429
+ * <p>The status of the PII entities detection job.</p>
7430
+ * @public
7431
+ */
7432
+ JobStatus?: JobStatus | undefined;
7433
+ }
7434
+ /**
7435
+ * @public
7436
+ */
7437
+ export interface StopSentimentDetectionJobRequest {
7438
+ /**
7439
+ * <p>The identifier of the sentiment detection job to stop.</p>
7440
+ * @public
7441
+ */
7442
+ JobId: string | undefined;
7443
+ }
7444
+ /**
7445
+ * @public
7446
+ */
7447
+ export interface StopSentimentDetectionJobResponse {
7448
+ /**
7449
+ * <p>The identifier of the sentiment detection job to stop.</p>
7450
+ * @public
7451
+ */
7452
+ JobId?: string | undefined;
7453
+ /**
7454
+ * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
7455
+ * <code>STOPPED</code> if the job was previously stopped with the
7456
+ * <code>StopSentimentDetectionJob</code> operation.</p>
7457
+ * @public
7458
+ */
7459
+ JobStatus?: JobStatus | undefined;
7460
+ }
7461
+ /**
7462
+ * @public
7463
+ */
7464
+ export interface StopTargetedSentimentDetectionJobRequest {
7465
+ /**
7466
+ * <p>The identifier of the targeted sentiment detection job to stop.</p>
7467
+ * @public
7468
+ */
7469
+ JobId: string | undefined;
7470
+ }
7471
+ /**
7472
+ * @public
7473
+ */
7474
+ export interface StopTargetedSentimentDetectionJobResponse {
7475
+ /**
7476
+ * <p>The identifier of the targeted sentiment detection job to stop.</p>
7477
+ * @public
7478
+ */
7479
+ JobId?: string | undefined;
7480
+ /**
7481
+ * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
7482
+ * <code>STOPPED</code> if the job was previously stopped with the
7483
+ * <code>StopSentimentDetectionJob</code> operation.</p>
7484
+ * @public
7485
+ */
7486
+ JobStatus?: JobStatus | undefined;
7487
+ }
7488
+ /**
7489
+ * @public
7490
+ */
7491
+ export interface StopTrainingDocumentClassifierRequest {
7492
+ /**
7493
+ * <p>The Amazon Resource Name (ARN) that identifies the document classifier currently being
7494
+ * trained.</p>
7495
+ * @public
7496
+ */
7497
+ DocumentClassifierArn: string | undefined;
7498
+ }
7499
+ /**
7500
+ * @public
7501
+ */
7502
+ export interface StopTrainingDocumentClassifierResponse {
7503
+ }
7504
+ /**
7505
+ * @public
7506
+ */
7507
+ export interface StopTrainingEntityRecognizerRequest {
7508
+ /**
7509
+ * <p>The Amazon Resource Name (ARN) that identifies the entity recognizer currently being
7510
+ * trained.</p>
7511
+ * @public
7512
+ */
7513
+ EntityRecognizerArn: string | undefined;
7514
+ }
7515
+ /**
7516
+ * @public
7517
+ */
7518
+ export interface StopTrainingEntityRecognizerResponse {
7519
+ }
7520
+ /**
7521
+ * @public
7522
+ */
7523
+ export interface TagResourceRequest {
7524
+ /**
7525
+ * <p>The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want
7526
+ * to associate the tags. </p>
7527
+ * @public
7528
+ */
7529
+ ResourceArn: string | undefined;
7530
+ /**
7531
+ * <p>Tags being associated with a specific Amazon Comprehend resource. There can be a maximum
7532
+ * of 50 tags (both existing and pending) associated with a specific resource. </p>
7533
+ * @public
7534
+ */
7535
+ Tags: Tag[] | undefined;
7536
+ }
7537
+ /**
7538
+ * @public
7539
+ */
7540
+ export interface TagResourceResponse {
7541
+ }
7542
+ /**
7543
+ * @public
7544
+ */
7545
+ export interface UntagResourceRequest {
7546
+ /**
7547
+ * <p> The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you
7548
+ * want to remove the tags. </p>
7549
+ * @public
7550
+ */
7551
+ ResourceArn: string | undefined;
7552
+ /**
7553
+ * <p>The initial part of a key-value pair that forms a tag being removed from a given resource.
7554
+ * For example, a tag with "Sales" as the key might be added to a resource to indicate its use by
7555
+ * the sales department. Keys must be unique and cannot be duplicated for a particular resource.
7556
+ * </p>
7557
+ * @public
7558
+ */
7559
+ TagKeys: string[] | undefined;
7560
+ }
7561
+ /**
7562
+ * @public
7563
+ */
7564
+ export interface UntagResourceResponse {
7565
+ }
7566
+ /**
7567
+ * @public
7568
+ */
7569
+ export interface UpdateEndpointRequest {
7570
+ /**
7571
+ * <p>The Amazon Resource Number (ARN) of the endpoint being updated.</p>
7572
+ * @public
7573
+ */
7574
+ EndpointArn: string | undefined;
7575
+ /**
7576
+ * <p>The ARN of the new model to use when updating an existing endpoint.</p>
7577
+ * @public
7578
+ */
7579
+ DesiredModelArn?: string | undefined;
7580
+ /**
7581
+ * <p> The desired number of inference units to be used by the model using this endpoint.
7582
+ *
7583
+ * Each inference unit represents of a throughput of 100 characters per second.</p>
7584
+ * @public
7585
+ */
7586
+ DesiredInferenceUnits?: number | undefined;
7587
+ /**
7588
+ * <p>Data access role ARN to use in case the new model is encrypted with a customer CMK.</p>
7589
+ * @public
7590
+ */
7591
+ DesiredDataAccessRoleArn?: string | undefined;
7592
+ /**
7593
+ * <p>The Amazon Resource Number (ARN) of the flywheel</p>
7594
+ * @public
7595
+ */
7596
+ FlywheelArn?: string | undefined;
7597
+ }
7598
+ /**
7599
+ * @public
7600
+ */
7601
+ export interface UpdateEndpointResponse {
7602
+ /**
7603
+ * <p>The Amazon Resource Number (ARN) of the new model.</p>
7604
+ * @public
7605
+ */
7606
+ DesiredModelArn?: string | undefined;
7607
+ }
7608
+ /**
7609
+ * <p>Data security configuration.</p>
7610
+ * @public
7611
+ */
7612
+ export interface UpdateDataSecurityConfig {
7613
+ /**
7614
+ * <p>ID for the KMS key that Amazon Comprehend uses to encrypt
7615
+ * trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
7616
+ * <ul>
7617
+ * <li>
7618
+ * <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
7619
+ * </p>
7620
+ * </li>
7621
+ * <li>
7622
+ * <p>Amazon Resource Name (ARN) of a KMS Key:
7623
+ * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
7624
+ * </p>
7625
+ * </li>
7626
+ * </ul>
7627
+ * @public
7628
+ */
7629
+ ModelKmsKeyId?: string | undefined;
7630
+ /**
7631
+ * <p>ID for the KMS key that Amazon Comprehend uses to encrypt the volume.</p>
7632
+ * @public
7633
+ */
7634
+ VolumeKmsKeyId?: string | undefined;
7635
+ /**
7636
+ * <p> Configuration parameters for an optional private Virtual Private Cloud (VPC) containing
7637
+ * the resources you are using for the job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
7638
+ * VPC</a>. </p>
7639
+ * @public
7640
+ */
7641
+ VpcConfig?: VpcConfig | undefined;
7642
+ }
7643
+ /**
7644
+ * @public
7645
+ */
7646
+ export interface UpdateFlywheelRequest {
7647
+ /**
7648
+ * <p>The Amazon Resource Number (ARN) of the flywheel to update.</p>
7649
+ * @public
7650
+ */
7651
+ FlywheelArn: string | undefined;
7652
+ /**
7653
+ * <p>The Amazon Resource Number (ARN) of the active model version.</p>
7654
+ * @public
7655
+ */
7656
+ ActiveModelArn?: string | undefined;
7657
+ /**
7658
+ * <p>The Amazon Resource Name (ARN) of the IAM role that
7659
+ * grants Amazon Comprehend permission to access the flywheel data.</p>
7660
+ * @public
7661
+ */
7662
+ DataAccessRoleArn?: string | undefined;
7663
+ /**
7664
+ * <p>Flywheel data security configuration.</p>
7665
+ * @public
7666
+ */
7667
+ DataSecurityConfig?: UpdateDataSecurityConfig | undefined;
7668
+ }
7669
+ /**
7670
+ * @public
7671
+ */
7672
+ export interface UpdateFlywheelResponse {
7673
+ /**
7674
+ * <p>The flywheel properties.</p>
7675
+ * @public
7676
+ */
7677
+ FlywheelProperties?: FlywheelProperties | undefined;
7678
+ }