@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIoTSecureTunneling extends Object implements AWSIoTSecureTunneling
AWSIoTSecureTunneling. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX | Modifier and Type | Method and Description |
|---|---|
CloseTunnelResult |
closeTunnel (CloseTunnelRequest request)
Closes a tunnel identified by the unique tunnel id.
|
DescribeTunnelResult |
describeTunnel (DescribeTunnelRequest request)
Gets information about a tunnel identified by the unique tunnel id.
|
ResponseMetadata |
getCachedResponseMetadata (AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest request)
Lists the tags for the specified resource.
|
ListTunnelsResult |
listTunnels (ListTunnelsRequest request)
List all tunnels for an Amazon Web Services account.
|
OpenTunnelResult |
openTunnel (OpenTunnelRequest request)
Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure
Tunneling proxy server.
|
RotateTunnelAccessTokenResult |
rotateTunnelAccessToken (RotateTunnelAccessTokenRequest request)
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.
|
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource (TagResourceRequest request)
A resource tag.
|
UntagResourceResult |
untagResource (UntagResourceRequest request)
Removes a tag from a resource.
|
public CloseTunnelResult closeTunnel(CloseTunnelRequest request)
AWSIoTSecureTunneling
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.
closeTunnel in interface AWSIoTSecureTunneling public DescribeTunnelResult describeTunnel(DescribeTunnelRequest request)
AWSIoTSecureTunneling Gets information about a tunnel identified by the unique tunnel id.
Requires permission to access the DescribeTunnel action.
describeTunnel in interface AWSIoTSecureTunneling public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIoTSecureTunneling Lists the tags for the specified resource.
listTagsForResource in interface AWSIoTSecureTunneling public ListTunnelsResult listTunnels(ListTunnelsRequest request)
AWSIoTSecureTunneling 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.
listTunnels in interface AWSIoTSecureTunneling public OpenTunnelResult openTunnel(OpenTunnelRequest request)
AWSIoTSecureTunneling 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.
openTunnel in interface AWSIoTSecureTunneling public RotateTunnelAccessTokenResult rotateTunnelAccessToken(RotateTunnelAccessTokenRequest request)
AWSIoTSecureTunneling 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.
rotateTunnelAccessToken in interface AWSIoTSecureTunneling public TagResourceResult tagResource(TagResourceRequest request)
AWSIoTSecureTunneling A resource tag.
tagResource in interface AWSIoTSecureTunneling public UntagResourceResult untagResource(UntagResourceRequest request)
AWSIoTSecureTunneling Removes a tag from a resource.
untagResource in interface AWSIoTSecureTunneling public void shutdown()
AWSIoTSecureTunneling shutdown in interface AWSIoTSecureTunneling public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIoTSecureTunneling Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSIoTSecureTunneling request - The originally executed request.