@aws-sdk/client-iotsecuretunneling 3.296.0 → 3.298.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 (34) hide show
  1. package/dist-cjs/commands/CloseTunnelCommand.js +2 -3
  2. package/dist-cjs/commands/DescribeTunnelCommand.js +2 -3
  3. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  4. package/dist-cjs/commands/ListTunnelsCommand.js +2 -3
  5. package/dist-cjs/commands/OpenTunnelCommand.js +1 -1
  6. package/dist-cjs/commands/RotateTunnelAccessTokenCommand.js +1 -1
  7. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  8. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  9. package/dist-cjs/models/models_0.js +1 -81
  10. package/dist-es/commands/CloseTunnelCommand.js +2 -3
  11. package/dist-es/commands/DescribeTunnelCommand.js +2 -3
  12. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  13. package/dist-es/commands/ListTunnelsCommand.js +2 -3
  14. package/dist-es/commands/OpenTunnelCommand.js +2 -2
  15. package/dist-es/commands/RotateTunnelAccessTokenCommand.js +2 -2
  16. package/dist-es/commands/TagResourceCommand.js +2 -3
  17. package/dist-es/commands/UntagResourceCommand.js +2 -3
  18. package/dist-es/models/models_0.js +0 -60
  19. package/dist-types/IoTSecureTunneling.d.ts +9 -0
  20. package/dist-types/IoTSecureTunnelingClient.d.ts +24 -4
  21. package/dist-types/commands/CloseTunnelCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeTunnelCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/ListTunnelsCommand.d.ts +16 -0
  25. package/dist-types/commands/OpenTunnelCommand.d.ts +16 -0
  26. package/dist-types/commands/RotateTunnelAccessTokenCommand.d.ts +16 -0
  27. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  28. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  29. package/dist-types/models/IoTSecureTunnelingServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +65 -80
  31. package/dist-types/pagination/Interfaces.d.ts +3 -0
  32. package/dist-types/pagination/ListTunnelsPaginator.d.ts +3 -0
  33. package/dist-types/ts3.4/models/models_0.d.ts +0 -56
  34. package/package.json +4 -3
@@ -1,10 +1,16 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { IoTSecureTunnelingServiceException as __BaseException } from "./IoTSecureTunnelingServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum ClientMode {
4
7
  ALL = "ALL",
5
8
  DESTINATION = "DESTINATION",
6
9
  SOURCE = "SOURCE"
7
10
  }
11
+ /**
12
+ * @public
13
+ */
8
14
  export interface CloseTunnelRequest {
9
15
  /**
10
16
  * <p>The ID of the tunnel to close.</p>
@@ -16,9 +22,13 @@ export interface CloseTunnelRequest {
16
22
  */
17
23
  delete?: boolean;
18
24
  }
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface CloseTunnelResponse {
20
29
  }
21
30
  /**
31
+ * @public
22
32
  * <p>Thrown when an operation is attempted on a resource that does not exist.</p>
23
33
  */
24
34
  export declare class ResourceNotFoundException extends __BaseException {
@@ -29,11 +39,15 @@ export declare class ResourceNotFoundException extends __BaseException {
29
39
  */
30
40
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
31
41
  }
42
+ /**
43
+ * @public
44
+ */
32
45
  export declare enum ConnectionStatus {
33
46
  CONNECTED = "CONNECTED",
34
47
  DISCONNECTED = "DISCONNECTED"
35
48
  }
36
49
  /**
50
+ * @public
37
51
  * <p>The state of a connection.</p>
38
52
  */
39
53
  export interface ConnectionState {
@@ -47,6 +61,9 @@ export interface ConnectionState {
47
61
  */
48
62
  lastUpdatedAt?: Date;
49
63
  }
64
+ /**
65
+ * @public
66
+ */
50
67
  export interface DescribeTunnelRequest {
51
68
  /**
52
69
  * <p>The tunnel to describe.</p>
@@ -54,6 +71,7 @@ export interface DescribeTunnelRequest {
54
71
  tunnelId: string | undefined;
55
72
  }
56
73
  /**
74
+ * @public
57
75
  * <p>The destination configuration.</p>
58
76
  */
59
77
  export interface DestinationConfig {
@@ -69,11 +87,15 @@ export interface DestinationConfig {
69
87
  */
70
88
  services: string[] | undefined;
71
89
  }
90
+ /**
91
+ * @public
92
+ */
72
93
  export declare enum TunnelStatus {
73
94
  CLOSED = "CLOSED",
74
95
  OPEN = "OPEN"
75
96
  }
76
97
  /**
98
+ * @public
77
99
  * <p>An arbitary key/value pair used to add searchable metadata to secure tunnel
78
100
  * resources.</p>
79
101
  */
@@ -88,6 +110,7 @@ export interface Tag {
88
110
  value: string | undefined;
89
111
  }
90
112
  /**
113
+ * @public
91
114
  * <p>Tunnel timeout configuration.</p>
92
115
  */
93
116
  export interface TimeoutConfig {
@@ -99,6 +122,7 @@ export interface TimeoutConfig {
99
122
  maxLifetimeTimeoutMinutes?: number;
100
123
  }
101
124
  /**
125
+ * @public
102
126
  * <p>A connection between a source computer and a destination device.</p>
103
127
  */
104
128
  export interface Tunnel {
@@ -149,24 +173,36 @@ export interface Tunnel {
149
173
  */
150
174
  lastUpdatedAt?: Date;
151
175
  }
176
+ /**
177
+ * @public
178
+ */
152
179
  export interface DescribeTunnelResponse {
153
180
  /**
154
181
  * <p>The tunnel being described.</p>
155
182
  */
156
183
  tunnel?: Tunnel;
157
184
  }
185
+ /**
186
+ * @public
187
+ */
158
188
  export interface ListTagsForResourceRequest {
159
189
  /**
160
190
  * <p>The resource ARN.</p>
161
191
  */
162
192
  resourceArn: string | undefined;
163
193
  }
194
+ /**
195
+ * @public
196
+ */
164
197
  export interface ListTagsForResourceResponse {
165
198
  /**
166
199
  * <p>The tags for the specified resource.</p>
167
200
  */
168
201
  tags?: Tag[];
169
202
  }
203
+ /**
204
+ * @public
205
+ */
170
206
  export interface ListTunnelsRequest {
171
207
  /**
172
208
  * <p>The name of the IoT thing associated with the destination device.</p>
@@ -183,6 +219,7 @@ export interface ListTunnelsRequest {
183
219
  nextToken?: string;
184
220
  }
185
221
  /**
222
+ * @public
186
223
  * <p>Information about the tunnel.</p>
187
224
  */
188
225
  export interface TunnelSummary {
@@ -211,6 +248,9 @@ export interface TunnelSummary {
211
248
  */
212
249
  lastUpdatedAt?: Date;
213
250
  }
251
+ /**
252
+ * @public
253
+ */
214
254
  export interface ListTunnelsResponse {
215
255
  /**
216
256
  * <p>A short description of the tunnels in an Amazon Web Services account.</p>
@@ -223,6 +263,7 @@ export interface ListTunnelsResponse {
223
263
  nextToken?: string;
224
264
  }
225
265
  /**
266
+ * @public
226
267
  * <p>Thrown when a tunnel limit is exceeded.</p>
227
268
  */
228
269
  export declare class LimitExceededException extends __BaseException {
@@ -233,6 +274,9 @@ export declare class LimitExceededException extends __BaseException {
233
274
  */
234
275
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
235
276
  }
277
+ /**
278
+ * @public
279
+ */
236
280
  export interface OpenTunnelRequest {
237
281
  /**
238
282
  * <p>A short text description of the tunnel. </p>
@@ -251,6 +295,9 @@ export interface OpenTunnelRequest {
251
295
  */
252
296
  timeoutConfig?: TimeoutConfig;
253
297
  }
298
+ /**
299
+ * @public
300
+ */
254
301
  export interface OpenTunnelResponse {
255
302
  /**
256
303
  * <p>A unique alpha-numeric tunnel ID.</p>
@@ -271,6 +318,9 @@ export interface OpenTunnelResponse {
271
318
  */
272
319
  destinationAccessToken?: string;
273
320
  }
321
+ /**
322
+ * @public
323
+ */
274
324
  export interface RotateTunnelAccessTokenRequest {
275
325
  /**
276
326
  * <p>The tunnel for which you want to rotate the access tokens.</p>
@@ -286,6 +336,9 @@ export interface RotateTunnelAccessTokenRequest {
286
336
  */
287
337
  destinationConfig?: DestinationConfig;
288
338
  }
339
+ /**
340
+ * @public
341
+ */
289
342
  export interface RotateTunnelAccessTokenResponse {
290
343
  /**
291
344
  * <p>The Amazon Resource Name for the tunnel.</p>
@@ -302,6 +355,9 @@ export interface RotateTunnelAccessTokenResponse {
302
355
  */
303
356
  destinationAccessToken?: string;
304
357
  }
358
+ /**
359
+ * @public
360
+ */
305
361
  export interface TagResourceRequest {
306
362
  /**
307
363
  * <p>The ARN of the resource.</p>
@@ -312,8 +368,14 @@ export interface TagResourceRequest {
312
368
  */
313
369
  tags: Tag[] | undefined;
314
370
  }
371
+ /**
372
+ * @public
373
+ */
315
374
  export interface TagResourceResponse {
316
375
  }
376
+ /**
377
+ * @public
378
+ */
317
379
  export interface UntagResourceRequest {
318
380
  /**
319
381
  * <p>The resource ARN.</p>
@@ -324,93 +386,16 @@ export interface UntagResourceRequest {
324
386
  */
325
387
  tagKeys: string[] | undefined;
326
388
  }
327
- export interface UntagResourceResponse {
328
- }
329
- /**
330
- * @internal
331
- */
332
- export declare const CloseTunnelRequestFilterSensitiveLog: (obj: CloseTunnelRequest) => any;
333
- /**
334
- * @internal
335
- */
336
- export declare const CloseTunnelResponseFilterSensitiveLog: (obj: CloseTunnelResponse) => any;
337
- /**
338
- * @internal
339
- */
340
- export declare const ConnectionStateFilterSensitiveLog: (obj: ConnectionState) => any;
341
- /**
342
- * @internal
343
- */
344
- export declare const DescribeTunnelRequestFilterSensitiveLog: (obj: DescribeTunnelRequest) => any;
345
389
  /**
346
- * @internal
390
+ * @public
347
391
  */
348
- export declare const DestinationConfigFilterSensitiveLog: (obj: DestinationConfig) => any;
349
- /**
350
- * @internal
351
- */
352
- export declare const TagFilterSensitiveLog: (obj: Tag) => any;
353
- /**
354
- * @internal
355
- */
356
- export declare const TimeoutConfigFilterSensitiveLog: (obj: TimeoutConfig) => any;
357
- /**
358
- * @internal
359
- */
360
- export declare const TunnelFilterSensitiveLog: (obj: Tunnel) => any;
361
- /**
362
- * @internal
363
- */
364
- export declare const DescribeTunnelResponseFilterSensitiveLog: (obj: DescribeTunnelResponse) => any;
365
- /**
366
- * @internal
367
- */
368
- export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
369
- /**
370
- * @internal
371
- */
372
- export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
373
- /**
374
- * @internal
375
- */
376
- export declare const ListTunnelsRequestFilterSensitiveLog: (obj: ListTunnelsRequest) => any;
377
- /**
378
- * @internal
379
- */
380
- export declare const TunnelSummaryFilterSensitiveLog: (obj: TunnelSummary) => any;
381
- /**
382
- * @internal
383
- */
384
- export declare const ListTunnelsResponseFilterSensitiveLog: (obj: ListTunnelsResponse) => any;
385
- /**
386
- * @internal
387
- */
388
- export declare const OpenTunnelRequestFilterSensitiveLog: (obj: OpenTunnelRequest) => any;
392
+ export interface UntagResourceResponse {
393
+ }
389
394
  /**
390
395
  * @internal
391
396
  */
392
397
  export declare const OpenTunnelResponseFilterSensitiveLog: (obj: OpenTunnelResponse) => any;
393
- /**
394
- * @internal
395
- */
396
- export declare const RotateTunnelAccessTokenRequestFilterSensitiveLog: (obj: RotateTunnelAccessTokenRequest) => any;
397
398
  /**
398
399
  * @internal
399
400
  */
400
401
  export declare const RotateTunnelAccessTokenResponseFilterSensitiveLog: (obj: RotateTunnelAccessTokenResponse) => any;
401
- /**
402
- * @internal
403
- */
404
- export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
405
- /**
406
- * @internal
407
- */
408
- export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
409
- /**
410
- * @internal
411
- */
412
- export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
413
- /**
414
- * @internal
415
- */
416
- export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { IoTSecureTunnelingClient } from "../IoTSecureTunnelingClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface IoTSecureTunnelingPaginationConfiguration extends PaginationConfiguration {
4
7
  client: IoTSecureTunnelingClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListTunnelsCommandInput, ListTunnelsCommandOutput } from "../commands/ListTunnelsCommand";
3
3
  import { IoTSecureTunnelingPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListTunnels(config: IoTSecureTunnelingPaginationConfiguration, input: ListTunnelsCommandInput, ...additionalArguments: any): Paginator<ListTunnelsCommandOutput>;
@@ -121,65 +121,9 @@ export interface UntagResourceRequest {
121
121
  tagKeys: string[] | undefined;
122
122
  }
123
123
  export interface UntagResourceResponse {}
124
- export declare const CloseTunnelRequestFilterSensitiveLog: (
125
- obj: CloseTunnelRequest
126
- ) => any;
127
- export declare const CloseTunnelResponseFilterSensitiveLog: (
128
- obj: CloseTunnelResponse
129
- ) => any;
130
- export declare const ConnectionStateFilterSensitiveLog: (
131
- obj: ConnectionState
132
- ) => any;
133
- export declare const DescribeTunnelRequestFilterSensitiveLog: (
134
- obj: DescribeTunnelRequest
135
- ) => any;
136
- export declare const DestinationConfigFilterSensitiveLog: (
137
- obj: DestinationConfig
138
- ) => any;
139
- export declare const TagFilterSensitiveLog: (obj: Tag) => any;
140
- export declare const TimeoutConfigFilterSensitiveLog: (
141
- obj: TimeoutConfig
142
- ) => any;
143
- export declare const TunnelFilterSensitiveLog: (obj: Tunnel) => any;
144
- export declare const DescribeTunnelResponseFilterSensitiveLog: (
145
- obj: DescribeTunnelResponse
146
- ) => any;
147
- export declare const ListTagsForResourceRequestFilterSensitiveLog: (
148
- obj: ListTagsForResourceRequest
149
- ) => any;
150
- export declare const ListTagsForResourceResponseFilterSensitiveLog: (
151
- obj: ListTagsForResourceResponse
152
- ) => any;
153
- export declare const ListTunnelsRequestFilterSensitiveLog: (
154
- obj: ListTunnelsRequest
155
- ) => any;
156
- export declare const TunnelSummaryFilterSensitiveLog: (
157
- obj: TunnelSummary
158
- ) => any;
159
- export declare const ListTunnelsResponseFilterSensitiveLog: (
160
- obj: ListTunnelsResponse
161
- ) => any;
162
- export declare const OpenTunnelRequestFilterSensitiveLog: (
163
- obj: OpenTunnelRequest
164
- ) => any;
165
124
  export declare const OpenTunnelResponseFilterSensitiveLog: (
166
125
  obj: OpenTunnelResponse
167
126
  ) => any;
168
- export declare const RotateTunnelAccessTokenRequestFilterSensitiveLog: (
169
- obj: RotateTunnelAccessTokenRequest
170
- ) => any;
171
127
  export declare const RotateTunnelAccessTokenResponseFilterSensitiveLog: (
172
128
  obj: RotateTunnelAccessTokenResponse
173
129
  ) => any;
174
- export declare const TagResourceRequestFilterSensitiveLog: (
175
- obj: TagResourceRequest
176
- ) => any;
177
- export declare const TagResourceResponseFilterSensitiveLog: (
178
- obj: TagResourceResponse
179
- ) => any;
180
- export declare const UntagResourceRequestFilterSensitiveLog: (
181
- obj: UntagResourceRequest
182
- ) => any;
183
- export declare const UntagResourceResponseFilterSensitiveLog: (
184
- obj: UntagResourceResponse
185
- ) => any;
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.296.0",
4
+ "version": "3.298.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",
@@ -11,6 +11,7 @@
11
11
  "build:types": "tsc -p tsconfig.types.json",
12
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
13
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
14
+ "extract:docs": "api-extractor run --local",
14
15
  "generate:client": "node ../../scripts/generate-clients/single-service --solo iotsecuretunneling"
15
16
  },
16
17
  "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
20
21
  "dependencies": {
21
22
  "@aws-crypto/sha256-browser": "3.0.0",
22
23
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/client-sts": "3.298.0",
24
25
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.298.0",
26
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
28
  "@aws-sdk/hash-node": "3.296.0",
28
29
  "@aws-sdk/invalid-dependency": "3.296.0",