@aws-sdk/client-comprehend 3.321.1 → 3.326.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 (85) hide show
  1. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +23 -0
  2. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +40 -0
  3. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +25 -0
  4. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +24 -0
  5. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +29 -0
  6. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +43 -0
  7. package/dist-types/commands/ClassifyDocumentCommand.d.ts +48 -0
  8. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +11 -0
  9. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateEndpointCommand.d.ts +7 -0
  12. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateFlywheelCommand.d.ts +7 -0
  14. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteEndpointCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteFlywheelCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  19. package/dist-types/commands/DescribeDatasetCommand.d.ts +17 -0
  20. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +41 -0
  21. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +80 -0
  22. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +39 -0
  23. package/dist-types/commands/DescribeEndpointCommand.d.ts +19 -0
  24. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +42 -0
  25. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +84 -0
  26. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +34 -0
  27. package/dist-types/commands/DescribeFlywheelCommand.d.ts +46 -0
  28. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +28 -0
  29. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +40 -0
  30. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +39 -0
  31. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +9 -0
  32. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +40 -0
  33. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +40 -0
  34. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +40 -0
  35. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +11 -0
  36. package/dist-types/commands/DetectEntitiesCommand.d.ts +80 -0
  37. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +13 -0
  38. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +13 -0
  39. package/dist-types/commands/DetectSentimentCommand.d.ts +12 -0
  40. package/dist-types/commands/DetectSyntaxCommand.d.ts +17 -0
  41. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +31 -0
  42. package/dist-types/commands/ImportModelCommand.d.ts +6 -0
  43. package/dist-types/commands/ListDatasetsCommand.d.ts +20 -0
  44. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +44 -0
  45. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +15 -0
  46. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +83 -0
  47. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +42 -0
  48. package/dist-types/commands/ListEndpointsCommand.d.ts +22 -0
  49. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +45 -0
  50. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +15 -0
  51. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +87 -0
  52. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +37 -0
  53. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +31 -0
  54. package/dist-types/commands/ListFlywheelsCommand.d.ts +19 -0
  55. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +43 -0
  56. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +42 -0
  57. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +43 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
  59. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +43 -0
  60. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +43 -0
  61. package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -0
  62. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +9 -0
  63. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +8 -0
  64. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +9 -0
  65. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +8 -0
  66. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +7 -0
  67. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +8 -0
  68. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +8 -0
  69. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +8 -0
  70. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +8 -0
  71. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +8 -0
  72. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +7 -0
  73. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +7 -0
  74. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +7 -0
  75. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +7 -0
  76. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +7 -0
  77. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +7 -0
  78. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +7 -0
  79. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +4 -0
  80. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +4 -0
  81. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  82. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  83. package/dist-types/commands/UpdateEndpointCommand.d.ts +6 -0
  84. package/dist-types/commands/UpdateFlywheelCommand.d.ts +46 -0
  85. package/package.json +16 -16
@@ -38,6 +38,87 @@ export interface ListDocumentClassifiersCommandOutput extends ListDocumentClassi
38
38
  * };
39
39
  * const command = new ListDocumentClassifiersCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListDocumentClassifiersResponse
42
+ * // DocumentClassifierPropertiesList: [ // DocumentClassifierPropertiesList
43
+ * // { // DocumentClassifierProperties
44
+ * // DocumentClassifierArn: "STRING_VALUE",
45
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
46
+ * // Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
47
+ * // Message: "STRING_VALUE",
48
+ * // SubmitTime: new Date("TIMESTAMP"),
49
+ * // EndTime: new Date("TIMESTAMP"),
50
+ * // TrainingStartTime: new Date("TIMESTAMP"),
51
+ * // TrainingEndTime: new Date("TIMESTAMP"),
52
+ * // InputDataConfig: { // DocumentClassifierInputDataConfig
53
+ * // DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
54
+ * // S3Uri: "STRING_VALUE",
55
+ * // TestS3Uri: "STRING_VALUE",
56
+ * // LabelDelimiter: "STRING_VALUE",
57
+ * // AugmentedManifests: [ // DocumentClassifierAugmentedManifestsList
58
+ * // { // AugmentedManifestsListItem
59
+ * // S3Uri: "STRING_VALUE", // required
60
+ * // Split: "TRAIN" || "TEST",
61
+ * // AttributeNames: [ // AttributeNamesList // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // AnnotationDataS3Uri: "STRING_VALUE",
65
+ * // SourceDocumentsS3Uri: "STRING_VALUE",
66
+ * // DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
67
+ * // },
68
+ * // ],
69
+ * // DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
70
+ * // Documents: { // DocumentClassifierDocuments
71
+ * // S3Uri: "STRING_VALUE", // required
72
+ * // TestS3Uri: "STRING_VALUE",
73
+ * // },
74
+ * // DocumentReaderConfig: { // DocumentReaderConfig
75
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
76
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
77
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
78
+ * // "TABLES" || "FORMS",
79
+ * // ],
80
+ * // },
81
+ * // },
82
+ * // OutputDataConfig: { // DocumentClassifierOutputDataConfig
83
+ * // S3Uri: "STRING_VALUE",
84
+ * // KmsKeyId: "STRING_VALUE",
85
+ * // FlywheelStatsS3Prefix: "STRING_VALUE",
86
+ * // },
87
+ * // ClassifierMetadata: { // ClassifierMetadata
88
+ * // NumberOfLabels: Number("int"),
89
+ * // NumberOfTrainedDocuments: Number("int"),
90
+ * // NumberOfTestDocuments: Number("int"),
91
+ * // EvaluationMetrics: { // ClassifierEvaluationMetrics
92
+ * // Accuracy: Number("double"),
93
+ * // Precision: Number("double"),
94
+ * // Recall: Number("double"),
95
+ * // F1Score: Number("double"),
96
+ * // MicroPrecision: Number("double"),
97
+ * // MicroRecall: Number("double"),
98
+ * // MicroF1Score: Number("double"),
99
+ * // HammingLoss: Number("double"),
100
+ * // },
101
+ * // },
102
+ * // DataAccessRoleArn: "STRING_VALUE",
103
+ * // VolumeKmsKeyId: "STRING_VALUE",
104
+ * // VpcConfig: { // VpcConfig
105
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
106
+ * // "STRING_VALUE",
107
+ * // ],
108
+ * // Subnets: [ // Subnets // required
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // },
112
+ * // Mode: "MULTI_CLASS" || "MULTI_LABEL",
113
+ * // ModelKmsKeyId: "STRING_VALUE",
114
+ * // VersionName: "STRING_VALUE",
115
+ * // SourceModelArn: "STRING_VALUE",
116
+ * // FlywheelArn: "STRING_VALUE",
117
+ * // },
118
+ * // ],
119
+ * // NextToken: "STRING_VALUE",
120
+ * // };
121
+ *
41
122
  * ```
42
123
  *
43
124
  * @param ListDocumentClassifiersCommandInput - {@link ListDocumentClassifiersCommandInput}
@@ -59,6 +140,8 @@ export interface ListDocumentClassifiersCommandOutput extends ListDocumentClassi
59
140
  * @throws {@link TooManyRequestsException} (client fault)
60
141
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
142
  *
143
+ * @throws {@link ComprehendServiceException}
144
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
145
  *
63
146
  */
64
147
  export declare class ListDocumentClassifiersCommand extends $Command<ListDocumentClassifiersCommandInput, ListDocumentClassifiersCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,46 @@ export interface ListDominantLanguageDetectionJobsCommandOutput extends ListDomi
38
38
  * };
39
39
  * const command = new ListDominantLanguageDetectionJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListDominantLanguageDetectionJobsResponse
42
+ * // DominantLanguageDetectionJobPropertiesList: [ // DominantLanguageDetectionJobPropertiesList
43
+ * // { // DominantLanguageDetectionJobProperties
44
+ * // JobId: "STRING_VALUE",
45
+ * // JobArn: "STRING_VALUE",
46
+ * // JobName: "STRING_VALUE",
47
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
48
+ * // Message: "STRING_VALUE",
49
+ * // SubmitTime: new Date("TIMESTAMP"),
50
+ * // EndTime: new Date("TIMESTAMP"),
51
+ * // InputDataConfig: { // InputDataConfig
52
+ * // S3Uri: "STRING_VALUE", // required
53
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
54
+ * // DocumentReaderConfig: { // DocumentReaderConfig
55
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
56
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
57
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
58
+ * // "TABLES" || "FORMS",
59
+ * // ],
60
+ * // },
61
+ * // },
62
+ * // OutputDataConfig: { // OutputDataConfig
63
+ * // S3Uri: "STRING_VALUE", // required
64
+ * // KmsKeyId: "STRING_VALUE",
65
+ * // },
66
+ * // DataAccessRoleArn: "STRING_VALUE",
67
+ * // VolumeKmsKeyId: "STRING_VALUE",
68
+ * // VpcConfig: { // VpcConfig
69
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // Subnets: [ // Subnets // required
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // },
76
+ * // },
77
+ * // ],
78
+ * // NextToken: "STRING_VALUE",
79
+ * // };
80
+ *
41
81
  * ```
42
82
  *
43
83
  * @param ListDominantLanguageDetectionJobsCommandInput - {@link ListDominantLanguageDetectionJobsCommandInput}
@@ -59,6 +99,8 @@ export interface ListDominantLanguageDetectionJobsCommandOutput extends ListDomi
59
99
  * @throws {@link TooManyRequestsException} (client fault)
60
100
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
101
  *
102
+ * @throws {@link ComprehendServiceException}
103
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
104
  *
63
105
  */
64
106
  export declare class ListDominantLanguageDetectionJobsCommand extends $Command<ListDominantLanguageDetectionJobsCommandInput, ListDominantLanguageDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {
@@ -39,6 +39,26 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __Met
39
39
  * };
40
40
  * const command = new ListEndpointsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListEndpointsResponse
43
+ * // EndpointPropertiesList: [ // EndpointPropertiesList
44
+ * // { // EndpointProperties
45
+ * // EndpointArn: "STRING_VALUE",
46
+ * // Status: "CREATING" || "DELETING" || "FAILED" || "IN_SERVICE" || "UPDATING",
47
+ * // Message: "STRING_VALUE",
48
+ * // ModelArn: "STRING_VALUE",
49
+ * // DesiredModelArn: "STRING_VALUE",
50
+ * // DesiredInferenceUnits: Number("int"),
51
+ * // CurrentInferenceUnits: Number("int"),
52
+ * // CreationTime: new Date("TIMESTAMP"),
53
+ * // LastModifiedTime: new Date("TIMESTAMP"),
54
+ * // DataAccessRoleArn: "STRING_VALUE",
55
+ * // DesiredDataAccessRoleArn: "STRING_VALUE",
56
+ * // FlywheelArn: "STRING_VALUE",
57
+ * // },
58
+ * // ],
59
+ * // NextToken: "STRING_VALUE",
60
+ * // };
61
+ *
42
62
  * ```
43
63
  *
44
64
  * @param ListEndpointsCommandInput - {@link ListEndpointsCommandInput}
@@ -56,6 +76,8 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __Met
56
76
  * @throws {@link TooManyRequestsException} (client fault)
57
77
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
58
78
  *
79
+ * @throws {@link ComprehendServiceException}
80
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
59
81
  *
60
82
  */
61
83
  export declare class ListEndpointsCommand extends $Command<ListEndpointsCommandInput, ListEndpointsCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,49 @@ export interface ListEntitiesDetectionJobsCommandOutput extends ListEntitiesDete
38
38
  * };
39
39
  * const command = new ListEntitiesDetectionJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListEntitiesDetectionJobsResponse
42
+ * // EntitiesDetectionJobPropertiesList: [ // EntitiesDetectionJobPropertiesList
43
+ * // { // EntitiesDetectionJobProperties
44
+ * // JobId: "STRING_VALUE",
45
+ * // JobArn: "STRING_VALUE",
46
+ * // JobName: "STRING_VALUE",
47
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
48
+ * // Message: "STRING_VALUE",
49
+ * // SubmitTime: new Date("TIMESTAMP"),
50
+ * // EndTime: new Date("TIMESTAMP"),
51
+ * // EntityRecognizerArn: "STRING_VALUE",
52
+ * // InputDataConfig: { // InputDataConfig
53
+ * // S3Uri: "STRING_VALUE", // required
54
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
55
+ * // DocumentReaderConfig: { // DocumentReaderConfig
56
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
57
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
58
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
59
+ * // "TABLES" || "FORMS",
60
+ * // ],
61
+ * // },
62
+ * // },
63
+ * // OutputDataConfig: { // OutputDataConfig
64
+ * // S3Uri: "STRING_VALUE", // required
65
+ * // KmsKeyId: "STRING_VALUE",
66
+ * // },
67
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
68
+ * // DataAccessRoleArn: "STRING_VALUE",
69
+ * // VolumeKmsKeyId: "STRING_VALUE",
70
+ * // VpcConfig: { // VpcConfig
71
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
72
+ * // "STRING_VALUE",
73
+ * // ],
74
+ * // Subnets: [ // Subnets // required
75
+ * // "STRING_VALUE",
76
+ * // ],
77
+ * // },
78
+ * // FlywheelArn: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // NextToken: "STRING_VALUE",
82
+ * // };
83
+ *
41
84
  * ```
42
85
  *
43
86
  * @param ListEntitiesDetectionJobsCommandInput - {@link ListEntitiesDetectionJobsCommandInput}
@@ -59,6 +102,8 @@ export interface ListEntitiesDetectionJobsCommandOutput extends ListEntitiesDete
59
102
  * @throws {@link TooManyRequestsException} (client fault)
60
103
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
104
  *
105
+ * @throws {@link ComprehendServiceException}
106
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
107
  *
63
108
  */
64
109
  export declare class ListEntitiesDetectionJobsCommand extends $Command<ListEntitiesDetectionJobsCommandInput, ListEntitiesDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface ListEntityRecognizerSummariesCommandOutput extends ListEntityRe
32
32
  * };
33
33
  * const command = new ListEntityRecognizerSummariesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListEntityRecognizerSummariesResponse
36
+ * // EntityRecognizerSummariesList: [ // EntityRecognizerSummariesList
37
+ * // { // EntityRecognizerSummary
38
+ * // RecognizerName: "STRING_VALUE",
39
+ * // NumberOfVersions: Number("int"),
40
+ * // LatestVersionCreatedAt: new Date("TIMESTAMP"),
41
+ * // LatestVersionName: "STRING_VALUE",
42
+ * // LatestVersionStatus: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
35
48
  * ```
36
49
  *
37
50
  * @param ListEntityRecognizerSummariesCommandInput - {@link ListEntityRecognizerSummariesCommandInput}
@@ -49,6 +62,8 @@ export interface ListEntityRecognizerSummariesCommandOutput extends ListEntityRe
49
62
  * @throws {@link TooManyRequestsException} (client fault)
50
63
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
51
64
  *
65
+ * @throws {@link ComprehendServiceException}
66
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
52
67
  *
53
68
  */
54
69
  export declare class ListEntityRecognizerSummariesCommand extends $Command<ListEntityRecognizerSummariesCommandInput, ListEntityRecognizerSummariesCommandOutput, ComprehendClientResolvedConfig> {
@@ -43,6 +43,91 @@ export interface ListEntityRecognizersCommandOutput extends ListEntityRecognizer
43
43
  * };
44
44
  * const command = new ListEntityRecognizersCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListEntityRecognizersResponse
47
+ * // EntityRecognizerPropertiesList: [ // EntityRecognizerPropertiesList
48
+ * // { // EntityRecognizerProperties
49
+ * // EntityRecognizerArn: "STRING_VALUE",
50
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
51
+ * // Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
52
+ * // Message: "STRING_VALUE",
53
+ * // SubmitTime: new Date("TIMESTAMP"),
54
+ * // EndTime: new Date("TIMESTAMP"),
55
+ * // TrainingStartTime: new Date("TIMESTAMP"),
56
+ * // TrainingEndTime: new Date("TIMESTAMP"),
57
+ * // InputDataConfig: { // EntityRecognizerInputDataConfig
58
+ * // DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
59
+ * // EntityTypes: [ // EntityTypesList // required
60
+ * // { // EntityTypesListItem
61
+ * // Type: "STRING_VALUE", // required
62
+ * // },
63
+ * // ],
64
+ * // Documents: { // EntityRecognizerDocuments
65
+ * // S3Uri: "STRING_VALUE", // required
66
+ * // TestS3Uri: "STRING_VALUE",
67
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
68
+ * // },
69
+ * // Annotations: { // EntityRecognizerAnnotations
70
+ * // S3Uri: "STRING_VALUE", // required
71
+ * // TestS3Uri: "STRING_VALUE",
72
+ * // },
73
+ * // EntityList: { // EntityRecognizerEntityList
74
+ * // S3Uri: "STRING_VALUE", // required
75
+ * // },
76
+ * // AugmentedManifests: [ // EntityRecognizerAugmentedManifestsList
77
+ * // { // AugmentedManifestsListItem
78
+ * // S3Uri: "STRING_VALUE", // required
79
+ * // Split: "TRAIN" || "TEST",
80
+ * // AttributeNames: [ // AttributeNamesList // required
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // AnnotationDataS3Uri: "STRING_VALUE",
84
+ * // SourceDocumentsS3Uri: "STRING_VALUE",
85
+ * // DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
86
+ * // },
87
+ * // ],
88
+ * // },
89
+ * // RecognizerMetadata: { // EntityRecognizerMetadata
90
+ * // NumberOfTrainedDocuments: Number("int"),
91
+ * // NumberOfTestDocuments: Number("int"),
92
+ * // EvaluationMetrics: { // EntityRecognizerEvaluationMetrics
93
+ * // Precision: Number("double"),
94
+ * // Recall: Number("double"),
95
+ * // F1Score: Number("double"),
96
+ * // },
97
+ * // EntityTypes: [ // EntityRecognizerMetadataEntityTypesList
98
+ * // { // EntityRecognizerMetadataEntityTypesListItem
99
+ * // Type: "STRING_VALUE",
100
+ * // EvaluationMetrics: { // EntityTypesEvaluationMetrics
101
+ * // Precision: Number("double"),
102
+ * // Recall: Number("double"),
103
+ * // F1Score: Number("double"),
104
+ * // },
105
+ * // NumberOfTrainMentions: Number("int"),
106
+ * // },
107
+ * // ],
108
+ * // },
109
+ * // DataAccessRoleArn: "STRING_VALUE",
110
+ * // VolumeKmsKeyId: "STRING_VALUE",
111
+ * // VpcConfig: { // VpcConfig
112
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
113
+ * // "STRING_VALUE",
114
+ * // ],
115
+ * // Subnets: [ // Subnets // required
116
+ * // "STRING_VALUE",
117
+ * // ],
118
+ * // },
119
+ * // ModelKmsKeyId: "STRING_VALUE",
120
+ * // VersionName: "STRING_VALUE",
121
+ * // SourceModelArn: "STRING_VALUE",
122
+ * // FlywheelArn: "STRING_VALUE",
123
+ * // OutputDataConfig: { // EntityRecognizerOutputDataConfig
124
+ * // FlywheelStatsS3Prefix: "STRING_VALUE",
125
+ * // },
126
+ * // },
127
+ * // ],
128
+ * // NextToken: "STRING_VALUE",
129
+ * // };
130
+ *
46
131
  * ```
47
132
  *
48
133
  * @param ListEntityRecognizersCommandInput - {@link ListEntityRecognizersCommandInput}
@@ -64,6 +149,8 @@ export interface ListEntityRecognizersCommandOutput extends ListEntityRecognizer
64
149
  * @throws {@link TooManyRequestsException} (client fault)
65
150
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
66
151
  *
152
+ * @throws {@link ComprehendServiceException}
153
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
67
154
  *
68
155
  */
69
156
  export declare class ListEntityRecognizersCommand extends $Command<ListEntityRecognizersCommandInput, ListEntityRecognizersCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,41 @@ export interface ListEventsDetectionJobsCommandOutput extends ListEventsDetectio
38
38
  * };
39
39
  * const command = new ListEventsDetectionJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListEventsDetectionJobsResponse
42
+ * // EventsDetectionJobPropertiesList: [ // EventsDetectionJobPropertiesList
43
+ * // { // EventsDetectionJobProperties
44
+ * // JobId: "STRING_VALUE",
45
+ * // JobArn: "STRING_VALUE",
46
+ * // JobName: "STRING_VALUE",
47
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
48
+ * // Message: "STRING_VALUE",
49
+ * // SubmitTime: new Date("TIMESTAMP"),
50
+ * // EndTime: new Date("TIMESTAMP"),
51
+ * // InputDataConfig: { // InputDataConfig
52
+ * // S3Uri: "STRING_VALUE", // required
53
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
54
+ * // DocumentReaderConfig: { // DocumentReaderConfig
55
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
56
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
57
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
58
+ * // "TABLES" || "FORMS",
59
+ * // ],
60
+ * // },
61
+ * // },
62
+ * // OutputDataConfig: { // OutputDataConfig
63
+ * // S3Uri: "STRING_VALUE", // required
64
+ * // KmsKeyId: "STRING_VALUE",
65
+ * // },
66
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
67
+ * // DataAccessRoleArn: "STRING_VALUE",
68
+ * // TargetEventTypes: [ // TargetEventTypes
69
+ * // "STRING_VALUE",
70
+ * // ],
71
+ * // },
72
+ * // ],
73
+ * // NextToken: "STRING_VALUE",
74
+ * // };
75
+ *
41
76
  * ```
42
77
  *
43
78
  * @param ListEventsDetectionJobsCommandInput - {@link ListEventsDetectionJobsCommandInput}
@@ -59,6 +94,8 @@ export interface ListEventsDetectionJobsCommandOutput extends ListEventsDetectio
59
94
  * @throws {@link TooManyRequestsException} (client fault)
60
95
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
96
  *
97
+ * @throws {@link ComprehendServiceException}
98
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
99
  *
63
100
  */
64
101
  export declare class ListEventsDetectionJobsCommand extends $Command<ListEventsDetectionJobsCommandInput, ListEventsDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {
@@ -39,6 +39,35 @@ export interface ListFlywheelIterationHistoryCommandOutput extends ListFlywheelI
39
39
  * };
40
40
  * const command = new ListFlywheelIterationHistoryCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListFlywheelIterationHistoryResponse
43
+ * // FlywheelIterationPropertiesList: [ // FlywheelIterationPropertiesList
44
+ * // { // FlywheelIterationProperties
45
+ * // FlywheelArn: "STRING_VALUE",
46
+ * // FlywheelIterationId: "STRING_VALUE",
47
+ * // CreationTime: new Date("TIMESTAMP"),
48
+ * // EndTime: new Date("TIMESTAMP"),
49
+ * // Status: "TRAINING" || "EVALUATING" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
50
+ * // Message: "STRING_VALUE",
51
+ * // EvaluatedModelArn: "STRING_VALUE",
52
+ * // EvaluatedModelMetrics: { // FlywheelModelEvaluationMetrics
53
+ * // AverageF1Score: Number("double"),
54
+ * // AveragePrecision: Number("double"),
55
+ * // AverageRecall: Number("double"),
56
+ * // AverageAccuracy: Number("double"),
57
+ * // },
58
+ * // TrainedModelArn: "STRING_VALUE",
59
+ * // TrainedModelMetrics: {
60
+ * // AverageF1Score: Number("double"),
61
+ * // AveragePrecision: Number("double"),
62
+ * // AverageRecall: Number("double"),
63
+ * // AverageAccuracy: Number("double"),
64
+ * // },
65
+ * // EvaluationManifestS3Prefix: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // NextToken: "STRING_VALUE",
69
+ * // };
70
+ *
42
71
  * ```
43
72
  *
44
73
  * @param ListFlywheelIterationHistoryCommandInput - {@link ListFlywheelIterationHistoryCommandInput}
@@ -63,6 +92,8 @@ export interface ListFlywheelIterationHistoryCommandOutput extends ListFlywheelI
63
92
  * @throws {@link TooManyRequestsException} (client fault)
64
93
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
65
94
  *
95
+ * @throws {@link ComprehendServiceException}
96
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
66
97
  *
67
98
  */
68
99
  export declare class ListFlywheelIterationHistoryCommand extends $Command<ListFlywheelIterationHistoryCommandInput, ListFlywheelIterationHistoryCommandOutput, ComprehendClientResolvedConfig> {
@@ -37,6 +37,23 @@ export interface ListFlywheelsCommandOutput extends ListFlywheelsResponse, __Met
37
37
  * };
38
38
  * const command = new ListFlywheelsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListFlywheelsResponse
41
+ * // FlywheelSummaryList: [ // FlywheelSummaryList
42
+ * // { // FlywheelSummary
43
+ * // FlywheelArn: "STRING_VALUE",
44
+ * // ActiveModelArn: "STRING_VALUE",
45
+ * // DataLakeS3Uri: "STRING_VALUE",
46
+ * // Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
47
+ * // ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER",
48
+ * // Message: "STRING_VALUE",
49
+ * // CreationTime: new Date("TIMESTAMP"),
50
+ * // LastModifiedTime: new Date("TIMESTAMP"),
51
+ * // LatestFlywheelIteration: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
40
57
  * ```
41
58
  *
42
59
  * @param ListFlywheelsCommandInput - {@link ListFlywheelsCommandInput}
@@ -58,6 +75,8 @@ export interface ListFlywheelsCommandOutput extends ListFlywheelsResponse, __Met
58
75
  * @throws {@link TooManyRequestsException} (client fault)
59
76
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
60
77
  *
78
+ * @throws {@link ComprehendServiceException}
79
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
61
80
  *
62
81
  */
63
82
  export declare class ListFlywheelsCommand extends $Command<ListFlywheelsCommandInput, ListFlywheelsCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,47 @@ export interface ListKeyPhrasesDetectionJobsCommandOutput extends ListKeyPhrases
38
38
  * };
39
39
  * const command = new ListKeyPhrasesDetectionJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListKeyPhrasesDetectionJobsResponse
42
+ * // KeyPhrasesDetectionJobPropertiesList: [ // KeyPhrasesDetectionJobPropertiesList
43
+ * // { // KeyPhrasesDetectionJobProperties
44
+ * // JobId: "STRING_VALUE",
45
+ * // JobArn: "STRING_VALUE",
46
+ * // JobName: "STRING_VALUE",
47
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
48
+ * // Message: "STRING_VALUE",
49
+ * // SubmitTime: new Date("TIMESTAMP"),
50
+ * // EndTime: new Date("TIMESTAMP"),
51
+ * // InputDataConfig: { // InputDataConfig
52
+ * // S3Uri: "STRING_VALUE", // required
53
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
54
+ * // DocumentReaderConfig: { // DocumentReaderConfig
55
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
56
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
57
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
58
+ * // "TABLES" || "FORMS",
59
+ * // ],
60
+ * // },
61
+ * // },
62
+ * // OutputDataConfig: { // OutputDataConfig
63
+ * // S3Uri: "STRING_VALUE", // required
64
+ * // KmsKeyId: "STRING_VALUE",
65
+ * // },
66
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
67
+ * // DataAccessRoleArn: "STRING_VALUE",
68
+ * // VolumeKmsKeyId: "STRING_VALUE",
69
+ * // VpcConfig: { // VpcConfig
70
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // Subnets: [ // Subnets // required
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // },
77
+ * // },
78
+ * // ],
79
+ * // NextToken: "STRING_VALUE",
80
+ * // };
81
+ *
41
82
  * ```
42
83
  *
43
84
  * @param ListKeyPhrasesDetectionJobsCommandInput - {@link ListKeyPhrasesDetectionJobsCommandInput}
@@ -59,6 +100,8 @@ export interface ListKeyPhrasesDetectionJobsCommandOutput extends ListKeyPhrases
59
100
  * @throws {@link TooManyRequestsException} (client fault)
60
101
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
102
  *
103
+ * @throws {@link ComprehendServiceException}
104
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
105
  *
63
106
  */
64
107
  export declare class ListKeyPhrasesDetectionJobsCommand extends $Command<ListKeyPhrasesDetectionJobsCommandInput, ListKeyPhrasesDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,46 @@ export interface ListPiiEntitiesDetectionJobsCommandOutput extends ListPiiEntiti
38
38
  * };
39
39
  * const command = new ListPiiEntitiesDetectionJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListPiiEntitiesDetectionJobsResponse
42
+ * // PiiEntitiesDetectionJobPropertiesList: [ // PiiEntitiesDetectionJobPropertiesList
43
+ * // { // PiiEntitiesDetectionJobProperties
44
+ * // JobId: "STRING_VALUE",
45
+ * // JobArn: "STRING_VALUE",
46
+ * // JobName: "STRING_VALUE",
47
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
48
+ * // Message: "STRING_VALUE",
49
+ * // SubmitTime: new Date("TIMESTAMP"),
50
+ * // EndTime: new Date("TIMESTAMP"),
51
+ * // InputDataConfig: { // InputDataConfig
52
+ * // S3Uri: "STRING_VALUE", // required
53
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
54
+ * // DocumentReaderConfig: { // DocumentReaderConfig
55
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
56
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
57
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
58
+ * // "TABLES" || "FORMS",
59
+ * // ],
60
+ * // },
61
+ * // },
62
+ * // OutputDataConfig: { // PiiOutputDataConfig
63
+ * // S3Uri: "STRING_VALUE", // required
64
+ * // KmsKeyId: "STRING_VALUE",
65
+ * // },
66
+ * // RedactionConfig: { // RedactionConfig
67
+ * // PiiEntityTypes: [ // ListOfPiiEntityTypes
68
+ * // "BANK_ACCOUNT_NUMBER" || "BANK_ROUTING" || "CREDIT_DEBIT_NUMBER" || "CREDIT_DEBIT_CVV" || "CREDIT_DEBIT_EXPIRY" || "PIN" || "EMAIL" || "ADDRESS" || "NAME" || "PHONE" || "SSN" || "DATE_TIME" || "PASSPORT_NUMBER" || "DRIVER_ID" || "URL" || "AGE" || "USERNAME" || "PASSWORD" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "IP_ADDRESS" || "MAC_ADDRESS" || "ALL" || "LICENSE_PLATE" || "VEHICLE_IDENTIFICATION_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "IN_PERMANENT_ACCOUNT_NUMBER" || "IN_NREGA" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "CA_HEALTH_NUMBER" || "IN_AADHAAR" || "IN_VOTER_NUMBER",
69
+ * // ],
70
+ * // MaskMode: "MASK" || "REPLACE_WITH_PII_ENTITY_TYPE",
71
+ * // MaskCharacter: "STRING_VALUE",
72
+ * // },
73
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
74
+ * // DataAccessRoleArn: "STRING_VALUE",
75
+ * // Mode: "ONLY_REDACTION" || "ONLY_OFFSETS",
76
+ * // },
77
+ * // ],
78
+ * // NextToken: "STRING_VALUE",
79
+ * // };
80
+ *
41
81
  * ```
42
82
  *
43
83
  * @param ListPiiEntitiesDetectionJobsCommandInput - {@link ListPiiEntitiesDetectionJobsCommandInput}
@@ -59,6 +99,8 @@ export interface ListPiiEntitiesDetectionJobsCommandOutput extends ListPiiEntiti
59
99
  * @throws {@link TooManyRequestsException} (client fault)
60
100
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
101
  *
102
+ * @throws {@link ComprehendServiceException}
103
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
104
  *
63
105
  */
64
106
  export declare class ListPiiEntitiesDetectionJobsCommand extends $Command<ListPiiEntitiesDetectionJobsCommandInput, ListPiiEntitiesDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {