@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
@@ -32,6 +32,44 @@ export interface DescribeSentimentDetectionJobCommandOutput extends DescribeSent
32
32
  * };
33
33
  * const command = new DescribeSentimentDetectionJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeSentimentDetectionJobResponse
36
+ * // SentimentDetectionJobProperties: { // SentimentDetectionJobProperties
37
+ * // JobId: "STRING_VALUE",
38
+ * // JobArn: "STRING_VALUE",
39
+ * // JobName: "STRING_VALUE",
40
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
41
+ * // Message: "STRING_VALUE",
42
+ * // SubmitTime: new Date("TIMESTAMP"),
43
+ * // EndTime: new Date("TIMESTAMP"),
44
+ * // InputDataConfig: { // InputDataConfig
45
+ * // S3Uri: "STRING_VALUE", // required
46
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
47
+ * // DocumentReaderConfig: { // DocumentReaderConfig
48
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
49
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
50
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
51
+ * // "TABLES" || "FORMS",
52
+ * // ],
53
+ * // },
54
+ * // },
55
+ * // OutputDataConfig: { // OutputDataConfig
56
+ * // S3Uri: "STRING_VALUE", // required
57
+ * // KmsKeyId: "STRING_VALUE",
58
+ * // },
59
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
60
+ * // DataAccessRoleArn: "STRING_VALUE",
61
+ * // VolumeKmsKeyId: "STRING_VALUE",
62
+ * // VpcConfig: { // VpcConfig
63
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // Subnets: [ // Subnets // required
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // },
70
+ * // },
71
+ * // };
72
+ *
35
73
  * ```
36
74
  *
37
75
  * @param DescribeSentimentDetectionJobCommandInput - {@link DescribeSentimentDetectionJobCommandInput}
@@ -52,6 +90,8 @@ export interface DescribeSentimentDetectionJobCommandOutput extends DescribeSent
52
90
  * @throws {@link TooManyRequestsException} (client fault)
53
91
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
54
92
  *
93
+ * @throws {@link ComprehendServiceException}
94
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
55
95
  *
56
96
  */
57
97
  export declare class DescribeSentimentDetectionJobCommand extends $Command<DescribeSentimentDetectionJobCommandInput, DescribeSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,44 @@ export interface DescribeTargetedSentimentDetectionJobCommandOutput extends Desc
32
32
  * };
33
33
  * const command = new DescribeTargetedSentimentDetectionJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeTargetedSentimentDetectionJobResponse
36
+ * // TargetedSentimentDetectionJobProperties: { // TargetedSentimentDetectionJobProperties
37
+ * // JobId: "STRING_VALUE",
38
+ * // JobArn: "STRING_VALUE",
39
+ * // JobName: "STRING_VALUE",
40
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
41
+ * // Message: "STRING_VALUE",
42
+ * // SubmitTime: new Date("TIMESTAMP"),
43
+ * // EndTime: new Date("TIMESTAMP"),
44
+ * // InputDataConfig: { // InputDataConfig
45
+ * // S3Uri: "STRING_VALUE", // required
46
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
47
+ * // DocumentReaderConfig: { // DocumentReaderConfig
48
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
49
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
50
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
51
+ * // "TABLES" || "FORMS",
52
+ * // ],
53
+ * // },
54
+ * // },
55
+ * // OutputDataConfig: { // OutputDataConfig
56
+ * // S3Uri: "STRING_VALUE", // required
57
+ * // KmsKeyId: "STRING_VALUE",
58
+ * // },
59
+ * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
60
+ * // DataAccessRoleArn: "STRING_VALUE",
61
+ * // VolumeKmsKeyId: "STRING_VALUE",
62
+ * // VpcConfig: { // VpcConfig
63
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // Subnets: [ // Subnets // required
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // },
70
+ * // },
71
+ * // };
72
+ *
35
73
  * ```
36
74
  *
37
75
  * @param DescribeTargetedSentimentDetectionJobCommandInput - {@link DescribeTargetedSentimentDetectionJobCommandInput}
@@ -52,6 +90,8 @@ export interface DescribeTargetedSentimentDetectionJobCommandOutput extends Desc
52
90
  * @throws {@link TooManyRequestsException} (client fault)
53
91
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
54
92
  *
93
+ * @throws {@link ComprehendServiceException}
94
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
55
95
  *
56
96
  */
57
97
  export declare class DescribeTargetedSentimentDetectionJobCommand extends $Command<DescribeTargetedSentimentDetectionJobCommandInput, DescribeTargetedSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,44 @@ export interface DescribeTopicsDetectionJobCommandOutput extends DescribeTopicsD
32
32
  * };
33
33
  * const command = new DescribeTopicsDetectionJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeTopicsDetectionJobResponse
36
+ * // TopicsDetectionJobProperties: { // TopicsDetectionJobProperties
37
+ * // JobId: "STRING_VALUE",
38
+ * // JobArn: "STRING_VALUE",
39
+ * // JobName: "STRING_VALUE",
40
+ * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
41
+ * // Message: "STRING_VALUE",
42
+ * // SubmitTime: new Date("TIMESTAMP"),
43
+ * // EndTime: new Date("TIMESTAMP"),
44
+ * // InputDataConfig: { // InputDataConfig
45
+ * // S3Uri: "STRING_VALUE", // required
46
+ * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
47
+ * // DocumentReaderConfig: { // DocumentReaderConfig
48
+ * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
49
+ * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
50
+ * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
51
+ * // "TABLES" || "FORMS",
52
+ * // ],
53
+ * // },
54
+ * // },
55
+ * // OutputDataConfig: { // OutputDataConfig
56
+ * // S3Uri: "STRING_VALUE", // required
57
+ * // KmsKeyId: "STRING_VALUE",
58
+ * // },
59
+ * // NumberOfTopics: Number("int"),
60
+ * // DataAccessRoleArn: "STRING_VALUE",
61
+ * // VolumeKmsKeyId: "STRING_VALUE",
62
+ * // VpcConfig: { // VpcConfig
63
+ * // SecurityGroupIds: [ // SecurityGroupIds // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // Subnets: [ // Subnets // required
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // },
70
+ * // },
71
+ * // };
72
+ *
35
73
  * ```
36
74
  *
37
75
  * @param DescribeTopicsDetectionJobCommandInput - {@link DescribeTopicsDetectionJobCommandInput}
@@ -52,6 +90,8 @@ export interface DescribeTopicsDetectionJobCommandOutput extends DescribeTopicsD
52
90
  * @throws {@link TooManyRequestsException} (client fault)
53
91
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
54
92
  *
93
+ * @throws {@link ComprehendServiceException}
94
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
55
95
  *
56
96
  */
57
97
  export declare class DescribeTopicsDetectionJobCommand extends $Command<DescribeTopicsDetectionJobCommandInput, DescribeTopicsDetectionJobCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,15 @@ export interface DetectDominantLanguageCommandOutput extends DetectDominantLangu
32
32
  * };
33
33
  * const command = new DetectDominantLanguageCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DetectDominantLanguageResponse
36
+ * // Languages: [ // ListOfDominantLanguages
37
+ * // { // DominantLanguage
38
+ * // LanguageCode: "STRING_VALUE",
39
+ * // Score: Number("float"),
40
+ * // },
41
+ * // ],
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param DetectDominantLanguageCommandInput - {@link DetectDominantLanguageCommandInput}
@@ -49,6 +58,8 @@ export interface DetectDominantLanguageCommandOutput extends DetectDominantLangu
49
58
  * @throws {@link TextSizeLimitExceededException} (client fault)
50
59
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
51
60
  *
61
+ * @throws {@link ComprehendServiceException}
62
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
52
63
  *
53
64
  */
54
65
  export declare class DetectDominantLanguageCommand extends $Command<DetectDominantLanguageCommandInput, DetectDominantLanguageCommandOutput, ComprehendClientResolvedConfig> {
@@ -56,6 +56,84 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
56
56
  * };
57
57
  * const command = new DetectEntitiesCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // { // DetectEntitiesResponse
60
+ * // Entities: [ // ListOfEntities
61
+ * // { // Entity
62
+ * // Score: Number("float"),
63
+ * // Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "COMMERCIAL_ITEM" || "EVENT" || "DATE" || "QUANTITY" || "TITLE" || "OTHER",
64
+ * // Text: "STRING_VALUE",
65
+ * // BeginOffset: Number("int"),
66
+ * // EndOffset: Number("int"),
67
+ * // BlockReferences: [ // ListOfBlockReferences
68
+ * // { // BlockReference
69
+ * // BlockId: "STRING_VALUE",
70
+ * // BeginOffset: Number("int"),
71
+ * // EndOffset: Number("int"),
72
+ * // ChildBlocks: [ // ListOfChildBlocks
73
+ * // { // ChildBlock
74
+ * // ChildBlockId: "STRING_VALUE",
75
+ * // BeginOffset: Number("int"),
76
+ * // EndOffset: Number("int"),
77
+ * // },
78
+ * // ],
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // ],
83
+ * // DocumentMetadata: { // DocumentMetadata
84
+ * // Pages: Number("int"),
85
+ * // ExtractedCharacters: [ // ListOfExtractedCharacters
86
+ * // { // ExtractedCharactersListItem
87
+ * // Page: Number("int"),
88
+ * // Count: Number("int"),
89
+ * // },
90
+ * // ],
91
+ * // },
92
+ * // DocumentType: [ // ListOfDocumentType
93
+ * // { // DocumentTypeListItem
94
+ * // Page: Number("int"),
95
+ * // Type: "NATIVE_PDF" || "SCANNED_PDF" || "MS_WORD" || "IMAGE" || "PLAIN_TEXT" || "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" || "TEXTRACT_ANALYZE_DOCUMENT_JSON",
96
+ * // },
97
+ * // ],
98
+ * // Blocks: [ // ListOfBlocks
99
+ * // { // Block
100
+ * // Id: "STRING_VALUE",
101
+ * // BlockType: "LINE" || "WORD",
102
+ * // Text: "STRING_VALUE",
103
+ * // Page: Number("int"),
104
+ * // Geometry: { // Geometry
105
+ * // BoundingBox: { // BoundingBox
106
+ * // Height: Number("float"),
107
+ * // Left: Number("float"),
108
+ * // Top: Number("float"),
109
+ * // Width: Number("float"),
110
+ * // },
111
+ * // Polygon: [ // Polygon
112
+ * // { // Point
113
+ * // X: Number("float"),
114
+ * // Y: Number("float"),
115
+ * // },
116
+ * // ],
117
+ * // },
118
+ * // Relationships: [ // ListOfRelationships
119
+ * // { // RelationshipsListItem
120
+ * // Ids: [ // StringList
121
+ * // "STRING_VALUE",
122
+ * // ],
123
+ * // Type: "CHILD",
124
+ * // },
125
+ * // ],
126
+ * // },
127
+ * // ],
128
+ * // Errors: [ // ListOfErrors
129
+ * // { // ErrorsListItem
130
+ * // Page: Number("int"),
131
+ * // ErrorCode: "TEXTRACT_BAD_PAGE" || "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED" || "PAGE_CHARACTERS_EXCEEDED" || "PAGE_SIZE_EXCEEDED" || "INTERNAL_SERVER_ERROR",
132
+ * // ErrorMessage: "STRING_VALUE",
133
+ * // },
134
+ * // ],
135
+ * // };
136
+ *
59
137
  * ```
60
138
  *
61
139
  * @param DetectEntitiesCommandInput - {@link DetectEntitiesCommandInput}
@@ -84,6 +162,8 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
84
162
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
85
163
  * </p>
86
164
  *
165
+ * @throws {@link ComprehendServiceException}
166
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
87
167
  *
88
168
  */
89
169
  export declare class DetectEntitiesCommand extends $Command<DetectEntitiesCommandInput, DetectEntitiesCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
32
32
  * };
33
33
  * const command = new DetectKeyPhrasesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DetectKeyPhrasesResponse
36
+ * // KeyPhrases: [ // ListOfKeyPhrases
37
+ * // { // KeyPhrase
38
+ * // Score: Number("float"),
39
+ * // Text: "STRING_VALUE",
40
+ * // BeginOffset: Number("int"),
41
+ * // EndOffset: Number("int"),
42
+ * // },
43
+ * // ],
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param DetectKeyPhrasesCommandInput - {@link DetectKeyPhrasesCommandInput}
@@ -56,6 +67,8 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
56
67
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
57
68
  * </p>
58
69
  *
70
+ * @throws {@link ComprehendServiceException}
71
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
59
72
  *
60
73
  */
61
74
  export declare class DetectKeyPhrasesCommand extends $Command<DetectKeyPhrasesCommandInput, DetectKeyPhrasesCommandOutput, ComprehendClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
33
33
  * };
34
34
  * const command = new DetectPiiEntitiesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DetectPiiEntitiesResponse
37
+ * // Entities: [ // ListOfPiiEntities
38
+ * // { // PiiEntity
39
+ * // Score: Number("float"),
40
+ * // Type: "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",
41
+ * // BeginOffset: Number("int"),
42
+ * // EndOffset: Number("int"),
43
+ * // },
44
+ * // ],
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param DetectPiiEntitiesCommandInput - {@link DetectPiiEntitiesCommandInput}
@@ -57,6 +68,8 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
57
68
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
58
69
  * </p>
59
70
  *
71
+ * @throws {@link ComprehendServiceException}
72
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
60
73
  *
61
74
  */
62
75
  export declare class DetectPiiEntitiesCommand extends $Command<DetectPiiEntitiesCommandInput, DetectPiiEntitiesCommandOutput, ComprehendClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
33
33
  * };
34
34
  * const command = new DetectSentimentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DetectSentimentResponse
37
+ * // Sentiment: "POSITIVE" || "NEGATIVE" || "NEUTRAL" || "MIXED",
38
+ * // SentimentScore: { // SentimentScore
39
+ * // Positive: Number("float"),
40
+ * // Negative: Number("float"),
41
+ * // Neutral: Number("float"),
42
+ * // Mixed: Number("float"),
43
+ * // },
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param DetectSentimentCommandInput - {@link DetectSentimentCommandInput}
@@ -57,6 +67,8 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
57
67
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
58
68
  * </p>
59
69
  *
70
+ * @throws {@link ComprehendServiceException}
71
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
60
72
  *
61
73
  */
62
74
  export declare class DetectSentimentCommand extends $Command<DetectSentimentCommandInput, DetectSentimentCommandOutput, ComprehendClientResolvedConfig> {
@@ -35,6 +35,21 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
35
35
  * };
36
36
  * const command = new DetectSyntaxCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DetectSyntaxResponse
39
+ * // SyntaxTokens: [ // ListOfSyntaxTokens
40
+ * // { // SyntaxToken
41
+ * // TokenId: Number("int"),
42
+ * // Text: "STRING_VALUE",
43
+ * // BeginOffset: Number("int"),
44
+ * // EndOffset: Number("int"),
45
+ * // PartOfSpeech: { // PartOfSpeechTag
46
+ * // Tag: "ADJ" || "ADP" || "ADV" || "AUX" || "CONJ" || "CCONJ" || "DET" || "INTJ" || "NOUN" || "NUM" || "O" || "PART" || "PRON" || "PROPN" || "PUNCT" || "SCONJ" || "SYM" || "VERB",
47
+ * // Score: Number("float"),
48
+ * // },
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
38
53
  * ```
39
54
  *
40
55
  * @param DetectSyntaxCommandInput - {@link DetectSyntaxCommandInput}
@@ -59,6 +74,8 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
59
74
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
60
75
  * </p>
61
76
  *
77
+ * @throws {@link ComprehendServiceException}
78
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
79
  *
63
80
  */
64
81
  export declare class DetectSyntaxCommand extends $Command<DetectSyntaxCommandInput, DetectSyntaxCommandOutput, ComprehendClientResolvedConfig> {
@@ -33,6 +33,35 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
33
33
  * };
34
34
  * const command = new DetectTargetedSentimentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DetectTargetedSentimentResponse
37
+ * // Entities: [ // ListOfTargetedSentimentEntities
38
+ * // { // TargetedSentimentEntity
39
+ * // DescriptiveMentionIndex: [ // ListOfDescriptiveMentionIndices
40
+ * // Number("int"),
41
+ * // ],
42
+ * // Mentions: [ // ListOfMentions
43
+ * // { // TargetedSentimentMention
44
+ * // Score: Number("float"),
45
+ * // GroupScore: Number("float"),
46
+ * // Text: "STRING_VALUE",
47
+ * // Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "FACILITY" || "BRAND" || "COMMERCIAL_ITEM" || "MOVIE" || "MUSIC" || "BOOK" || "SOFTWARE" || "GAME" || "PERSONAL_TITLE" || "EVENT" || "DATE" || "QUANTITY" || "ATTRIBUTE" || "OTHER",
48
+ * // MentionSentiment: { // MentionSentiment
49
+ * // Sentiment: "POSITIVE" || "NEGATIVE" || "NEUTRAL" || "MIXED",
50
+ * // SentimentScore: { // SentimentScore
51
+ * // Positive: Number("float"),
52
+ * // Negative: Number("float"),
53
+ * // Neutral: Number("float"),
54
+ * // Mixed: Number("float"),
55
+ * // },
56
+ * // },
57
+ * // BeginOffset: Number("int"),
58
+ * // EndOffset: Number("int"),
59
+ * // },
60
+ * // ],
61
+ * // },
62
+ * // ],
63
+ * // };
64
+ *
36
65
  * ```
37
66
  *
38
67
  * @param DetectTargetedSentimentCommandInput - {@link DetectTargetedSentimentCommandInput}
@@ -57,6 +86,8 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
57
86
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
58
87
  * </p>
59
88
  *
89
+ * @throws {@link ComprehendServiceException}
90
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
60
91
  *
61
92
  */
62
93
  export declare class DetectTargetedSentimentCommand extends $Command<DetectTargetedSentimentCommandInput, DetectTargetedSentimentCommandOutput, ComprehendClientResolvedConfig> {
@@ -46,6 +46,10 @@ export interface ImportModelCommandOutput extends ImportModelResponse, __Metadat
46
46
  * };
47
47
  * const command = new ImportModelCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // ImportModelResponse
50
+ * // ModelArn: "STRING_VALUE",
51
+ * // };
52
+ *
49
53
  * ```
50
54
  *
51
55
  * @param ImportModelCommandInput - {@link ImportModelCommandInput}
@@ -87,6 +91,8 @@ export interface ImportModelCommandOutput extends ImportModelResponse, __Metadat
87
91
  * resource). The maximum number of tags includes both existing tags and those included in your
88
92
  * current request. </p>
89
93
  *
94
+ * @throws {@link ComprehendServiceException}
95
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
90
96
  *
91
97
  */
92
98
  export declare class ImportModelCommand extends $Command<ImportModelCommandInput, ImportModelCommandOutput, ComprehendClientResolvedConfig> {
@@ -40,6 +40,24 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
40
40
  * };
41
41
  * const command = new ListDatasetsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ListDatasetsResponse
44
+ * // DatasetPropertiesList: [ // DatasetPropertiesList
45
+ * // { // DatasetProperties
46
+ * // DatasetArn: "STRING_VALUE",
47
+ * // DatasetName: "STRING_VALUE",
48
+ * // DatasetType: "TRAIN" || "TEST",
49
+ * // DatasetS3Uri: "STRING_VALUE",
50
+ * // Description: "STRING_VALUE",
51
+ * // Status: "CREATING" || "COMPLETED" || "FAILED",
52
+ * // Message: "STRING_VALUE",
53
+ * // NumberOfDocuments: Number("long"),
54
+ * // CreationTime: new Date("TIMESTAMP"),
55
+ * // EndTime: new Date("TIMESTAMP"),
56
+ * // },
57
+ * // ],
58
+ * // NextToken: "STRING_VALUE",
59
+ * // };
60
+ *
43
61
  * ```
44
62
  *
45
63
  * @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
@@ -64,6 +82,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
64
82
  * @throws {@link TooManyRequestsException} (client fault)
65
83
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
66
84
  *
85
+ * @throws {@link ComprehendServiceException}
86
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
67
87
  *
68
88
  */
69
89
  export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, ComprehendClientResolvedConfig> {
@@ -38,6 +38,48 @@ export interface ListDocumentClassificationJobsCommandOutput extends ListDocumen
38
38
  * };
39
39
  * const command = new ListDocumentClassificationJobsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListDocumentClassificationJobsResponse
42
+ * // DocumentClassificationJobPropertiesList: [ // DocumentClassificationJobPropertiesList
43
+ * // { // DocumentClassificationJobProperties
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
+ * // DocumentClassifierArn: "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
+ * // 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
+ * // FlywheelArn: "STRING_VALUE",
78
+ * // },
79
+ * // ],
80
+ * // NextToken: "STRING_VALUE",
81
+ * // };
82
+ *
41
83
  * ```
42
84
  *
43
85
  * @param ListDocumentClassificationJobsCommandInput - {@link ListDocumentClassificationJobsCommandInput}
@@ -59,6 +101,8 @@ export interface ListDocumentClassificationJobsCommandOutput extends ListDocumen
59
101
  * @throws {@link TooManyRequestsException} (client fault)
60
102
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
61
103
  *
104
+ * @throws {@link ComprehendServiceException}
105
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
62
106
  *
63
107
  */
64
108
  export declare class ListDocumentClassificationJobsCommand extends $Command<ListDocumentClassificationJobsCommandInput, ListDocumentClassificationJobsCommandOutput, ComprehendClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface ListDocumentClassifierSummariesCommandOutput extends ListDocume
32
32
  * };
33
33
  * const command = new ListDocumentClassifierSummariesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListDocumentClassifierSummariesResponse
36
+ * // DocumentClassifierSummariesList: [ // DocumentClassifierSummariesList
37
+ * // { // DocumentClassifierSummary
38
+ * // DocumentClassifierName: "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 ListDocumentClassifierSummariesCommandInput - {@link ListDocumentClassifierSummariesCommandInput}
@@ -49,6 +62,8 @@ export interface ListDocumentClassifierSummariesCommandOutput extends ListDocume
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 ListDocumentClassifierSummariesCommand extends $Command<ListDocumentClassifierSummariesCommandInput, ListDocumentClassifierSummariesCommandOutput, ComprehendClientResolvedConfig> {