@aws-sdk/client-iotsecuretunneling 3.296.0 → 3.298.0

package/dist-types/commands/CloseTunnelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { CloseTunnelRequest, CloseTunnelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CloseTunnelCommand}.
  */
 export interface CloseTunnelCommandInput extends CloseTunnelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CloseTunnelCommand}.
  */
 export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code>
  * 			request is received, we close the WebSocket connections between the client and proxy
  * 			server so no data can be transmitted.</p>
@@ -28,6 +33,8 @@ export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param CloseTunnelCommandInput - {@link CloseTunnelCommandInput}
+ * @returns {@link CloseTunnelCommandOutput}
  * @see {@link CloseTunnelCommandInput} for command's `input` shape.
  * @see {@link CloseTunnelCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __Metadat
 export declare class CloseTunnelCommand extends $Command<CloseTunnelCommandInput, CloseTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: CloseTunnelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CloseTunnelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CloseTunnelCommandInput, CloseTunnelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeTunnelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { DescribeTunnelRequest, DescribeTunnelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeTunnelCommand}.
  */
 export interface DescribeTunnelCommandInput extends DescribeTunnelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeTunnelCommand}.
  */
 export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets information about a tunnel identified by the unique tunnel id.</p>
  * 		       <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>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeTunnelCommandInput - {@link DescribeTunnelCommandInput}
+ * @returns {@link DescribeTunnelCommandOutput}
  * @see {@link DescribeTunnelCommandInput} for command's `input` shape.
  * @see {@link DescribeTunnelCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -38,11 +45,20 @@ export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __M
 export declare class DescribeTunnelCommand extends $Command<DescribeTunnelCommandInput, DescribeTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: DescribeTunnelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeTunnelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTunnelCommandInput, DescribeTunnelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the tags for the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTunnelsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { ListTunnelsRequest, ListTunnelsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTunnelsCommand}.
  */
 export interface ListTunnelsCommandInput extends ListTunnelsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTunnelsCommand}.
  */
 export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in
  * 			descending order, newer tunnels will be listed before older tunnels.</p>
  * 		       <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
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTunnelsCommandInput - {@link ListTunnelsCommandInput}
+ * @returns {@link ListTunnelsCommandOutput}
  * @see {@link ListTunnelsCommandInput} for command's `input` shape.
  * @see {@link ListTunnelsCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -36,11 +43,20 @@ export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __Metadat
 export declare class ListTunnelsCommand extends $Command<ListTunnelsCommandInput, ListTunnelsCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: ListTunnelsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTunnelsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTunnelsCommandInput, ListTunnelsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/OpenTunnelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { OpenTunnelRequest, OpenTunnelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link OpenTunnelCommand}.
  */
 export interface OpenTunnelCommandInput extends OpenTunnelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link OpenTunnelCommand}.
  */
 export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new tunnel, and returns two client access tokens for clients to use to
  * 			connect to the IoT Secure Tunneling proxy server.</p>
  * 		       <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
  * const response = await client.send(command);
  * ```
  *
+ * @param OpenTunnelCommandInput - {@link OpenTunnelCommandInput}
+ * @returns {@link OpenTunnelCommandOutput}
  * @see {@link OpenTunnelCommandInput} for command's `input` shape.
  * @see {@link OpenTunnelCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -39,11 +46,20 @@ export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataB
 export declare class OpenTunnelCommand extends $Command<OpenTunnelCommandInput, OpenTunnelCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: OpenTunnelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: OpenTunnelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<OpenTunnelCommandInput, OpenTunnelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RotateTunnelAccessTokenCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { RotateTunnelAccessTokenRequest, RotateTunnelAccessTokenResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RotateTunnelAccessTokenCommand}.
  */
 export interface RotateTunnelAccessTokenCommandInput extends RotateTunnelAccessTokenRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RotateTunnelAccessTokenCommand}.
  */
 export interface RotateTunnelAccessTokenCommandOutput extends RotateTunnelAccessTokenResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Revokes the current client access token (CAT) and returns new CAT for clients to
  * 			use when reconnecting to secure tunneling to access the same tunnel.</p>
  * 		       <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
  * const response = await client.send(command);
  * ```
  *
+ * @param RotateTunnelAccessTokenCommandInput - {@link RotateTunnelAccessTokenCommandInput}
+ * @returns {@link RotateTunnelAccessTokenCommandOutput}
  * @see {@link RotateTunnelAccessTokenCommandInput} for command's `input` shape.
  * @see {@link RotateTunnelAccessTokenCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -45,11 +52,20 @@ export interface RotateTunnelAccessTokenCommandOutput extends RotateTunnelAccess
 export declare class RotateTunnelAccessTokenCommand extends $Command<RotateTunnelAccessTokenCommandInput, RotateTunnelAccessTokenCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: RotateTunnelAccessTokenCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RotateTunnelAccessTokenCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RotateTunnelAccessTokenCommandInput, RotateTunnelAccessTokenCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>A resource tag.</p>
  * @example
  * 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
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTSecureTunnelingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSecureTunnelingClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a tag from a resource.</p>
  * @example
  * 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
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for IoTSecureTunnelingClient's `config` shape.
@@ -37,11 +44,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTSecureTunnelingClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSecureTunnelingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/IoTSecureTunnelingServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from IoTSecureTunneling service.
  */
 export declare class IoTSecureTunnelingServiceException extends __ServiceException {