Edit on GitHub

Iotsecuretunneling

This page documents function available when using the Iotsecuretunneling module, created with @service Iotsecuretunneling.

Index

Documentation

Main.Iotsecuretunneling.close_tunnel — Method
close_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. Requires permission to access the CloseTunnel action.

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, IoT Secure Tunneling deletes the tunnel data immediately.
source
Main.Iotsecuretunneling.describe_tunnel — Method
describe_tunnel(tunnel_id)
describe_tunnel(tunnel_id, params::Dict{String,<:Any})

Gets information about a tunnel identified by the unique tunnel id. Requires permission to access the DescribeTunnel action.

Arguments

  • tunnel_id: The tunnel to describe.
source
Main.Iotsecuretunneling.list_tunnels — Method
list_tunnels()
list_tunnels(params::Dict{String,<:Any})

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 action.

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": To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • "thingName": The name of the IoT thing associated with the destination device.
source
Main.Iotsecuretunneling.open_tunnel — Method
open_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 IoT Secure Tunneling proxy server. Requires permission to access the OpenTunnel action.

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.
source
Main.Iotsecuretunneling.rotate_tunnel_access_token — Method
rotate_tunnel_access_token(client_mode, tunnel_id)
rotate_tunnel_access_token(client_mode, tunnel_id, params::Dict{String,<:Any})

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 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.

Arguments

  • client_mode: The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.
  • tunnel_id: The tunnel for which you want to rotate the access tokens.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "destinationConfig":
source
Main.Iotsecuretunneling.tag_resource — Method
tag_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.
source
Main.Iotsecuretunneling.untag_resource — Method
untag_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.
source