IoT Secure Tunneling creates remote connections to devices deployed in the field.
For more information about how IoT Secure Tunneling works, see IoT Secure Tunneling.
", "operations": { "CloseTunnel": "Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.
Requires permission to access the CloseTunnel action.
", "DescribeTunnel": "Gets information about a tunnel identified by the unique tunnel id.
Requires permission to access the DescribeTunnel action.
", "ListTagsForResource": "Lists the tags for the specified resource.
", "ListTunnels": "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.
Requires permission to access the ListTunnels action.
", "OpenTunnel": "Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.
Requires permission to access the OpenTunnel action.
", "RotateTunnelAccessToken": "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.
Requires permission to access the RotateTunnelAccessToken action.
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.
A resource tag.
", "UntagResource": "Removes a tag from a resource.
" }, "shapes": { "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The resource ARN.
", "TagResourceRequest$resourceArn": "The ARN of the resource.
", "UntagResourceRequest$resourceArn": "The resource ARN.
" } }, "ClientAccessToken": { "base": null, "refs": { "OpenTunnelResponse$sourceAccessToken": "The access token the source local proxy uses to connect to IoT Secure Tunneling.
", "OpenTunnelResponse$destinationAccessToken": "The access token the destination local proxy uses to connect to IoT Secure Tunneling.
", "RotateTunnelAccessTokenResponse$sourceAccessToken": "The client access token that the source local proxy uses to connect to IoT Secure Tunneling.
", "RotateTunnelAccessTokenResponse$destinationAccessToken": "The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.
" } }, "ClientMode": { "base": null, "refs": { "RotateTunnelAccessTokenRequest$clientMode": "The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.
" } }, "CloseTunnelRequest": { "base": null, "refs": { } }, "CloseTunnelResponse": { "base": null, "refs": { } }, "ConnectionState": { "base": "The state of a connection.
", "refs": { "Tunnel$sourceConnectionState": "The connection state of the source application.
", "Tunnel$destinationConnectionState": "The connection state of the destination application.
" } }, "ConnectionStatus": { "base": null, "refs": { "ConnectionState$status": "The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.
The last time the connection status was updated.
", "Tunnel$createdAt": "The time when the tunnel was created.
", "Tunnel$lastUpdatedAt": "The last time the tunnel was updated.
", "TunnelSummary$createdAt": "The time the tunnel was created.
", "TunnelSummary$lastUpdatedAt": "The time the tunnel was last updated.
" } }, "DeleteFlag": { "base": null, "refs": { "CloseTunnelRequest$delete": "When set to true, IoT Secure Tunneling deletes the tunnel data immediately.
" } }, "DescribeTunnelRequest": { "base": null, "refs": { } }, "DescribeTunnelResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "OpenTunnelRequest$description": "A short text description of the tunnel.
", "Tunnel$description": "A description of the tunnel.
", "TunnelSummary$description": "A description of the tunnel.
" } }, "DestinationConfig": { "base": "The destination configuration.
", "refs": { "OpenTunnelRequest$destinationConfig": "The destination configuration for the OpenTunnel request.
", "RotateTunnelAccessTokenRequest$destinationConfig": null, "Tunnel$destinationConfig": "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.
" } }, "ErrorMessage": { "base": null, "refs": { "LimitExceededException$message": null, "ResourceNotFoundException$message": null } }, "LimitExceededException": { "base": "Thrown when a tunnel limit is exceeded.
", "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListTunnelsRequest": { "base": null, "refs": { } }, "ListTunnelsResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListTunnelsRequest$maxResults": "The maximum number of results to return at once.
" } }, "NextToken": { "base": null, "refs": { "ListTunnelsRequest$nextToken": "To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
", "ListTunnelsResponse$nextToken": "The token to use to get the next set of results, or null if there are no additional results.
" } }, "OpenTunnelRequest": { "base": null, "refs": { } }, "OpenTunnelResponse": { "base": null, "refs": { } }, "ResourceNotFoundException": { "base": "Thrown when an operation is attempted on a resource that does not exist.
", "refs": { } }, "RotateTunnelAccessTokenRequest": { "base": null, "refs": { } }, "RotateTunnelAccessTokenResponse": { "base": null, "refs": { } }, "Service": { "base": null, "refs": { "ServiceList$member": null } }, "ServiceList": { "base": null, "refs": { "DestinationConfig$services": "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.
" } }, "Tag": { "base": "An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The key of the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The keys of the tags to remove.
" } }, "TagList": { "base": null, "refs": { "ListTagsForResourceResponse$tags": "The tags for the specified resource.
", "OpenTunnelRequest$tags": "A collection of tag metadata.
", "TagResourceRequest$tags": "The tags for the resource.
", "Tunnel$tags": "A list of tag metadata associated with the secure tunnel.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The value of the tag.
" } }, "ThingName": { "base": null, "refs": { "DestinationConfig$thingName": "The name of the IoT thing to which you want to connect.
", "ListTunnelsRequest$thingName": "The name of the IoT thing associated with the destination device.
" } }, "TimeoutConfig": { "base": "Tunnel timeout configuration.
", "refs": { "OpenTunnelRequest$timeoutConfig": "Timeout configuration for a tunnel.
", "Tunnel$timeoutConfig": "Timeout configuration for the tunnel.
" } }, "TimeoutInMin": { "base": null, "refs": { "TimeoutConfig$maxLifetimeTimeoutMinutes": "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)
" } }, "Tunnel": { "base": "A connection between a source computer and a destination device.
", "refs": { "DescribeTunnelResponse$tunnel": "The tunnel being described.
" } }, "TunnelArn": { "base": null, "refs": { "OpenTunnelResponse$tunnelArn": "The Amazon Resource Name for the tunnel.
", "RotateTunnelAccessTokenResponse$tunnelArn": "The Amazon Resource Name for the tunnel.
", "Tunnel$tunnelArn": "The Amazon Resource Name (ARN) of a tunnel.
", "TunnelSummary$tunnelArn": "The Amazon Resource Name of the tunnel.
" } }, "TunnelId": { "base": null, "refs": { "CloseTunnelRequest$tunnelId": "The ID of the tunnel to close.
", "DescribeTunnelRequest$tunnelId": "The tunnel to describe.
", "OpenTunnelResponse$tunnelId": "A unique alpha-numeric tunnel ID.
", "RotateTunnelAccessTokenRequest$tunnelId": "The tunnel for which you want to rotate the access tokens.
", "Tunnel$tunnelId": "A unique alpha-numeric ID that identifies a tunnel.
", "TunnelSummary$tunnelId": "The unique alpha-numeric identifier for the tunnel.
" } }, "TunnelStatus": { "base": null, "refs": { "Tunnel$status": "The status of a tunnel. Valid values are: Open and Closed.
", "TunnelSummary$status": "The status of a tunnel. Valid values are: Open and Closed.
" } }, "TunnelSummary": { "base": "Information about the tunnel.
", "refs": { "TunnelSummaryList$member": null } }, "TunnelSummaryList": { "base": null, "refs": { "ListTunnelsResponse$tunnelSummaries": "A short description of the tunnels in an Amazon Web Services account.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } } } }