com.amazonaws.services.iotsecuretunneling

Class AbstractAWSIoTSecureTunneling

java.lang.Object

com.amazonaws.services.iotsecuretunneling.AbstractAWSIoTSecureTunneling

All Implemented Interfaces:

AWSIoTSecureTunneling

Direct Known Subclasses:

AbstractAWSIoTSecureTunnelingAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIoTSecureTunneling
extends Object
implements AWSIoTSecureTunneling

Abstract implementation of AWSIoTSecureTunneling. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunneling

ENDPOINT_PREFIX

Method Summary

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 AWS account.
OpenTunnelResult	openTunnel(OpenTunnelRequest request) Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

closeTunnel

public CloseTunnelResult closeTunnel(CloseTunnelRequest request)

Description copied from interface: 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.

Specified by:

closeTunnel in interface AWSIoTSecureTunneling

Returns:

Result of the CloseTunnel operation returned by the service.

See Also:

AWS API Documentation

describeTunnel

public DescribeTunnelResult describeTunnel(DescribeTunnelRequest request)

Description copied from interface: AWSIoTSecureTunneling

Gets information about a tunnel identified by the unique tunnel id.

Specified by:

describeTunnel in interface AWSIoTSecureTunneling

Returns:

Result of the DescribeTunnel operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSIoTSecureTunneling

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSIoTSecureTunneling

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTunnels

public ListTunnelsResult listTunnels(ListTunnelsRequest request)

Description copied from interface: AWSIoTSecureTunneling

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Specified by:

listTunnels in interface AWSIoTSecureTunneling

Returns:

Result of the ListTunnels operation returned by the service.

See Also:

AWS API Documentation

openTunnel

public OpenTunnelResult openTunnel(OpenTunnelRequest request)

Description copied from interface: AWSIoTSecureTunneling

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.

Specified by:

openTunnel in interface AWSIoTSecureTunneling

Returns:

Result of the OpenTunnel operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSIoTSecureTunneling

A resource tag.

Specified by:

tagResource in interface AWSIoTSecureTunneling

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSIoTSecureTunneling

Removes a tag from a resource.

Specified by:

untagResource in interface AWSIoTSecureTunneling

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSIoTSecureTunneling

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSIoTSecureTunneling

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSIoTSecureTunneling

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSIoTSecureTunneling

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.