com.amazonaws.services.iotsecuretunneling

Class AWSIoTSecureTunnelingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunnelingClient

All Implemented Interfaces:

AWSIoTSecureTunneling

Direct Known Subclasses:

AWSIoTSecureTunnelingAsyncClient

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

Client for accessing AWS IoT Secure Tunneling. All service calls made using this client are blocking, and will not return until the service call completes.

IoT Secure Tunneling

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIoTSecureTunnelingClientBuilder	builder()
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSIoTSecureTunnelingClientBuilder builder()

closeTunnel

public CloseTunnelResult closeTunnel(CloseTunnelRequest request)

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.

Specified by:

closeTunnel in interface AWSIoTSecureTunneling

Parameters:

closeTunnelRequest -

Returns:

Result of the CloseTunnel operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

describeTunnel

public DescribeTunnelResult describeTunnel(DescribeTunnelRequest request)

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

Requires permission to access the DescribeTunnel action.

Specified by:

describeTunnel in interface AWSIoTSecureTunneling

Parameters:

describeTunnelRequest -

Returns:

Result of the DescribeTunnel operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AWSIoTSecureTunneling

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

listTunnels

public ListTunnelsResult listTunnels(ListTunnelsRequest request)

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.

Specified by:

listTunnels in interface AWSIoTSecureTunneling

Parameters:

listTunnelsRequest -

Returns:

Result of the ListTunnels operation returned by the service.

See Also:

AWS API Documentation

openTunnel

public 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.

Requires permission to access the OpenTunnel action.

Specified by:

openTunnel in interface AWSIoTSecureTunneling

Parameters:

openTunnelRequest -

Returns:

Result of the OpenTunnel operation returned by the service.

Throws:

LimitExceededException - Thrown when a tunnel limit is exceeded.

See Also:

AWS API Documentation

rotateTunnelAccessToken

public 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.

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.

Specified by:

rotateTunnelAccessToken in interface AWSIoTSecureTunneling

Parameters:

rotateTunnelAccessTokenRequest -

Returns:

Result of the RotateTunnelAccessToken operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

A resource tag.

Specified by:

tagResource in interface AWSIoTSecureTunneling

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from a resource.

Specified by:

untagResource in interface AWSIoTSecureTunneling

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - Thrown when an operation is attempted on a resource that does not exist.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the 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.

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

Overrides:

shutdown in class AmazonWebServiceClient