[ aws . iotsecuretunneling ]

list-tunnels

Description

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-tunnels
[--thing-name <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--thing-name (string)

The name of the IoT thing associated with the destination device.

--max-results (integer)

The maximum number of results to return at once.

--next-token (string)

A token to retrieve the next set of results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

tunnelSummaries -> (list)

A short description of the tunnels in an AWS account.

(structure)

Information about the tunnel.

tunnelId -> (string)

The unique alpha-numeric identifier for the tunnel.

tunnelArn -> (string)

The Amazon Resource Name of the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

status -> (string)

The status of a tunnel. Valid values are: Open and Closed.

description -> (string)

A description of the tunnel.

createdAt -> (timestamp)

The time the tunnel was created.

lastUpdatedAt -> (timestamp)

The time the tunnel was last updated.

nextToken -> (string)

A token to used to retrieve the next set of results.