@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTSecureTunnelingAsync extends AWSIoTSecureTunneling
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTSecureTunnelingAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CloseTunnelResult> |
closeTunnelAsync(CloseTunnelRequest closeTunnelRequest)
Closes a tunnel identified by the unique tunnel id.
|
Future<CloseTunnelResult> |
closeTunnelAsync(CloseTunnelRequest closeTunnelRequest,
AsyncHandler<CloseTunnelRequest,CloseTunnelResult> asyncHandler)
Closes a tunnel identified by the unique tunnel id.
|
Future<DescribeTunnelResult> |
describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest)
Gets information about a tunnel identified by the unique tunnel id.
|
Future<DescribeTunnelResult> |
describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest,
AsyncHandler<DescribeTunnelRequest,DescribeTunnelResult> asyncHandler)
Gets information about a tunnel identified by the unique tunnel id.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags for the specified resource.
|
Future<ListTunnelsResult> |
listTunnelsAsync(ListTunnelsRequest listTunnelsRequest)
List all tunnels for an Amazon Web Services account.
|
Future<ListTunnelsResult> |
listTunnelsAsync(ListTunnelsRequest listTunnelsRequest,
AsyncHandler<ListTunnelsRequest,ListTunnelsResult> asyncHandler)
List all tunnels for an Amazon Web Services account.
|
Future<OpenTunnelResult> |
openTunnelAsync(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.
|
Future<OpenTunnelResult> |
openTunnelAsync(OpenTunnelRequest openTunnelRequest,
AsyncHandler<OpenTunnelRequest,OpenTunnelResult> asyncHandler)
Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure
Tunneling proxy server.
|
Future<RotateTunnelAccessTokenResult> |
rotateTunnelAccessTokenAsync(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.
|
Future<RotateTunnelAccessTokenResult> |
rotateTunnelAccessTokenAsync(RotateTunnelAccessTokenRequest rotateTunnelAccessTokenRequest,
AsyncHandler<RotateTunnelAccessTokenRequest,RotateTunnelAccessTokenResult> asyncHandler)
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.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
A resource tag.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
A resource tag.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from a resource.
|
closeTunnel, describeTunnel, getCachedResponseMetadata, listTagsForResource, listTunnels, openTunnel, rotateTunnelAccessToken, shutdown, tagResource, untagResource
Future<CloseTunnelResult> closeTunnelAsync(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.
closeTunnelRequest
- Future<CloseTunnelResult> closeTunnelAsync(CloseTunnelRequest closeTunnelRequest, AsyncHandler<CloseTunnelRequest,CloseTunnelResult> asyncHandler)
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.
closeTunnelRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTunnelResult> describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest)
Gets information about a tunnel identified by the unique tunnel id.
Requires permission to access the DescribeTunnel action.
describeTunnelRequest
- Future<DescribeTunnelResult> describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest, AsyncHandler<DescribeTunnelRequest,DescribeTunnelResult> asyncHandler)
Gets information about a tunnel identified by the unique tunnel id.
Requires permission to access the DescribeTunnel action.
describeTunnelRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags for the specified resource.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTunnelsResult> listTunnelsAsync(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.
listTunnelsRequest
- Future<ListTunnelsResult> listTunnelsAsync(ListTunnelsRequest listTunnelsRequest, AsyncHandler<ListTunnelsRequest,ListTunnelsResult> asyncHandler)
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.
listTunnelsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<OpenTunnelResult> openTunnelAsync(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.
openTunnelRequest
- Future<OpenTunnelResult> openTunnelAsync(OpenTunnelRequest openTunnelRequest, AsyncHandler<OpenTunnelRequest,OpenTunnelResult> asyncHandler)
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.
openTunnelRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RotateTunnelAccessTokenResult> rotateTunnelAccessTokenAsync(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.
rotateTunnelAccessTokenRequest
- Future<RotateTunnelAccessTokenResult> rotateTunnelAccessTokenAsync(RotateTunnelAccessTokenRequest rotateTunnelAccessTokenRequest, AsyncHandler<RotateTunnelAccessTokenRequest,RotateTunnelAccessTokenResult> asyncHandler)
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.
rotateTunnelAccessTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
A resource tag.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
A resource tag.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from a resource.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.