Iotsecuretunneling
This page documents function available when using the Iotsecuretunneling module, created with @service Iotsecuretunneling.
Index
Main.Iotsecuretunneling.close_tunnelMain.Iotsecuretunneling.describe_tunnelMain.Iotsecuretunneling.list_tags_for_resourceMain.Iotsecuretunneling.list_tunnelsMain.Iotsecuretunneling.open_tunnelMain.Iotsecuretunneling.tag_resourceMain.Iotsecuretunneling.untag_resource
Documentation
Main.Iotsecuretunneling.close_tunnel — Methodclose_tunnel(tunnel_id)
close_tunnel(tunnel_id, params::Dict{String,<:Any})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.
Arguments
tunnel_id: The ID of the tunnel to close.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"delete": When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.
Main.Iotsecuretunneling.describe_tunnel — Methoddescribe_tunnel(tunnel_id)
describe_tunnel(tunnel_id, params::Dict{String,<:Any})Gets information about a tunnel identified by the unique tunnel id.
Arguments
tunnel_id: The tunnel to describe.
Main.Iotsecuretunneling.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags for the specified resource.
Arguments
resource_arn: The resource ARN.
Main.Iotsecuretunneling.list_tunnels — Methodlist_tunnels()
list_tunnels(params::Dict{String,<:Any})List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return at once."nextToken": A token to retrieve the next set of results."thingName": The name of the IoT thing associated with the destination device.
Main.Iotsecuretunneling.open_tunnel — Methodopen_tunnel()
open_tunnel(params::Dict{String,<:Any})Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": A short text description of the tunnel."destinationConfig": The destination configuration for the OpenTunnel request."tags": A collection of tag metadata."timeoutConfig": Timeout configuration for a tunnel.
Main.Iotsecuretunneling.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})A resource tag.
Arguments
resource_arn: The ARN of the resource.tags: The tags for the resource.
Main.Iotsecuretunneling.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes a tag from a resource.
Arguments
resource_arn: The resource ARN.tag_keys: The keys of the tags to remove.