/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iotsecuretunneling; import javax.annotation.Generated; import com.amazonaws.services.iotsecuretunneling.model.*; /** * Interface for accessing AWS IoT Secure Tunneling asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.iotsecuretunneling.AbstractAWSIoTSecureTunnelingAsync} 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. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTSecureTunnelingAsync extends 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. *

* * @param closeTunnelRequest * @return A Java Future containing the result of the CloseTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.CloseTunnel * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param closeTunnelRequest * @param 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. * @return A Java Future containing the result of the CloseTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.CloseTunnel * @see AWS * API Documentation */ java.util.concurrent.Future closeTunnelAsync(CloseTunnelRequest closeTunnelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

*

* Requires permission to access the DescribeTunnel action. *

* * @param describeTunnelRequest * @return A Java Future containing the result of the DescribeTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.DescribeTunnel * @see AWS API Documentation */ java.util.concurrent.Future describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest); /** *

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

*

* Requires permission to access the DescribeTunnel action. *

* * @param describeTunnelRequest * @param 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. * @return A Java Future containing the result of the DescribeTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.DescribeTunnel * @see AWS API Documentation */ java.util.concurrent.Future describeTunnelAsync(DescribeTunnelRequest describeTunnelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the tags for the specified resource. *

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Lists the tags for the specified resource. *

* * @param listTagsForResourceRequest * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param listTunnelsRequest * @return A Java Future containing the result of the ListTunnels operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.ListTunnels * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param listTunnelsRequest * @param 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. * @return A Java Future containing the result of the ListTunnels operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.ListTunnels * @see AWS * API Documentation */ java.util.concurrent.Future listTunnelsAsync(ListTunnelsRequest listTunnelsRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param openTunnelRequest * @return A Java Future containing the result of the OpenTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.OpenTunnel * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param openTunnelRequest * @param 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. * @return A Java Future containing the result of the OpenTunnel operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.OpenTunnel * @see AWS * API Documentation */ java.util.concurrent.Future openTunnelAsync(OpenTunnelRequest openTunnelRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * * @param rotateTunnelAccessTokenRequest * @return A Java Future containing the result of the RotateTunnelAccessToken operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.RotateTunnelAccessToken * @see AWS API Documentation */ java.util.concurrent.Future 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. *

* * * @param rotateTunnelAccessTokenRequest * @param 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. * @return A Java Future containing the result of the RotateTunnelAccessToken operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.RotateTunnelAccessToken * @see AWS API Documentation */ java.util.concurrent.Future rotateTunnelAccessTokenAsync(RotateTunnelAccessTokenRequest rotateTunnelAccessTokenRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* A resource tag. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* A resource tag. *

* * @param tagResourceRequest * @param 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. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes a tag from a resource. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsync.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Removes a tag from a resource. *

* * @param untagResourceRequest * @param 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. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSIoTSecureTunnelingAsyncHandler.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }