View Source aws_iotsecuretunneling (aws v1.0.4)

IoT Secure Tunneling

IoT Secure Tunneling creates remote connections to devices deployed in the field.

For more information about how IoT Secure Tunneling works, see IoT Secure Tunneling: https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html.

Summary

Functions

Closes a tunnel identified by the unique tunnel id.

Gets information about a tunnel identified by the unique tunnel id.

Lists the tags for the specified resource.

List all tunnels for an Amazon Web Services account.

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

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.

A resource tag.
Removes a tag from a resource.

Functions

Link to this function

close_tunnel(Client, Input)

View Source

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: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions action.
Link to this function

close_tunnel(Client, Input, Options)

View Source
Link to this function

describe_tunnel(Client, Input)

View Source

Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions action.
Link to this function

describe_tunnel(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
Lists the tags for the specified resource.
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

list_tunnels(Client, Input)

View Source

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.

Requires permission to access the ListTunnels: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions action.
Link to this function

list_tunnels(Client, Input, Options)

View Source
Link to this function

open_tunnel(Client, Input)

View Source

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

Requires permission to access the OpenTunnel: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions action.
Link to this function

open_tunnel(Client, Input, Options)

View Source
Link to this function

rotate_tunnel_access_token(Client, Input)

View Source

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.

Requires permission to access the RotateTunnelAccessToken: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions action.

Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours.
Link to this function

rotate_tunnel_access_token(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source
A resource tag.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes a tag from a resource.
Link to this function

untag_resource(Client, Input, Options)

View Source