"documentation":"<p>Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code> request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">CloseTunnel</a> action.</p>"
"documentation":"<p>Gets information about a tunnel identified by the unique tunnel id.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">DescribeTunnel</a> action.</p>"
"documentation":"<p>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.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListTunnels</a> action.</p>"
"documentation":"<p>Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">OpenTunnel</a> action.</p>"
"documentation":"<p>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.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">RotateTunnelAccessToken</a> action.</p> <note> <p>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.</p> </note>"
"documentation":"<p>A list of service names that identify the target application. The IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The IoT client instantiates the local proxy, which uses this information to connect to the destination application.</p>"
"documentation":"<p>To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.</p>"
"documentation":"<p>The tunnel for which you want to rotate the access tokens.</p>"
},
"clientMode":{
"shape":"ClientMode",
"documentation":"<p>The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.</p>"
},
"destinationConfig":{"shape":"DestinationConfig"}
}
},
"RotateTunnelAccessTokenResponse":{
"type":"structure",
"members":{
"tunnelArn":{
"shape":"TunnelArn",
"documentation":"<p>The Amazon Resource Name for the tunnel.</p>"
},
"sourceAccessToken":{
"shape":"ClientAccessToken",
"documentation":"<p>The client access token that the source local proxy uses to connect to IoT Secure Tunneling.</p>"
},
"destinationAccessToken":{
"shape":"ClientAccessToken",
"documentation":"<p>The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.</p>"
"documentation":"<p>An arbitary key/value pair used to add searchable metadata to secure tunnel resources.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the resource.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"ThingName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"TimeoutConfig":{
"type":"structure",
"members":{
"maxLifetimeTimeoutMinutes":{
"shape":"TimeoutInMin",
"documentation":"<p>The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes) </p>",
"documentation":"<p>The status of a tunnel. Valid values are: Open and Closed.</p>"
},
"sourceConnectionState":{
"shape":"ConnectionState",
"documentation":"<p>The connection state of the source application.</p>"
},
"destinationConnectionState":{
"shape":"ConnectionState",
"documentation":"<p>The connection state of the destination application.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the tunnel.</p>"
},
"destinationConfig":{
"shape":"DestinationConfig",
"documentation":"<p>The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.</p>"
},
"timeoutConfig":{
"shape":"TimeoutConfig",
"documentation":"<p>Timeout configuration for the tunnel.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>A list of tag metadata associated with the secure tunnel.</p>"
},
"createdAt":{
"shape":"DateType",
"documentation":"<p>The time when the tunnel was created.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The last time the tunnel was updated.</p>"
}
},
"documentation":"<p>A connection between a source computer and a destination device.</p>"
},
"TunnelArn":{
"type":"string",
"max":1600,
"min":1
},
"TunnelId":{
"type":"string",
"pattern":"[a-zA-Z0-9_\\-+=:]{1,128}"
},
"TunnelStatus":{
"type":"string",
"enum":[
"OPEN",
"CLOSED"
]
},
"TunnelSummary":{
"type":"structure",
"members":{
"tunnelId":{
"shape":"TunnelId",
"documentation":"<p>The unique alpha-numeric identifier for the tunnel.</p>"
"documentation":"<fullname>IoT Secure Tunneling</fullname> <p>IoT Secure Tunneling creates remote connections to devices deployed in the field.</p> <p>For more information about how IoT Secure Tunneling works, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html\">IoT Secure Tunneling</a>.</p>"