@aws-sdk/client-iotsecuretunneling 3.295.0 → 3.297.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.
@@ -9,6 +9,7 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
9
9
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
10
10
  import { IoTSecureTunnelingClient } from "./IoTSecureTunnelingClient";
11
11
  /**
12
+ * @public
12
13
  * <fullname>IoT Secure Tunneling</fullname>
13
14
  * <p>IoT Secure Tunneling creates remote connections to devices deployed in the
14
15
  * field.</p>
@@ -17,6 +18,7 @@ import { IoTSecureTunnelingClient } from "./IoTSecureTunnelingClient";
17
18
  */
18
19
  export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
19
20
  /**
21
+ * @public
20
22
  * <p>Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code>
21
23
  * request is received, we close the WebSocket connections between the client and proxy
22
24
  * server so no data can be transmitted.</p>
@@ -26,6 +28,7 @@ export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
26
28
  closeTunnel(args: CloseTunnelCommandInput, cb: (err: any, data?: CloseTunnelCommandOutput) => void): void;
27
29
  closeTunnel(args: CloseTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloseTunnelCommandOutput) => void): void;
28
30
  /**
31
+ * @public
29
32
  * <p>Gets information about a tunnel identified by the unique tunnel id.</p>
30
33
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeTunnel</a> action.</p>
31
34
  */
@@ -33,12 +36,14 @@ export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
33
36
  describeTunnel(args: DescribeTunnelCommandInput, cb: (err: any, data?: DescribeTunnelCommandOutput) => void): void;
34
37
  describeTunnel(args: DescribeTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTunnelCommandOutput) => void): void;
35
38
  /**
39
+ * @public
36
40
  * <p>Lists the tags for the specified resource.</p>
37
41
  */
38
42
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
39
43
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
40
44
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
41
45
  /**
46
+ * @public
42
47
  * <p>List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in
43
48
  * descending order, newer tunnels will be listed before older tunnels.</p>
44
49
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTunnels</a> action.</p>
@@ -47,6 +52,7 @@ export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
47
52
  listTunnels(args: ListTunnelsCommandInput, cb: (err: any, data?: ListTunnelsCommandOutput) => void): void;
48
53
  listTunnels(args: ListTunnelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTunnelsCommandOutput) => void): void;
49
54
  /**
55
+ * @public
50
56
  * <p>Creates a new tunnel, and returns two client access tokens for clients to use to
51
57
  * connect to the IoT Secure Tunneling proxy server.</p>
52
58
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">OpenTunnel</a> action.</p>
@@ -55,6 +61,7 @@ export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
55
61
  openTunnel(args: OpenTunnelCommandInput, cb: (err: any, data?: OpenTunnelCommandOutput) => void): void;
56
62
  openTunnel(args: OpenTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OpenTunnelCommandOutput) => void): void;
57
63
  /**
64
+ * @public
58
65
  * <p>Revokes the current client access token (CAT) and returns new CAT for clients to
59
66
  * use when reconnecting to secure tunneling to access the same tunnel.</p>
60
67
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RotateTunnelAccessToken</a> action.</p>
@@ -69,12 +76,14 @@ export declare class IoTSecureTunneling extends IoTSecureTunnelingClient {
69
76
  rotateTunnelAccessToken(args: RotateTunnelAccessTokenCommandInput, cb: (err: any, data?: RotateTunnelAccessTokenCommandOutput) => void): void;
70
77
  rotateTunnelAccessToken(args: RotateTunnelAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateTunnelAccessTokenCommandOutput) => void): void;
71
78
  /**
79
+ * @public
72
80
  * <p>A resource tag.</p>
73
81
  */
74
82
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
75
83
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
76
84
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
77
85
  /**
86
+ * @public
78
87
  * <p>Removes a tag from a resource.</p>
79
88
  */
80
89
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
@@ -16,15 +16,24 @@ import { RotateTunnelAccessTokenCommandInput, RotateTunnelAccessTokenCommandOutp
16
16
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
17
17
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
18
18
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
19
+ /**
20
+ * @public
21
+ */
19
22
  export type ServiceInputTypes = CloseTunnelCommandInput | DescribeTunnelCommandInput | ListTagsForResourceCommandInput | ListTunnelsCommandInput | OpenTunnelCommandInput | RotateTunnelAccessTokenCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
23
+ /**
24
+ * @public
25
+ */
20
26
  export type ServiceOutputTypes = CloseTunnelCommandOutput | DescribeTunnelCommandOutput | ListTagsForResourceCommandOutput | ListTunnelsCommandOutput | OpenTunnelCommandOutput | RotateTunnelAccessTokenCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
27
+ /**
28
+ * @public
29
+ */
21
30
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
22
31
  /**
23
32
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
24
33
  */
25
34
  requestHandler?: __HttpHandler;
26
35
  /**
27
- * A constructor for a class implementing the {@link __Checksum} interface
36
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
28
37
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
29
38
  * @internal
30
39
  */
@@ -114,23 +123,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
114
123
  */
115
124
  logger?: __Logger;
116
125
  /**
117
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
118
127
  */
119
128
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
120
129
  }
130
+ /**
131
+ * @public
132
+ */
121
133
  type IoTSecureTunnelingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
122
134
  /**
123
- * The configuration interface of IoTSecureTunnelingClient class constructor that set the region, credentials and other options.
135
+ * @public
136
+ *
137
+ * The configuration interface of IoTSecureTunnelingClient class constructor that set the region, credentials and other options.
124
138
  */
125
139
  export interface IoTSecureTunnelingClientConfig extends IoTSecureTunnelingClientConfigType {
126
140
  }
141
+ /**
142
+ * @public
143
+ */
127
144
  type IoTSecureTunnelingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
128
145
  /**
129
- * The resolved configuration interface of IoTSecureTunnelingClient class. This is resolved and normalized from the {@link IoTSecureTunnelingClientConfig | constructor configuration interface}.
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of IoTSecureTunnelingClient class. This is resolved and normalized from the {@link IoTSecureTunnelingClientConfig | constructor configuration interface}.
130
149
  */
131
150
  export interface IoTSecureTunnelingClientResolvedConfig extends IoTSecureTunnelingClientResolvedConfigType {
132
151
  }
133
152
  /**
153
+ * @public
134
154
  * <fullname>IoT Secure Tunneling</fullname>
135
155
  * <p>IoT Secure Tunneling creates remote connections to devices deployed in the
136
156
  * field.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { CloseTunnelRequest, CloseTunnelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CloseTunnelCommand}.
8
10
  */
9
11
  export interface CloseTunnelCommandInput extends CloseTunnelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CloseTunnelCommand}.
13
17
  */
14
18
  export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code>
18
23
  * request is received, we close the WebSocket connections between the client and proxy
19
24
  * server so no data can be transmitted.</p>
@@ -28,6 +33,8 @@ export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __Metadat
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CloseTunnelCommandInput - {@link CloseTunnelCommandInput}
37
+ * @returns {@link CloseTunnelCommandOutput}
31
38
  * @see {@link CloseTunnelCommandInput} for command's `input` shape.
32
39
  * @see {@link CloseTunnelCommandOutput} for command's `response` shape.
33
40
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __Metadat
40
47
  export declare class CloseTunnelCommand extends $Command<CloseTunnelCommandInput, CloseTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
41
48
  readonly input: CloseTunnelCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: CloseTunnelCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CloseTunnelCommandInput, CloseTunnelCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { DescribeTunnelRequest, DescribeTunnelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeTunnelCommand}.
8
10
  */
9
11
  export interface DescribeTunnelCommandInput extends DescribeTunnelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeTunnelCommand}.
13
17
  */
14
18
  export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about a tunnel identified by the unique tunnel id.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeTunnel</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeTunnelCommandInput - {@link DescribeTunnelCommandInput}
35
+ * @returns {@link DescribeTunnelCommandOutput}
29
36
  * @see {@link DescribeTunnelCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeTunnelCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __M
38
45
  export declare class DescribeTunnelCommand extends $Command<DescribeTunnelCommandInput, DescribeTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
39
46
  readonly input: DescribeTunnelCommandInput;
40
47
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
48
+ /**
49
+ * @public
50
+ */
41
51
  constructor(input: DescribeTunnelCommandInput);
42
52
  /**
43
53
  * @internal
44
54
  */
45
55
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTunnelCommandInput, DescribeTunnelCommandOutput>;
56
+ /**
57
+ * @internal
58
+ */
46
59
  private serialize;
60
+ /**
61
+ * @internal
62
+ */
47
63
  private deserialize;
48
64
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
37
44
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
38
45
  readonly input: ListTagsForResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: ListTagsForResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { ListTunnelsRequest, ListTunnelsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTunnelsCommand}.
8
10
  */
9
11
  export interface ListTunnelsCommandInput extends ListTunnelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTunnelsCommand}.
13
17
  */
14
18
  export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in
18
23
  * descending order, newer tunnels will be listed before older tunnels.</p>
19
24
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTunnels</a> action.</p>
@@ -27,6 +32,8 @@ export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __Metadat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListTunnelsCommandInput - {@link ListTunnelsCommandInput}
36
+ * @returns {@link ListTunnelsCommandOutput}
30
37
  * @see {@link ListTunnelsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListTunnelsCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -36,11 +43,20 @@ export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __Metadat
36
43
  export declare class ListTunnelsCommand extends $Command<ListTunnelsCommandInput, ListTunnelsCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
37
44
  readonly input: ListTunnelsCommandInput;
38
45
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
46
+ /**
47
+ * @public
48
+ */
39
49
  constructor(input: ListTunnelsCommandInput);
40
50
  /**
41
51
  * @internal
42
52
  */
43
53
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTunnelsCommandInput, ListTunnelsCommandOutput>;
54
+ /**
55
+ * @internal
56
+ */
44
57
  private serialize;
58
+ /**
59
+ * @internal
60
+ */
45
61
  private deserialize;
46
62
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { OpenTunnelRequest, OpenTunnelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link OpenTunnelCommand}.
8
10
  */
9
11
  export interface OpenTunnelCommandInput extends OpenTunnelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link OpenTunnelCommand}.
13
17
  */
14
18
  export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new tunnel, and returns two client access tokens for clients to use to
18
23
  * connect to the IoT Secure Tunneling proxy server.</p>
19
24
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">OpenTunnel</a> action.</p>
@@ -27,6 +32,8 @@ export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataB
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param OpenTunnelCommandInput - {@link OpenTunnelCommandInput}
36
+ * @returns {@link OpenTunnelCommandOutput}
30
37
  * @see {@link OpenTunnelCommandInput} for command's `input` shape.
31
38
  * @see {@link OpenTunnelCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -39,11 +46,20 @@ export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataB
39
46
  export declare class OpenTunnelCommand extends $Command<OpenTunnelCommandInput, OpenTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
40
47
  readonly input: OpenTunnelCommandInput;
41
48
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
49
+ /**
50
+ * @public
51
+ */
42
52
  constructor(input: OpenTunnelCommandInput);
43
53
  /**
44
54
  * @internal
45
55
  */
46
56
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<OpenTunnelCommandInput, OpenTunnelCommandOutput>;
57
+ /**
58
+ * @internal
59
+ */
47
60
  private serialize;
61
+ /**
62
+ * @internal
63
+ */
48
64
  private deserialize;
49
65
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { RotateTunnelAccessTokenRequest, RotateTunnelAccessTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RotateTunnelAccessTokenCommand}.
8
10
  */
9
11
  export interface RotateTunnelAccessTokenCommandInput extends RotateTunnelAccessTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RotateTunnelAccessTokenCommand}.
13
17
  */
14
18
  export interface RotateTunnelAccessTokenCommandOutput extends RotateTunnelAccessTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Revokes the current client access token (CAT) and returns new CAT for clients to
18
23
  * use when reconnecting to secure tunneling to access the same tunnel.</p>
19
24
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">RotateTunnelAccessToken</a> action.</p>
@@ -33,6 +38,8 @@ export interface RotateTunnelAccessTokenCommandOutput extends RotateTunnelAccess
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param RotateTunnelAccessTokenCommandInput - {@link RotateTunnelAccessTokenCommandInput}
42
+ * @returns {@link RotateTunnelAccessTokenCommandOutput}
36
43
  * @see {@link RotateTunnelAccessTokenCommandInput} for command's `input` shape.
37
44
  * @see {@link RotateTunnelAccessTokenCommandOutput} for command's `response` shape.
38
45
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -45,11 +52,20 @@ export interface RotateTunnelAccessTokenCommandOutput extends RotateTunnelAccess
45
52
  export declare class RotateTunnelAccessTokenCommand extends $Command<RotateTunnelAccessTokenCommandInput, RotateTunnelAccessTokenCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
46
53
  readonly input: RotateTunnelAccessTokenCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: RotateTunnelAccessTokenCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RotateTunnelAccessTokenCommandInput, RotateTunnelAccessTokenCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A resource tag.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
37
44
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
38
45
  readonly input: TagResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: TagResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a tag from a resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
37
44
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
38
45
  readonly input: UntagResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: UntagResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from IoTSecureTunneling service.
4
6
  */
5
7
  export declare class IoTSecureTunnelingServiceException extends __ServiceException {
@@ -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,6 +386,9 @@ export interface UntagResourceRequest {
324
386
  */
325
387
  tagKeys: string[] | undefined;
326
388
  }
389
+ /**
390
+ * @public
391
+ */
327
392
  export interface UntagResourceResponse {
328
393
  }
329
394
  /**
@@ -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>;
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.295.0",
4
+ "version": "3.297.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",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },