List all tunnels for an AWS 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.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"thingName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of results to return at once.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Type: String
Pattern:
[a-zA-Z0-9_=-]{1,4096}Required: No
- thingName
-
The name of the IoT thing associated with the destination device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: No
Response Syntax
{
"nextToken": "string",
"tunnelSummaries": [
{
"createdAt": number,
"description": "string",
"lastUpdatedAt": number,
"status": "string",
"tunnelArn": "string",
"tunnelId": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The token to use to get the next set of results, or null if there are no additional results.
Type: String
Pattern:
[a-zA-Z0-9_=-]{1,4096} - tunnelSummaries
-
A short description of the tunnels in an AWS account.
Type: Array of TunnelSummary objects
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
