@aws-sdk/client-sagemaker-edge 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.
@@ -5,10 +5,12 @@ import { SagemakerEdgeServiceException as __BaseException } from "./SagemakerEdg
5
5
  */
6
6
  export interface GetDeploymentsRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The unique name of the device you want to get the configuration of active deployments from.</p>
9
10
  */
10
11
  DeviceName: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>The name of the fleet that the device belongs to.</p>
13
15
  */
14
16
  DeviceFleetName: string | undefined;
@@ -30,10 +32,12 @@ export type ChecksumType = (typeof ChecksumType)[keyof typeof ChecksumType];
30
32
  */
31
33
  export interface Checksum {
32
34
  /**
35
+ * @public
33
36
  * <p>The type of the checksum.</p>
34
37
  */
35
38
  Type?: ChecksumType | string;
36
39
  /**
40
+ * @public
37
41
  * <p>The checksum of the model.</p>
38
42
  */
39
43
  Sum?: string;
@@ -56,18 +60,22 @@ export type ModelState = (typeof ModelState)[keyof typeof ModelState];
56
60
  */
57
61
  export interface Definition {
58
62
  /**
63
+ * @public
59
64
  * <p>The unique model handle.</p>
60
65
  */
61
66
  ModelHandle?: string;
62
67
  /**
68
+ * @public
63
69
  * <p>The absolute S3 location of the model.</p>
64
70
  */
65
71
  S3Url?: string;
66
72
  /**
73
+ * @public
67
74
  * <p>The checksum information of the model.</p>
68
75
  */
69
76
  Checksum?: Checksum;
70
77
  /**
78
+ * @public
71
79
  * <p>The desired state of the model.</p>
72
80
  */
73
81
  State?: ModelState | string;
@@ -101,18 +109,22 @@ export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType
101
109
  */
102
110
  export interface EdgeDeployment {
103
111
  /**
112
+ * @public
104
113
  * <p>The name and unique ID of the deployment.</p>
105
114
  */
106
115
  DeploymentName?: string;
107
116
  /**
117
+ * @public
108
118
  * <p>The type of the deployment.</p>
109
119
  */
110
120
  Type?: DeploymentType | string;
111
121
  /**
122
+ * @public
112
123
  * <p>Determines whether to rollback to previous configuration if deployment fails.</p>
113
124
  */
114
125
  FailureHandlingPolicy?: FailureHandlingPolicy | string;
115
126
  /**
127
+ * @public
116
128
  * <p>Returns a list of Definition objects.</p>
117
129
  */
118
130
  Definitions?: Definition[];
@@ -122,6 +134,7 @@ export interface EdgeDeployment {
122
134
  */
123
135
  export interface GetDeploymentsResult {
124
136
  /**
137
+ * @public
125
138
  * <p>Returns a list of the configurations of the active deployments on the device.</p>
126
139
  */
127
140
  Deployments?: EdgeDeployment[];
@@ -145,10 +158,12 @@ export declare class InternalServiceException extends __BaseException {
145
158
  */
146
159
  export interface GetDeviceRegistrationRequest {
147
160
  /**
161
+ * @public
148
162
  * <p>The unique name of the device you want to get the registration status from.</p>
149
163
  */
150
164
  DeviceName: string | undefined;
151
165
  /**
166
+ * @public
152
167
  * <p>The name of the fleet that the device belongs to.</p>
153
168
  */
154
169
  DeviceFleetName: string | undefined;
@@ -158,10 +173,12 @@ export interface GetDeviceRegistrationRequest {
158
173
  */
159
174
  export interface GetDeviceRegistrationResult {
160
175
  /**
176
+ * @public
161
177
  * <p>Describes if the device is currently registered with SageMaker Edge Manager.</p>
162
178
  */
163
179
  DeviceRegistration?: string;
164
180
  /**
181
+ * @public
165
182
  * <p>The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.</p>
166
183
  */
167
184
  CacheTTL?: string;
@@ -172,18 +189,22 @@ export interface GetDeviceRegistrationResult {
172
189
  */
173
190
  export interface EdgeMetric {
174
191
  /**
192
+ * @public
175
193
  * <p>The dimension of metrics published.</p>
176
194
  */
177
195
  Dimension?: string;
178
196
  /**
197
+ * @public
179
198
  * <p>Returns the name of the metric.</p>
180
199
  */
181
200
  MetricName?: string;
182
201
  /**
202
+ * @public
183
203
  * <p>Returns the value of the metric.</p>
184
204
  */
185
205
  Value?: number;
186
206
  /**
207
+ * @public
187
208
  * <p>Timestamp of when the metric was requested.</p>
188
209
  */
189
210
  Timestamp?: Date;
@@ -206,34 +227,42 @@ export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof Deployment
206
227
  */
207
228
  export interface DeploymentModel {
208
229
  /**
230
+ * @public
209
231
  * <p>The unique handle of the model.</p>
210
232
  */
211
233
  ModelHandle?: string;
212
234
  /**
235
+ * @public
213
236
  * <p>The name of the model.</p>
214
237
  */
215
238
  ModelName?: string;
216
239
  /**
240
+ * @public
217
241
  * <p>The version of the model.</p>
218
242
  */
219
243
  ModelVersion?: string;
220
244
  /**
245
+ * @public
221
246
  * <p>The desired state of the model.</p>
222
247
  */
223
248
  DesiredState?: ModelState | string;
224
249
  /**
250
+ * @public
225
251
  * <p>Returns the current state of the model.</p>
226
252
  */
227
253
  State?: ModelState | string;
228
254
  /**
255
+ * @public
229
256
  * <p>Returns the deployment status of the model.</p>
230
257
  */
231
258
  Status?: DeploymentStatus | string;
232
259
  /**
260
+ * @public
233
261
  * <p>Returns the error message for the deployment status result.</p>
234
262
  */
235
263
  StatusReason?: string;
236
264
  /**
265
+ * @public
237
266
  * <p>Returns the error message if there is a rollback.</p>
238
267
  */
239
268
  RollbackFailureReason?: string;
@@ -244,26 +273,32 @@ export interface DeploymentModel {
244
273
  */
245
274
  export interface DeploymentResult {
246
275
  /**
276
+ * @public
247
277
  * <p>The name and unique ID of the deployment.</p>
248
278
  */
249
279
  DeploymentName?: string;
250
280
  /**
281
+ * @public
251
282
  * <p>Returns the bucket error code.</p>
252
283
  */
253
284
  DeploymentStatus?: string;
254
285
  /**
286
+ * @public
255
287
  * <p>Returns the detailed error message.</p>
256
288
  */
257
289
  DeploymentStatusMessage?: string;
258
290
  /**
291
+ * @public
259
292
  * <p>The timestamp of when the deployment was started on the agent.</p>
260
293
  */
261
294
  DeploymentStartTime?: Date;
262
295
  /**
296
+ * @public
263
297
  * <p>The timestamp of when the deployment was ended, and the agent got the deployment results.</p>
264
298
  */
265
299
  DeploymentEndTime?: Date;
266
300
  /**
301
+ * @public
267
302
  * <p>Returns a list of models deployed on the agent.</p>
268
303
  */
269
304
  DeploymentModels?: DeploymentModel[];
@@ -274,22 +309,27 @@ export interface DeploymentResult {
274
309
  */
275
310
  export interface Model {
276
311
  /**
312
+ * @public
277
313
  * <p>The name of the model.</p>
278
314
  */
279
315
  ModelName?: string;
280
316
  /**
317
+ * @public
281
318
  * <p>The version of the model.</p>
282
319
  */
283
320
  ModelVersion?: string;
284
321
  /**
322
+ * @public
285
323
  * <p>The timestamp of the last data sample taken.</p>
286
324
  */
287
325
  LatestSampleTime?: Date;
288
326
  /**
327
+ * @public
289
328
  * <p>The timestamp of the last inference that was made.</p>
290
329
  */
291
330
  LatestInference?: Date;
292
331
  /**
332
+ * @public
293
333
  * <p>Information required for model metrics.</p>
294
334
  */
295
335
  ModelMetrics?: EdgeMetric[];
@@ -299,26 +339,32 @@ export interface Model {
299
339
  */
300
340
  export interface SendHeartbeatRequest {
301
341
  /**
342
+ * @public
302
343
  * <p>For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.</p>
303
344
  */
304
345
  AgentMetrics?: EdgeMetric[];
305
346
  /**
347
+ * @public
306
348
  * <p>Returns a list of models deployed on the the device.</p>
307
349
  */
308
350
  Models?: Model[];
309
351
  /**
352
+ * @public
310
353
  * <p>Returns the version of the agent.</p>
311
354
  */
312
355
  AgentVersion: string | undefined;
313
356
  /**
357
+ * @public
314
358
  * <p>The unique name of the device.</p>
315
359
  */
316
360
  DeviceName: string | undefined;
317
361
  /**
362
+ * @public
318
363
  * <p>The name of the fleet that the device belongs to.</p>
319
364
  */
320
365
  DeviceFleetName: string | undefined;
321
366
  /**
367
+ * @public
322
368
  * <p>Returns the result of a deployment on the device.</p>
323
369
  */
324
370
  DeploymentResult?: DeploymentResult;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sagemaker-edge",
3
3
  "description": "AWS SDK for JavaScript Sagemaker Edge 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",