@aws-sdk/client-iotsecuretunneling 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.
|
@@ -18,10 +18,12 @@ export type ClientMode = (typeof ClientMode)[keyof typeof ClientMode];
|
|
|
18
18
|
*/
|
|
19
19
|
export interface CloseTunnelRequest {
|
|
20
20
|
/**
|
|
21
|
+
* @public
|
|
21
22
|
* <p>The ID of the tunnel to close.</p>
|
|
22
23
|
*/
|
|
23
24
|
tunnelId: string | undefined;
|
|
24
25
|
/**
|
|
26
|
+
* @public
|
|
25
27
|
* <p>When set to true, IoT Secure Tunneling deletes the tunnel data
|
|
26
28
|
* immediately.</p>
|
|
27
29
|
*/
|
|
@@ -62,11 +64,13 @@ export type ConnectionStatus = (typeof ConnectionStatus)[keyof typeof Connection
|
|
|
62
64
|
*/
|
|
63
65
|
export interface ConnectionState {
|
|
64
66
|
/**
|
|
67
|
+
* @public
|
|
65
68
|
* <p>The connection status of the tunnel. Valid values are <code>CONNECTED</code> and
|
|
66
69
|
* <code>DISCONNECTED</code>.</p>
|
|
67
70
|
*/
|
|
68
71
|
status?: ConnectionStatus | string;
|
|
69
72
|
/**
|
|
73
|
+
* @public
|
|
70
74
|
* <p>The last time the connection status was updated.</p>
|
|
71
75
|
*/
|
|
72
76
|
lastUpdatedAt?: Date;
|
|
@@ -76,6 +80,7 @@ export interface ConnectionState {
|
|
|
76
80
|
*/
|
|
77
81
|
export interface DescribeTunnelRequest {
|
|
78
82
|
/**
|
|
83
|
+
* @public
|
|
79
84
|
* <p>The tunnel to describe.</p>
|
|
80
85
|
*/
|
|
81
86
|
tunnelId: string | undefined;
|
|
@@ -86,10 +91,12 @@ export interface DescribeTunnelRequest {
|
|
|
86
91
|
*/
|
|
87
92
|
export interface DestinationConfig {
|
|
88
93
|
/**
|
|
94
|
+
* @public
|
|
89
95
|
* <p>The name of the IoT thing to which you want to connect.</p>
|
|
90
96
|
*/
|
|
91
97
|
thingName?: string;
|
|
92
98
|
/**
|
|
99
|
+
* @public
|
|
93
100
|
* <p>A list of service names that identify the target application. The IoT client
|
|
94
101
|
* running on the destination device reads this value and uses it to look up a port or an
|
|
95
102
|
* IP address and a port. The IoT client instantiates the local proxy, which uses this
|
|
@@ -116,10 +123,12 @@ export type TunnelStatus = (typeof TunnelStatus)[keyof typeof TunnelStatus];
|
|
|
116
123
|
*/
|
|
117
124
|
export interface Tag {
|
|
118
125
|
/**
|
|
126
|
+
* @public
|
|
119
127
|
* <p>The key of the tag.</p>
|
|
120
128
|
*/
|
|
121
129
|
key: string | undefined;
|
|
122
130
|
/**
|
|
131
|
+
* @public
|
|
123
132
|
* <p>The value of the tag.</p>
|
|
124
133
|
*/
|
|
125
134
|
value: string | undefined;
|
|
@@ -130,6 +139,7 @@ export interface Tag {
|
|
|
130
139
|
*/
|
|
131
140
|
export interface TimeoutConfig {
|
|
132
141
|
/**
|
|
142
|
+
* @public
|
|
133
143
|
* <p>The maximum amount of time (in minutes) a tunnel can remain open. If not specified,
|
|
134
144
|
* maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12
|
|
135
145
|
* hours (720 minutes) </p>
|
|
@@ -142,48 +152,59 @@ export interface TimeoutConfig {
|
|
|
142
152
|
*/
|
|
143
153
|
export interface Tunnel {
|
|
144
154
|
/**
|
|
155
|
+
* @public
|
|
145
156
|
* <p>A unique alpha-numeric ID that identifies a tunnel.</p>
|
|
146
157
|
*/
|
|
147
158
|
tunnelId?: string;
|
|
148
159
|
/**
|
|
160
|
+
* @public
|
|
149
161
|
* <p>The Amazon Resource Name (ARN) of a tunnel.</p>
|
|
150
162
|
*/
|
|
151
163
|
tunnelArn?: string;
|
|
152
164
|
/**
|
|
165
|
+
* @public
|
|
153
166
|
* <p>The status of a tunnel. Valid values are: Open and Closed.</p>
|
|
154
167
|
*/
|
|
155
168
|
status?: TunnelStatus | string;
|
|
156
169
|
/**
|
|
170
|
+
* @public
|
|
157
171
|
* <p>The connection state of the source application.</p>
|
|
158
172
|
*/
|
|
159
173
|
sourceConnectionState?: ConnectionState;
|
|
160
174
|
/**
|
|
175
|
+
* @public
|
|
161
176
|
* <p>The connection state of the destination application.</p>
|
|
162
177
|
*/
|
|
163
178
|
destinationConnectionState?: ConnectionState;
|
|
164
179
|
/**
|
|
180
|
+
* @public
|
|
165
181
|
* <p>A description of the tunnel.</p>
|
|
166
182
|
*/
|
|
167
183
|
description?: string;
|
|
168
184
|
/**
|
|
185
|
+
* @public
|
|
169
186
|
* <p>The destination configuration that specifies the thing name of the destination
|
|
170
187
|
* device and a service name that the local proxy uses to connect to the destination
|
|
171
188
|
* application.</p>
|
|
172
189
|
*/
|
|
173
190
|
destinationConfig?: DestinationConfig;
|
|
174
191
|
/**
|
|
192
|
+
* @public
|
|
175
193
|
* <p>Timeout configuration for the tunnel.</p>
|
|
176
194
|
*/
|
|
177
195
|
timeoutConfig?: TimeoutConfig;
|
|
178
196
|
/**
|
|
197
|
+
* @public
|
|
179
198
|
* <p>A list of tag metadata associated with the secure tunnel.</p>
|
|
180
199
|
*/
|
|
181
200
|
tags?: Tag[];
|
|
182
201
|
/**
|
|
202
|
+
* @public
|
|
183
203
|
* <p>The time when the tunnel was created.</p>
|
|
184
204
|
*/
|
|
185
205
|
createdAt?: Date;
|
|
186
206
|
/**
|
|
207
|
+
* @public
|
|
187
208
|
* <p>The last time the tunnel was updated.</p>
|
|
188
209
|
*/
|
|
189
210
|
lastUpdatedAt?: Date;
|
|
@@ -193,6 +214,7 @@ export interface Tunnel {
|
|
|
193
214
|
*/
|
|
194
215
|
export interface DescribeTunnelResponse {
|
|
195
216
|
/**
|
|
217
|
+
* @public
|
|
196
218
|
* <p>The tunnel being described.</p>
|
|
197
219
|
*/
|
|
198
220
|
tunnel?: Tunnel;
|
|
@@ -202,6 +224,7 @@ export interface DescribeTunnelResponse {
|
|
|
202
224
|
*/
|
|
203
225
|
export interface ListTagsForResourceRequest {
|
|
204
226
|
/**
|
|
227
|
+
* @public
|
|
205
228
|
* <p>The resource ARN.</p>
|
|
206
229
|
*/
|
|
207
230
|
resourceArn: string | undefined;
|
|
@@ -211,6 +234,7 @@ export interface ListTagsForResourceRequest {
|
|
|
211
234
|
*/
|
|
212
235
|
export interface ListTagsForResourceResponse {
|
|
213
236
|
/**
|
|
237
|
+
* @public
|
|
214
238
|
* <p>The tags for the specified resource.</p>
|
|
215
239
|
*/
|
|
216
240
|
tags?: Tag[];
|
|
@@ -220,14 +244,17 @@ export interface ListTagsForResourceResponse {
|
|
|
220
244
|
*/
|
|
221
245
|
export interface ListTunnelsRequest {
|
|
222
246
|
/**
|
|
247
|
+
* @public
|
|
223
248
|
* <p>The name of the IoT thing associated with the destination device.</p>
|
|
224
249
|
*/
|
|
225
250
|
thingName?: string;
|
|
226
251
|
/**
|
|
252
|
+
* @public
|
|
227
253
|
* <p>The maximum number of results to return at once.</p>
|
|
228
254
|
*/
|
|
229
255
|
maxResults?: number;
|
|
230
256
|
/**
|
|
257
|
+
* @public
|
|
231
258
|
* <p>To retrieve the next set of results, the nextToken value from a previous response;
|
|
232
259
|
* otherwise null to receive the first set of results.</p>
|
|
233
260
|
*/
|
|
@@ -239,26 +266,32 @@ export interface ListTunnelsRequest {
|
|
|
239
266
|
*/
|
|
240
267
|
export interface TunnelSummary {
|
|
241
268
|
/**
|
|
269
|
+
* @public
|
|
242
270
|
* <p>The unique alpha-numeric identifier for the tunnel.</p>
|
|
243
271
|
*/
|
|
244
272
|
tunnelId?: string;
|
|
245
273
|
/**
|
|
274
|
+
* @public
|
|
246
275
|
* <p>The Amazon Resource Name of the tunnel. </p>
|
|
247
276
|
*/
|
|
248
277
|
tunnelArn?: string;
|
|
249
278
|
/**
|
|
279
|
+
* @public
|
|
250
280
|
* <p>The status of a tunnel. Valid values are: Open and Closed.</p>
|
|
251
281
|
*/
|
|
252
282
|
status?: TunnelStatus | string;
|
|
253
283
|
/**
|
|
284
|
+
* @public
|
|
254
285
|
* <p>A description of the tunnel.</p>
|
|
255
286
|
*/
|
|
256
287
|
description?: string;
|
|
257
288
|
/**
|
|
289
|
+
* @public
|
|
258
290
|
* <p>The time the tunnel was created.</p>
|
|
259
291
|
*/
|
|
260
292
|
createdAt?: Date;
|
|
261
293
|
/**
|
|
294
|
+
* @public
|
|
262
295
|
* <p>The time the tunnel was last updated.</p>
|
|
263
296
|
*/
|
|
264
297
|
lastUpdatedAt?: Date;
|
|
@@ -268,10 +301,12 @@ export interface TunnelSummary {
|
|
|
268
301
|
*/
|
|
269
302
|
export interface ListTunnelsResponse {
|
|
270
303
|
/**
|
|
304
|
+
* @public
|
|
271
305
|
* <p>A short description of the tunnels in an Amazon Web Services account.</p>
|
|
272
306
|
*/
|
|
273
307
|
tunnelSummaries?: TunnelSummary[];
|
|
274
308
|
/**
|
|
309
|
+
* @public
|
|
275
310
|
* <p>The token to use to get the next set of results, or null if there are no additional
|
|
276
311
|
* results.</p>
|
|
277
312
|
*/
|
|
@@ -294,18 +329,22 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
294
329
|
*/
|
|
295
330
|
export interface OpenTunnelRequest {
|
|
296
331
|
/**
|
|
332
|
+
* @public
|
|
297
333
|
* <p>A short text description of the tunnel. </p>
|
|
298
334
|
*/
|
|
299
335
|
description?: string;
|
|
300
336
|
/**
|
|
337
|
+
* @public
|
|
301
338
|
* <p>A collection of tag metadata.</p>
|
|
302
339
|
*/
|
|
303
340
|
tags?: Tag[];
|
|
304
341
|
/**
|
|
342
|
+
* @public
|
|
305
343
|
* <p>The destination configuration for the OpenTunnel request.</p>
|
|
306
344
|
*/
|
|
307
345
|
destinationConfig?: DestinationConfig;
|
|
308
346
|
/**
|
|
347
|
+
* @public
|
|
309
348
|
* <p>Timeout configuration for a tunnel.</p>
|
|
310
349
|
*/
|
|
311
350
|
timeoutConfig?: TimeoutConfig;
|
|
@@ -315,19 +354,23 @@ export interface OpenTunnelRequest {
|
|
|
315
354
|
*/
|
|
316
355
|
export interface OpenTunnelResponse {
|
|
317
356
|
/**
|
|
357
|
+
* @public
|
|
318
358
|
* <p>A unique alpha-numeric tunnel ID.</p>
|
|
319
359
|
*/
|
|
320
360
|
tunnelId?: string;
|
|
321
361
|
/**
|
|
362
|
+
* @public
|
|
322
363
|
* <p>The Amazon Resource Name for the tunnel.</p>
|
|
323
364
|
*/
|
|
324
365
|
tunnelArn?: string;
|
|
325
366
|
/**
|
|
367
|
+
* @public
|
|
326
368
|
* <p>The access token the source local proxy uses to connect to IoT Secure
|
|
327
369
|
* Tunneling.</p>
|
|
328
370
|
*/
|
|
329
371
|
sourceAccessToken?: string;
|
|
330
372
|
/**
|
|
373
|
+
* @public
|
|
331
374
|
* <p>The access token the destination local proxy uses to connect to IoT Secure
|
|
332
375
|
* Tunneling.</p>
|
|
333
376
|
*/
|
|
@@ -338,15 +381,18 @@ export interface OpenTunnelResponse {
|
|
|
338
381
|
*/
|
|
339
382
|
export interface RotateTunnelAccessTokenRequest {
|
|
340
383
|
/**
|
|
384
|
+
* @public
|
|
341
385
|
* <p>The tunnel for which you want to rotate the access tokens.</p>
|
|
342
386
|
*/
|
|
343
387
|
tunnelId: string | undefined;
|
|
344
388
|
/**
|
|
389
|
+
* @public
|
|
345
390
|
* <p>The mode of the client that will use the client token, which can be either the source
|
|
346
391
|
* or destination, or both source and destination.</p>
|
|
347
392
|
*/
|
|
348
393
|
clientMode: ClientMode | string | undefined;
|
|
349
394
|
/**
|
|
395
|
+
* @public
|
|
350
396
|
* <p>The destination configuration.</p>
|
|
351
397
|
*/
|
|
352
398
|
destinationConfig?: DestinationConfig;
|
|
@@ -356,15 +402,18 @@ export interface RotateTunnelAccessTokenRequest {
|
|
|
356
402
|
*/
|
|
357
403
|
export interface RotateTunnelAccessTokenResponse {
|
|
358
404
|
/**
|
|
405
|
+
* @public
|
|
359
406
|
* <p>The Amazon Resource Name for the tunnel.</p>
|
|
360
407
|
*/
|
|
361
408
|
tunnelArn?: string;
|
|
362
409
|
/**
|
|
410
|
+
* @public
|
|
363
411
|
* <p>The client access token that the source local proxy uses to connect to IoT Secure
|
|
364
412
|
* Tunneling.</p>
|
|
365
413
|
*/
|
|
366
414
|
sourceAccessToken?: string;
|
|
367
415
|
/**
|
|
416
|
+
* @public
|
|
368
417
|
* <p>The client access token that the destination local proxy uses to connect to IoT
|
|
369
418
|
* Secure Tunneling.</p>
|
|
370
419
|
*/
|
|
@@ -375,10 +424,12 @@ export interface RotateTunnelAccessTokenResponse {
|
|
|
375
424
|
*/
|
|
376
425
|
export interface TagResourceRequest {
|
|
377
426
|
/**
|
|
427
|
+
* @public
|
|
378
428
|
* <p>The ARN of the resource.</p>
|
|
379
429
|
*/
|
|
380
430
|
resourceArn: string | undefined;
|
|
381
431
|
/**
|
|
432
|
+
* @public
|
|
382
433
|
* <p>The tags for the resource.</p>
|
|
383
434
|
*/
|
|
384
435
|
tags: Tag[] | undefined;
|
|
@@ -393,10 +444,12 @@ export interface TagResourceResponse {
|
|
|
393
444
|
*/
|
|
394
445
|
export interface UntagResourceRequest {
|
|
395
446
|
/**
|
|
447
|
+
* @public
|
|
396
448
|
* <p>The resource ARN.</p>
|
|
397
449
|
*/
|
|
398
450
|
resourceArn: string | undefined;
|
|
399
451
|
/**
|
|
452
|
+
* @public
|
|
400
453
|
* <p>The keys of the tags to remove.</p>
|
|
401
454
|
*/
|
|
402
455
|
tagKeys: string[] | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-iotsecuretunneling",
|
|
3
3
|
"description": "AWS SDK for JavaScript Iotsecuretunneling Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
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.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
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",
|