com.amazonaws.services.iotsecuretunneling

Interface AWSIoTSecureTunneling

All Known Subinterfaces:

AWSIoTSecureTunnelingAsync

All Known Implementing Classes:

AbstractAWSIoTSecureTunneling, AbstractAWSIoTSecureTunnelingAsync, AWSIoTSecureTunnelingAsyncClient, AWSIoTSecureTunnelingClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTSecureTunneling

Interface for accessing AWS IoT Secure Tunneling.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTSecureTunneling instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CloseTunnelResult	closeTunnel(CloseTunnelRequest closeTunnelRequest) Closes a tunnel identified by the unique tunnel id.
DescribeTunnelResult	describeTunnel(DescribeTunnelRequest describeTunnelRequest) 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 listTagsForResourceRequest) Lists the tags for the specified resource.
ListTunnelsResult	listTunnels(ListTunnelsRequest listTunnelsRequest) List all tunnels for an Amazon Web Services account.
OpenTunnelResult	openTunnel(OpenTunnelRequest openTunnelRequest) 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 rotateTunnelAccessTokenRequest) 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 tagResourceRequest) A resource tag.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

closeTunnel

CloseTunnelResult closeTunnel(CloseTunnelRequest closeTunnelRequest)

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.

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

DescribeTunnelResult describeTunnel(DescribeTunnelRequest describeTunnelRequest)

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

Requires permission to access the DescribeTunnel action.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

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

ListTunnelsResult listTunnels(ListTunnelsRequest listTunnelsRequest)

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.

Parameters:

listTunnelsRequest -

Returns:

Result of the ListTunnels operation returned by the service.

See Also:

AWS API Documentation

openTunnel

OpenTunnelResult openTunnel(OpenTunnelRequest openTunnelRequest)

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.

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

RotateTunnelAccessTokenResult rotateTunnelAccessToken(RotateTunnelAccessTokenRequest rotateTunnelAccessTokenRequest)

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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

A resource tag.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from a resource.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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