@aws-sdk/client-comprehend 3.379.1 → 3.385.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.
@@ -6,6 +6,7 @@ import { FlywheelProperties, JobStatus, Tag, VpcConfig } from "./models_0";
6
6
  */
7
7
  export interface StopPiiEntitiesDetectionJobRequest {
8
8
  /**
9
+ * @public
9
10
  * <p>The identifier of the PII entities detection job to stop.</p>
10
11
  */
11
12
  JobId: string | undefined;
@@ -15,10 +16,12 @@ export interface StopPiiEntitiesDetectionJobRequest {
15
16
  */
16
17
  export interface StopPiiEntitiesDetectionJobResponse {
17
18
  /**
19
+ * @public
18
20
  * <p>The identifier of the PII entities detection job to stop.</p>
19
21
  */
20
22
  JobId?: string;
21
23
  /**
24
+ * @public
22
25
  * <p>The status of the PII entities detection job.</p>
23
26
  */
24
27
  JobStatus?: JobStatus | string;
@@ -28,6 +31,7 @@ export interface StopPiiEntitiesDetectionJobResponse {
28
31
  */
29
32
  export interface StopSentimentDetectionJobRequest {
30
33
  /**
34
+ * @public
31
35
  * <p>The identifier of the sentiment detection job to stop.</p>
32
36
  */
33
37
  JobId: string | undefined;
@@ -37,10 +41,12 @@ export interface StopSentimentDetectionJobRequest {
37
41
  */
38
42
  export interface StopSentimentDetectionJobResponse {
39
43
  /**
44
+ * @public
40
45
  * <p>The identifier of the sentiment detection job to stop.</p>
41
46
  */
42
47
  JobId?: string;
43
48
  /**
49
+ * @public
44
50
  * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
45
51
  * <code>STOPPED</code> if the job was previously stopped with the
46
52
  * <code>StopSentimentDetectionJob</code> operation.</p>
@@ -52,6 +58,7 @@ export interface StopSentimentDetectionJobResponse {
52
58
  */
53
59
  export interface StopTargetedSentimentDetectionJobRequest {
54
60
  /**
61
+ * @public
55
62
  * <p>The identifier of the targeted sentiment detection job to stop.</p>
56
63
  */
57
64
  JobId: string | undefined;
@@ -61,10 +68,12 @@ export interface StopTargetedSentimentDetectionJobRequest {
61
68
  */
62
69
  export interface StopTargetedSentimentDetectionJobResponse {
63
70
  /**
71
+ * @public
64
72
  * <p>The identifier of the targeted sentiment detection job to stop.</p>
65
73
  */
66
74
  JobId?: string;
67
75
  /**
76
+ * @public
68
77
  * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
69
78
  * <code>STOPPED</code> if the job was previously stopped with the
70
79
  * <code>StopSentimentDetectionJob</code> operation.</p>
@@ -76,6 +85,7 @@ export interface StopTargetedSentimentDetectionJobResponse {
76
85
  */
77
86
  export interface StopTrainingDocumentClassifierRequest {
78
87
  /**
88
+ * @public
79
89
  * <p>The Amazon Resource Name (ARN) that identifies the document classifier currently being
80
90
  * trained.</p>
81
91
  */
@@ -91,6 +101,7 @@ export interface StopTrainingDocumentClassifierResponse {
91
101
  */
92
102
  export interface StopTrainingEntityRecognizerRequest {
93
103
  /**
104
+ * @public
94
105
  * <p>The Amazon Resource Name (ARN) that identifies the entity recognizer currently being
95
106
  * trained.</p>
96
107
  */
@@ -120,11 +131,13 @@ export declare class ConcurrentModificationException extends __BaseException {
120
131
  */
121
132
  export interface TagResourceRequest {
122
133
  /**
134
+ * @public
123
135
  * <p>The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want
124
136
  * to associate the tags. </p>
125
137
  */
126
138
  ResourceArn: string | undefined;
127
139
  /**
140
+ * @public
128
141
  * <p>Tags being associated with a specific Amazon Comprehend resource. There can be a maximum
129
142
  * of 50 tags (both existing and pending) associated with a specific resource. </p>
130
143
  */
@@ -154,11 +167,13 @@ export declare class TooManyTagKeysException extends __BaseException {
154
167
  */
155
168
  export interface UntagResourceRequest {
156
169
  /**
170
+ * @public
157
171
  * <p> The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you
158
172
  * want to remove the tags. </p>
159
173
  */
160
174
  ResourceArn: string | undefined;
161
175
  /**
176
+ * @public
162
177
  * <p>The initial part of a key-value pair that forms a tag being removed from a given resource.
163
178
  * For example, a tag with "Sales" as the key might be added to a resource to indicate its use by
164
179
  * the sales department. Keys must be unique and cannot be duplicated for a particular resource.
@@ -176,24 +191,29 @@ export interface UntagResourceResponse {
176
191
  */
177
192
  export interface UpdateEndpointRequest {
178
193
  /**
194
+ * @public
179
195
  * <p>The Amazon Resource Number (ARN) of the endpoint being updated.</p>
180
196
  */
181
197
  EndpointArn: string | undefined;
182
198
  /**
199
+ * @public
183
200
  * <p>The ARN of the new model to use when updating an existing endpoint.</p>
184
201
  */
185
202
  DesiredModelArn?: string;
186
203
  /**
204
+ * @public
187
205
  * <p> The desired number of inference units to be used by the model using this endpoint.
188
206
  *
189
207
  * Each inference unit represents of a throughput of 100 characters per second.</p>
190
208
  */
191
209
  DesiredInferenceUnits?: number;
192
210
  /**
211
+ * @public
193
212
  * <p>Data access role ARN to use in case the new model is encrypted with a customer CMK.</p>
194
213
  */
195
214
  DesiredDataAccessRoleArn?: string;
196
215
  /**
216
+ * @public
197
217
  * <p>The Amazon Resource Number (ARN) of the flywheel</p>
198
218
  */
199
219
  FlywheelArn?: string;
@@ -203,6 +223,7 @@ export interface UpdateEndpointRequest {
203
223
  */
204
224
  export interface UpdateEndpointResponse {
205
225
  /**
226
+ * @public
206
227
  * <p>The Amazon Resource Number (ARN) of the new model.</p>
207
228
  */
208
229
  DesiredModelArn?: string;
@@ -213,6 +234,7 @@ export interface UpdateEndpointResponse {
213
234
  */
214
235
  export interface UpdateDataSecurityConfig {
215
236
  /**
237
+ * @public
216
238
  * <p>ID for the KMS key that Amazon Comprehend uses to encrypt
217
239
  * trained custom models. The ModelKmsKeyId can be either of the following formats:</p>
218
240
  * <ul>
@@ -229,10 +251,12 @@ export interface UpdateDataSecurityConfig {
229
251
  */
230
252
  ModelKmsKeyId?: string;
231
253
  /**
254
+ * @public
232
255
  * <p>ID for the KMS key that Amazon Comprehend uses to encrypt the volume.</p>
233
256
  */
234
257
  VolumeKmsKeyId?: string;
235
258
  /**
259
+ * @public
236
260
  * <p> Configuration parameters for an optional private Virtual Private Cloud (VPC) containing
237
261
  * the resources you are using for the job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
238
262
  * VPC</a>. </p>
@@ -244,19 +268,23 @@ export interface UpdateDataSecurityConfig {
244
268
  */
245
269
  export interface UpdateFlywheelRequest {
246
270
  /**
271
+ * @public
247
272
  * <p>The Amazon Resource Number (ARN) of the flywheel to update.</p>
248
273
  */
249
274
  FlywheelArn: string | undefined;
250
275
  /**
276
+ * @public
251
277
  * <p>The Amazon Resource Number (ARN) of the active model version.</p>
252
278
  */
253
279
  ActiveModelArn?: string;
254
280
  /**
281
+ * @public
255
282
  * <p>The Amazon Resource Name (ARN) of the IAM role that
256
283
  * grants Amazon Comprehend permission to access the flywheel data.</p>
257
284
  */
258
285
  DataAccessRoleArn?: string;
259
286
  /**
287
+ * @public
260
288
  * <p>Flywheel data security configuration.</p>
261
289
  */
262
290
  DataSecurityConfig?: UpdateDataSecurityConfig;
@@ -266,6 +294,7 @@ export interface UpdateFlywheelRequest {
266
294
  */
267
295
  export interface UpdateFlywheelResponse {
268
296
  /**
297
+ * @public
269
298
  * <p>The flywheel properties.</p>
270
299
  */
271
300
  FlywheelProperties?: FlywheelProperties;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-comprehend",
3
3
  "description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",