IoTSecureTunneling / Client / close_tunnel

close_tunnel#

IoTSecureTunneling.Client.close_tunnel(**kwargs)#

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Requires permission to access the CloseTunnel action.

See also: AWS API Documentation

Request Syntax

response = client.close_tunnel(
    tunnelId='string',
    delete=True|False
)
Parameters:

  • tunnelId (string) –

    [REQUIRED]

    The ID of the tunnel to close.

  • delete (boolean) – When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoTSecureTunneling.Client.exceptions.ResourceNotFoundException