DescribeTunnel
Gets information about a tunnel identified by the unique tunnel id.
Requires permission to access the DescribeTunnel action.
Request Syntax
{
"tunnelId": "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.
- tunnelId
-
The tunnel to describe.
Type: String
Pattern:
[a-zA-Z0-9_\-+=:]{1,128}
Required: Yes
Response Syntax
{
"tunnel": {
"createdAt": number,
"description": "string",
"destinationConfig": {
"services": [ "string" ],
"thingName": "string"
},
"destinationConnectionState": {
"lastUpdatedAt": number,
"status": "string"
},
"lastUpdatedAt": number,
"sourceConnectionState": {
"lastUpdatedAt": number,
"status": "string"
},
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"timeoutConfig": {
"maxLifetimeTimeoutMinutes": number
},
"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.
Errors
- ResourceNotFoundException
-
Thrown when an operation is attempted on a resource that does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: