"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>"
},
"DescribeTunnel":{
"name":"DescribeTunnel",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTunnelRequest"},
"output":{"shape":"DescribeTunnelResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about a tunnel identified by the unique tunnel id.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags for the specified resource.</p>"
},
"ListTunnels":{
"name":"ListTunnels",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTunnelsRequest"},
"output":{"shape":"ListTunnelsResponse"},
"documentation":"<p>List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.</p>"
"documentation":"<p>Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.</p>"
"documentation":"<p>A list of service names that identity the target application. The AWS 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 AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.</p>"
"documentation":"<p>The Amazon Resource Name for the tunnel. The tunnel ARN format is <code>arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id></code> </p>"
},
"sourceAccessToken":{
"shape":"ClientAccessToken",
"documentation":"<p>The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.</p>"
},
"destinationAccessToken":{
"shape":"ClientAccessToken",
"documentation":"<p>The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.</p>"
}
}
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Thrown when an operation is attempted on a resource that does not exist.</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>A unique alpha-numeric ID that identifies a tunnel.</p>"
},
"tunnelArn":{
"shape":"TunnelArn",
"documentation":"<p>The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is <code>arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id></code> </p>"
},
"status":{
"shape":"TunnelStatus",
"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>"
},
"tunnelArn":{
"shape":"TunnelArn",
"documentation":"<p>The Amazon Resource Name of the tunnel. The tunnel ARN format is <code>arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id></code> </p>"
},
"status":{
"shape":"TunnelStatus",
"documentation":"<p>The status of a tunnel. Valid values are: Open and Closed.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>A description of the tunnel.</p>"
},
"createdAt":{
"shape":"DateType",
"documentation":"<p>The time the tunnel was created.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time the tunnel was last updated.</p>"
}
},
"documentation":"<p>Information about the tunnel.</p>"
},
"TunnelSummaryList":{
"type":"list",
"member":{"shape":"TunnelSummary"}
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The resource ARN.</p>"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the tags to remove.</p>"
"documentation":"<fullname>AWS IoT Secure Tunneling</fullname> <p>AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field.</p> <p>For more information about how AWS IoT Secure Tunneling works, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html\">AWS IoT Secure Tunneling</a>.</p>"