@aws-sdk/client-comprehend 3.325.0 → 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.
- package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +23 -0
- package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +40 -0
- package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +25 -0
- package/dist-types/commands/BatchDetectSentimentCommand.d.ts +24 -0
- package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +29 -0
- package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +43 -0
- package/dist-types/commands/ClassifyDocumentCommand.d.ts +48 -0
- package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +11 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
- package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +6 -0
- package/dist-types/commands/CreateEndpointCommand.d.ts +7 -0
- package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +6 -0
- package/dist-types/commands/CreateFlywheelCommand.d.ts +7 -0
- package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEndpointCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFlywheelCommand.d.ts +4 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +17 -0
- package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +41 -0
- package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +80 -0
- package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +39 -0
- package/dist-types/commands/DescribeEndpointCommand.d.ts +19 -0
- package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +42 -0
- package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +84 -0
- package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +34 -0
- package/dist-types/commands/DescribeFlywheelCommand.d.ts +46 -0
- package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +28 -0
- package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +40 -0
- package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +39 -0
- package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +9 -0
- package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +40 -0
- package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +40 -0
- package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +40 -0
- package/dist-types/commands/DetectDominantLanguageCommand.d.ts +11 -0
- package/dist-types/commands/DetectEntitiesCommand.d.ts +80 -0
- package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +13 -0
- package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +13 -0
- package/dist-types/commands/DetectSentimentCommand.d.ts +12 -0
- package/dist-types/commands/DetectSyntaxCommand.d.ts +17 -0
- package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +31 -0
- package/dist-types/commands/ImportModelCommand.d.ts +6 -0
- package/dist-types/commands/ListDatasetsCommand.d.ts +20 -0
- package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +44 -0
- package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +15 -0
- package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +83 -0
- package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +42 -0
- package/dist-types/commands/ListEndpointsCommand.d.ts +22 -0
- package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +45 -0
- package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +15 -0
- package/dist-types/commands/ListEntityRecognizersCommand.d.ts +87 -0
- package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +37 -0
- package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +31 -0
- package/dist-types/commands/ListFlywheelsCommand.d.ts +19 -0
- package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +43 -0
- package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +42 -0
- package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +43 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
- package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +43 -0
- package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +43 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -0
- package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +9 -0
- package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +9 -0
- package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartFlywheelIterationCommand.d.ts +7 -0
- package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +8 -0
- package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +7 -0
- package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +4 -0
- package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +6 -0
- package/dist-types/commands/UpdateFlywheelCommand.d.ts +46 -0
- package/package.json +3 -3
|
@@ -35,6 +35,27 @@ export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDom
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new BatchDetectDominantLanguageCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // BatchDetectDominantLanguageResponse
|
|
39
|
+
* // ResultList: [ // ListOfDetectDominantLanguageResult // required
|
|
40
|
+
* // { // BatchDetectDominantLanguageItemResult
|
|
41
|
+
* // Index: Number("int"),
|
|
42
|
+
* // Languages: [ // ListOfDominantLanguages
|
|
43
|
+
* // { // DominantLanguage
|
|
44
|
+
* // LanguageCode: "STRING_VALUE",
|
|
45
|
+
* // Score: Number("float"),
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
51
|
+
* // { // BatchItemError
|
|
52
|
+
* // Index: Number("int"),
|
|
53
|
+
* // ErrorCode: "STRING_VALUE",
|
|
54
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
38
59
|
* ```
|
|
39
60
|
*
|
|
40
61
|
* @param BatchDetectDominantLanguageCommandInput - {@link BatchDetectDominantLanguageCommandInput}
|
|
@@ -56,6 +77,8 @@ export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDom
|
|
|
56
77
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
57
78
|
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
|
|
58
79
|
*
|
|
80
|
+
* @throws {@link ComprehendServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
59
82
|
*
|
|
60
83
|
*/
|
|
61
84
|
export declare class BatchDetectDominantLanguageCommand extends $Command<BatchDetectDominantLanguageCommandInput, BatchDetectDominantLanguageCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -37,6 +37,44 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new BatchDetectEntitiesCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // BatchDetectEntitiesResponse
|
|
41
|
+
* // ResultList: [ // ListOfDetectEntitiesResult // required
|
|
42
|
+
* // { // BatchDetectEntitiesItemResult
|
|
43
|
+
* // Index: Number("int"),
|
|
44
|
+
* // Entities: [ // ListOfEntities
|
|
45
|
+
* // { // Entity
|
|
46
|
+
* // Score: Number("float"),
|
|
47
|
+
* // Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "COMMERCIAL_ITEM" || "EVENT" || "DATE" || "QUANTITY" || "TITLE" || "OTHER",
|
|
48
|
+
* // Text: "STRING_VALUE",
|
|
49
|
+
* // BeginOffset: Number("int"),
|
|
50
|
+
* // EndOffset: Number("int"),
|
|
51
|
+
* // BlockReferences: [ // ListOfBlockReferences
|
|
52
|
+
* // { // BlockReference
|
|
53
|
+
* // BlockId: "STRING_VALUE",
|
|
54
|
+
* // BeginOffset: Number("int"),
|
|
55
|
+
* // EndOffset: Number("int"),
|
|
56
|
+
* // ChildBlocks: [ // ListOfChildBlocks
|
|
57
|
+
* // { // ChildBlock
|
|
58
|
+
* // ChildBlockId: "STRING_VALUE",
|
|
59
|
+
* // BeginOffset: Number("int"),
|
|
60
|
+
* // EndOffset: Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
70
|
+
* // { // BatchItemError
|
|
71
|
+
* // Index: Number("int"),
|
|
72
|
+
* // ErrorCode: "STRING_VALUE",
|
|
73
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
40
78
|
* ```
|
|
41
79
|
*
|
|
42
80
|
* @param BatchDetectEntitiesCommandInput - {@link BatchDetectEntitiesCommandInput}
|
|
@@ -65,6 +103,8 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
|
|
|
65
103
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
66
104
|
* </p>
|
|
67
105
|
*
|
|
106
|
+
* @throws {@link ComprehendServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
68
108
|
*
|
|
69
109
|
*/
|
|
70
110
|
export declare class BatchDetectEntitiesCommand extends $Command<BatchDetectEntitiesCommandInput, BatchDetectEntitiesCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -34,6 +34,29 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new BatchDetectKeyPhrasesCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // BatchDetectKeyPhrasesResponse
|
|
38
|
+
* // ResultList: [ // ListOfDetectKeyPhrasesResult // required
|
|
39
|
+
* // { // BatchDetectKeyPhrasesItemResult
|
|
40
|
+
* // Index: Number("int"),
|
|
41
|
+
* // KeyPhrases: [ // ListOfKeyPhrases
|
|
42
|
+
* // { // KeyPhrase
|
|
43
|
+
* // Score: Number("float"),
|
|
44
|
+
* // Text: "STRING_VALUE",
|
|
45
|
+
* // BeginOffset: Number("int"),
|
|
46
|
+
* // EndOffset: Number("int"),
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
52
|
+
* // { // BatchItemError
|
|
53
|
+
* // Index: Number("int"),
|
|
54
|
+
* // ErrorCode: "STRING_VALUE",
|
|
55
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
37
60
|
* ```
|
|
38
61
|
*
|
|
39
62
|
* @param BatchDetectKeyPhrasesCommandInput - {@link BatchDetectKeyPhrasesCommandInput}
|
|
@@ -62,6 +85,8 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
|
|
|
62
85
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
63
86
|
* </p>
|
|
64
87
|
*
|
|
88
|
+
* @throws {@link ComprehendServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
65
90
|
*
|
|
66
91
|
*/
|
|
67
92
|
export declare class BatchDetectKeyPhrasesCommand extends $Command<BatchDetectKeyPhrasesCommandInput, BatchDetectKeyPhrasesCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -36,6 +36,28 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new BatchDetectSentimentCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // BatchDetectSentimentResponse
|
|
40
|
+
* // ResultList: [ // ListOfDetectSentimentResult // required
|
|
41
|
+
* // { // BatchDetectSentimentItemResult
|
|
42
|
+
* // Index: Number("int"),
|
|
43
|
+
* // Sentiment: "POSITIVE" || "NEGATIVE" || "NEUTRAL" || "MIXED",
|
|
44
|
+
* // SentimentScore: { // SentimentScore
|
|
45
|
+
* // Positive: Number("float"),
|
|
46
|
+
* // Negative: Number("float"),
|
|
47
|
+
* // Neutral: Number("float"),
|
|
48
|
+
* // Mixed: Number("float"),
|
|
49
|
+
* // },
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
53
|
+
* // { // BatchItemError
|
|
54
|
+
* // Index: Number("int"),
|
|
55
|
+
* // ErrorCode: "STRING_VALUE",
|
|
56
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
39
61
|
* ```
|
|
40
62
|
*
|
|
41
63
|
* @param BatchDetectSentimentCommandInput - {@link BatchDetectSentimentCommandInput}
|
|
@@ -64,6 +86,8 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
|
|
|
64
86
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
65
87
|
* </p>
|
|
66
88
|
*
|
|
89
|
+
* @throws {@link ComprehendServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
67
91
|
*
|
|
68
92
|
*/
|
|
69
93
|
export declare class BatchDetectSentimentCommand extends $Command<BatchDetectSentimentCommandInput, BatchDetectSentimentCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -37,6 +37,33 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new BatchDetectSyntaxCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // BatchDetectSyntaxResponse
|
|
41
|
+
* // ResultList: [ // ListOfDetectSyntaxResult // required
|
|
42
|
+
* // { // BatchDetectSyntaxItemResult
|
|
43
|
+
* // Index: Number("int"),
|
|
44
|
+
* // SyntaxTokens: [ // ListOfSyntaxTokens
|
|
45
|
+
* // { // SyntaxToken
|
|
46
|
+
* // TokenId: Number("int"),
|
|
47
|
+
* // Text: "STRING_VALUE",
|
|
48
|
+
* // BeginOffset: Number("int"),
|
|
49
|
+
* // EndOffset: Number("int"),
|
|
50
|
+
* // PartOfSpeech: { // PartOfSpeechTag
|
|
51
|
+
* // Tag: "ADJ" || "ADP" || "ADV" || "AUX" || "CONJ" || "CCONJ" || "DET" || "INTJ" || "NOUN" || "NUM" || "O" || "PART" || "PRON" || "PROPN" || "PUNCT" || "SCONJ" || "SYM" || "VERB",
|
|
52
|
+
* // Score: Number("float"),
|
|
53
|
+
* // },
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
59
|
+
* // { // BatchItemError
|
|
60
|
+
* // Index: Number("int"),
|
|
61
|
+
* // ErrorCode: "STRING_VALUE",
|
|
62
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
40
67
|
* ```
|
|
41
68
|
*
|
|
42
69
|
* @param BatchDetectSyntaxCommandInput - {@link BatchDetectSyntaxCommandInput}
|
|
@@ -65,6 +92,8 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
|
|
|
65
92
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
66
93
|
* </p>
|
|
67
94
|
*
|
|
95
|
+
* @throws {@link ComprehendServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
68
97
|
*
|
|
69
98
|
*/
|
|
70
99
|
export declare class BatchDetectSyntaxCommand extends $Command<BatchDetectSyntaxCommandInput, BatchDetectSyntaxCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -36,6 +36,47 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new BatchDetectTargetedSentimentCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // BatchDetectTargetedSentimentResponse
|
|
40
|
+
* // ResultList: [ // ListOfDetectTargetedSentimentResult // required
|
|
41
|
+
* // { // BatchDetectTargetedSentimentItemResult
|
|
42
|
+
* // Index: Number("int"),
|
|
43
|
+
* // Entities: [ // ListOfTargetedSentimentEntities
|
|
44
|
+
* // { // TargetedSentimentEntity
|
|
45
|
+
* // DescriptiveMentionIndex: [ // ListOfDescriptiveMentionIndices
|
|
46
|
+
* // Number("int"),
|
|
47
|
+
* // ],
|
|
48
|
+
* // Mentions: [ // ListOfMentions
|
|
49
|
+
* // { // TargetedSentimentMention
|
|
50
|
+
* // Score: Number("float"),
|
|
51
|
+
* // GroupScore: Number("float"),
|
|
52
|
+
* // Text: "STRING_VALUE",
|
|
53
|
+
* // Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "FACILITY" || "BRAND" || "COMMERCIAL_ITEM" || "MOVIE" || "MUSIC" || "BOOK" || "SOFTWARE" || "GAME" || "PERSONAL_TITLE" || "EVENT" || "DATE" || "QUANTITY" || "ATTRIBUTE" || "OTHER",
|
|
54
|
+
* // MentionSentiment: { // MentionSentiment
|
|
55
|
+
* // Sentiment: "POSITIVE" || "NEGATIVE" || "NEUTRAL" || "MIXED",
|
|
56
|
+
* // SentimentScore: { // SentimentScore
|
|
57
|
+
* // Positive: Number("float"),
|
|
58
|
+
* // Negative: Number("float"),
|
|
59
|
+
* // Neutral: Number("float"),
|
|
60
|
+
* // Mixed: Number("float"),
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // BeginOffset: Number("int"),
|
|
64
|
+
* // EndOffset: Number("int"),
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // ErrorList: [ // BatchItemErrorList // required
|
|
72
|
+
* // { // BatchItemError
|
|
73
|
+
* // Index: Number("int"),
|
|
74
|
+
* // ErrorCode: "STRING_VALUE",
|
|
75
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
39
80
|
* ```
|
|
40
81
|
*
|
|
41
82
|
* @param BatchDetectTargetedSentimentCommandInput - {@link BatchDetectTargetedSentimentCommandInput}
|
|
@@ -64,6 +105,8 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
|
|
|
64
105
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
65
106
|
* </p>
|
|
66
107
|
*
|
|
108
|
+
* @throws {@link ComprehendServiceException}
|
|
109
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
67
110
|
*
|
|
68
111
|
*/
|
|
69
112
|
export declare class BatchDetectTargetedSentimentCommand extends $Command<BatchDetectTargetedSentimentCommandInput, BatchDetectTargetedSentimentCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -50,6 +50,52 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
|
|
|
50
50
|
* };
|
|
51
51
|
* const command = new ClassifyDocumentCommand(input);
|
|
52
52
|
* const response = await client.send(command);
|
|
53
|
+
* // { // ClassifyDocumentResponse
|
|
54
|
+
* // Classes: [ // ListOfClasses
|
|
55
|
+
* // { // DocumentClass
|
|
56
|
+
* // Name: "STRING_VALUE",
|
|
57
|
+
* // Score: Number("float"),
|
|
58
|
+
* // Page: Number("int"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // Labels: [ // ListOfLabels
|
|
62
|
+
* // { // DocumentLabel
|
|
63
|
+
* // Name: "STRING_VALUE",
|
|
64
|
+
* // Score: Number("float"),
|
|
65
|
+
* // Page: Number("int"),
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // DocumentMetadata: { // DocumentMetadata
|
|
69
|
+
* // Pages: Number("int"),
|
|
70
|
+
* // ExtractedCharacters: [ // ListOfExtractedCharacters
|
|
71
|
+
* // { // ExtractedCharactersListItem
|
|
72
|
+
* // Page: Number("int"),
|
|
73
|
+
* // Count: Number("int"),
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // DocumentType: [ // ListOfDocumentType
|
|
78
|
+
* // { // DocumentTypeListItem
|
|
79
|
+
* // Page: Number("int"),
|
|
80
|
+
* // Type: "NATIVE_PDF" || "SCANNED_PDF" || "MS_WORD" || "IMAGE" || "PLAIN_TEXT" || "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" || "TEXTRACT_ANALYZE_DOCUMENT_JSON",
|
|
81
|
+
* // },
|
|
82
|
+
* // ],
|
|
83
|
+
* // Errors: [ // ListOfErrors
|
|
84
|
+
* // { // ErrorsListItem
|
|
85
|
+
* // Page: Number("int"),
|
|
86
|
+
* // ErrorCode: "TEXTRACT_BAD_PAGE" || "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED" || "PAGE_CHARACTERS_EXCEEDED" || "PAGE_SIZE_EXCEEDED" || "INTERNAL_SERVER_ERROR",
|
|
87
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // Warnings: [ // ListOfWarnings
|
|
91
|
+
* // { // WarningsListItem
|
|
92
|
+
* // Page: Number("int"),
|
|
93
|
+
* // WarnCode: "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL" || "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL",
|
|
94
|
+
* // WarnMessage: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // };
|
|
98
|
+
*
|
|
53
99
|
* ```
|
|
54
100
|
*
|
|
55
101
|
* @param ClassifyDocumentCommandInput - {@link ClassifyDocumentCommandInput}
|
|
@@ -71,6 +117,8 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
|
|
|
71
117
|
* @throws {@link TextSizeLimitExceededException} (client fault)
|
|
72
118
|
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
|
|
73
119
|
*
|
|
120
|
+
* @throws {@link ComprehendServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
74
122
|
*
|
|
75
123
|
*/
|
|
76
124
|
export declare class ClassifyDocumentCommand extends $Command<ClassifyDocumentCommandInput, ClassifyDocumentCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -34,6 +34,15 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ContainsPiiEntitiesCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ContainsPiiEntitiesResponse
|
|
38
|
+
* // Labels: [ // ListOfEntityLabels
|
|
39
|
+
* // { // EntityLabel
|
|
40
|
+
* // Name: "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
|
+
* // Score: Number("float"),
|
|
42
|
+
* // },
|
|
43
|
+
* // ],
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
37
46
|
* ```
|
|
38
47
|
*
|
|
39
48
|
* @param ContainsPiiEntitiesCommandInput - {@link ContainsPiiEntitiesCommandInput}
|
|
@@ -58,6 +67,8 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
|
|
|
58
67
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
59
68
|
* </p>
|
|
60
69
|
*
|
|
70
|
+
* @throws {@link ComprehendServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
61
72
|
*
|
|
62
73
|
*/
|
|
63
74
|
export declare class ContainsPiiEntitiesCommand extends $Command<ContainsPiiEntitiesCommandInput, ContainsPiiEntitiesCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -73,6 +73,10 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
73
73
|
* };
|
|
74
74
|
* const command = new CreateDatasetCommand(input);
|
|
75
75
|
* const response = await client.send(command);
|
|
76
|
+
* // { // CreateDatasetResponse
|
|
77
|
+
* // DatasetArn: "STRING_VALUE",
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
76
80
|
* ```
|
|
77
81
|
*
|
|
78
82
|
* @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
|
|
@@ -106,6 +110,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
106
110
|
* resource). The maximum number of tags includes both existing tags and those included in your
|
|
107
111
|
* current request. </p>
|
|
108
112
|
*
|
|
113
|
+
* @throws {@link ComprehendServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
109
115
|
*
|
|
110
116
|
*/
|
|
111
117
|
export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -93,6 +93,10 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
|
|
|
93
93
|
* };
|
|
94
94
|
* const command = new CreateDocumentClassifierCommand(input);
|
|
95
95
|
* const response = await client.send(command);
|
|
96
|
+
* // { // CreateDocumentClassifierResponse
|
|
97
|
+
* // DocumentClassifierArn: "STRING_VALUE",
|
|
98
|
+
* // };
|
|
99
|
+
*
|
|
96
100
|
* ```
|
|
97
101
|
*
|
|
98
102
|
* @param CreateDocumentClassifierCommandInput - {@link CreateDocumentClassifierCommandInput}
|
|
@@ -134,6 +138,8 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
|
|
|
134
138
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
135
139
|
* </p>
|
|
136
140
|
*
|
|
141
|
+
* @throws {@link ComprehendServiceException}
|
|
142
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
137
143
|
*
|
|
138
144
|
*/
|
|
139
145
|
export declare class CreateDocumentClassifierCommand extends $Command<CreateDocumentClassifierCommandInput, CreateDocumentClassifierCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -44,6 +44,11 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new CreateEndpointCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // CreateEndpointResponse
|
|
48
|
+
* // EndpointArn: "STRING_VALUE",
|
|
49
|
+
* // ModelArn: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
47
52
|
* ```
|
|
48
53
|
*
|
|
49
54
|
* @param CreateEndpointCommandInput - {@link CreateEndpointCommandInput}
|
|
@@ -81,6 +86,8 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
|
|
|
81
86
|
* resource). The maximum number of tags includes both existing tags and those included in your
|
|
82
87
|
* current request. </p>
|
|
83
88
|
*
|
|
89
|
+
* @throws {@link ComprehendServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
84
91
|
*
|
|
85
92
|
*/
|
|
86
93
|
export declare class CreateEndpointCommand extends $Command<CreateEndpointCommandInput, CreateEndpointCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -86,6 +86,10 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
|
|
|
86
86
|
* };
|
|
87
87
|
* const command = new CreateEntityRecognizerCommand(input);
|
|
88
88
|
* const response = await client.send(command);
|
|
89
|
+
* // { // CreateEntityRecognizerResponse
|
|
90
|
+
* // EntityRecognizerArn: "STRING_VALUE",
|
|
91
|
+
* // };
|
|
92
|
+
*
|
|
89
93
|
* ```
|
|
90
94
|
*
|
|
91
95
|
* @param CreateEntityRecognizerCommandInput - {@link CreateEntityRecognizerCommandInput}
|
|
@@ -127,6 +131,8 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
|
|
|
127
131
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
128
132
|
* </p>
|
|
129
133
|
*
|
|
134
|
+
* @throws {@link ComprehendServiceException}
|
|
135
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
130
136
|
*
|
|
131
137
|
*/
|
|
132
138
|
export declare class CreateEntityRecognizerCommand extends $Command<CreateEntityRecognizerCommandInput, CreateEntityRecognizerCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -81,6 +81,11 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
|
|
|
81
81
|
* };
|
|
82
82
|
* const command = new CreateFlywheelCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
+
* // { // CreateFlywheelResponse
|
|
85
|
+
* // FlywheelArn: "STRING_VALUE",
|
|
86
|
+
* // ActiveModelArn: "STRING_VALUE",
|
|
87
|
+
* // };
|
|
88
|
+
*
|
|
84
89
|
* ```
|
|
85
90
|
*
|
|
86
91
|
* @param CreateFlywheelCommandInput - {@link CreateFlywheelCommandInput}
|
|
@@ -129,6 +134,8 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
|
|
|
129
134
|
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
|
|
130
135
|
* </p>
|
|
131
136
|
*
|
|
137
|
+
* @throws {@link ComprehendServiceException}
|
|
138
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
132
139
|
*
|
|
133
140
|
*/
|
|
134
141
|
export declare class CreateFlywheelCommand extends $Command<CreateFlywheelCommandInput, CreateFlywheelCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -37,6 +37,8 @@ export interface DeleteDocumentClassifierCommandOutput extends DeleteDocumentCla
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new DeleteDocumentClassifierCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
44
|
* @param DeleteDocumentClassifierCommandInput - {@link DeleteDocumentClassifierCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteDocumentClassifierCommandOutput extends DeleteDocumentCla
|
|
|
65
67
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
68
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link ComprehendServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class DeleteDocumentClassifierCommand extends $Command<DeleteDocumentClassifierCommandInput, DeleteDocumentClassifierCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -33,6 +33,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DeleteEndpointCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // {};
|
|
37
|
+
*
|
|
36
38
|
* ```
|
|
37
39
|
*
|
|
38
40
|
* @param DeleteEndpointCommandInput - {@link DeleteEndpointCommandInput}
|
|
@@ -57,6 +59,8 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
|
|
|
57
59
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
58
60
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
59
61
|
*
|
|
62
|
+
* @throws {@link ComprehendServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
60
64
|
*
|
|
61
65
|
*/
|
|
62
66
|
export declare class DeleteEndpointCommand extends $Command<DeleteEndpointCommandInput, DeleteEndpointCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -37,6 +37,8 @@ export interface DeleteEntityRecognizerCommandOutput extends DeleteEntityRecogni
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new DeleteEntityRecognizerCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
44
|
* @param DeleteEntityRecognizerCommandInput - {@link DeleteEntityRecognizerCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteEntityRecognizerCommandOutput extends DeleteEntityRecogni
|
|
|
65
67
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
68
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link ComprehendServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class DeleteEntityRecognizerCommand extends $Command<DeleteEntityRecognizerCommandInput, DeleteEntityRecognizerCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteFlywheelCommandOutput extends DeleteFlywheelResponse, __M
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteFlywheelCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteFlywheelCommandInput - {@link DeleteFlywheelCommandInput}
|
|
@@ -62,6 +64,8 @@ export interface DeleteFlywheelCommandOutput extends DeleteFlywheelResponse, __M
|
|
|
62
64
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
63
65
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
64
66
|
*
|
|
67
|
+
* @throws {@link ComprehendServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
65
69
|
*
|
|
66
70
|
*/
|
|
67
71
|
export declare class DeleteFlywheelCommand extends $Command<DeleteFlywheelCommandInput, DeleteFlywheelCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteResourcePolicyCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
|
|
@@ -49,6 +51,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
49
51
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
50
52
|
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
51
53
|
*
|
|
54
|
+
* @throws {@link ComprehendServiceException}
|
|
55
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
52
56
|
*
|
|
53
57
|
*/
|
|
54
58
|
export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -33,6 +33,21 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DescribeDatasetCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // DescribeDatasetResponse
|
|
37
|
+
* // DatasetProperties: { // DatasetProperties
|
|
38
|
+
* // DatasetArn: "STRING_VALUE",
|
|
39
|
+
* // DatasetName: "STRING_VALUE",
|
|
40
|
+
* // DatasetType: "TRAIN" || "TEST",
|
|
41
|
+
* // DatasetS3Uri: "STRING_VALUE",
|
|
42
|
+
* // Description: "STRING_VALUE",
|
|
43
|
+
* // Status: "CREATING" || "COMPLETED" || "FAILED",
|
|
44
|
+
* // Message: "STRING_VALUE",
|
|
45
|
+
* // NumberOfDocuments: Number("long"),
|
|
46
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
36
51
|
* ```
|
|
37
52
|
*
|
|
38
53
|
* @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
|
|
@@ -53,6 +68,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
|
|
|
53
68
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
54
69
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
55
70
|
*
|
|
71
|
+
* @throws {@link ComprehendServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
56
73
|
*
|
|
57
74
|
*/
|
|
58
75
|
export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, ComprehendClientResolvedConfig> {
|
|
@@ -32,6 +32,45 @@ export interface DescribeDocumentClassificationJobCommandOutput extends Describe
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeDocumentClassificationJobCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeDocumentClassificationJobResponse
|
|
36
|
+
* // DocumentClassificationJobProperties: { // DocumentClassificationJobProperties
|
|
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
|
+
* // DocumentClassifierArn: "STRING_VALUE",
|
|
45
|
+
* // InputDataConfig: { // InputDataConfig
|
|
46
|
+
* // S3Uri: "STRING_VALUE", // required
|
|
47
|
+
* // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
|
|
48
|
+
* // DocumentReaderConfig: { // DocumentReaderConfig
|
|
49
|
+
* // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
|
|
50
|
+
* // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
|
|
51
|
+
* // FeatureTypes: [ // ListOfDocumentReadFeatureTypes
|
|
52
|
+
* // "TABLES" || "FORMS",
|
|
53
|
+
* // ],
|
|
54
|
+
* // },
|
|
55
|
+
* // },
|
|
56
|
+
* // OutputDataConfig: { // OutputDataConfig
|
|
57
|
+
* // S3Uri: "STRING_VALUE", // required
|
|
58
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
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
|
+
* // FlywheelArn: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
35
74
|
* ```
|
|
36
75
|
*
|
|
37
76
|
* @param DescribeDocumentClassificationJobCommandInput - {@link DescribeDocumentClassificationJobCommandInput}
|
|
@@ -52,6 +91,8 @@ export interface DescribeDocumentClassificationJobCommandOutput extends Describe
|
|
|
52
91
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
53
92
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
54
93
|
*
|
|
94
|
+
* @throws {@link ComprehendServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from Comprehend service.</p>
|
|
55
96
|
*
|
|
56
97
|
*/
|
|
57
98
|
export declare class DescribeDocumentClassificationJobCommand extends $Command<DescribeDocumentClassificationJobCommandInput, DescribeDocumentClassificationJobCommandOutput, ComprehendClientResolvedConfig> {
|