com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunneling Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iotsecuretunneling Show documentation
/*
* Copyright 2019-2024 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.iotsecuretunneling.model.*;
/**
* Interface for accessing AWS IoT Secure Tunneling.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.iotsecuretunneling.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTSecureTunneling {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "api.tunneling.iot";
/**
*
* 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 Result of the CloseTunnel operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.CloseTunnel
* @see AWS
* API Documentation
*/
CloseTunnelResult closeTunnel(CloseTunnelRequest closeTunnelRequest);
/**
*
* Gets information about a tunnel identified by the unique tunnel id.
*
*
* Requires permission to access the DescribeTunnel action.
*
*
* @param describeTunnelRequest
* @return Result of the DescribeTunnel operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.DescribeTunnel
* @see AWS API Documentation
*/
DescribeTunnelResult describeTunnel(DescribeTunnelRequest describeTunnelRequest);
/**
*
* Lists the tags for the specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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 Result of the ListTunnels operation returned by the service.
* @sample AWSIoTSecureTunneling.ListTunnels
* @see AWS
* API Documentation
*/
ListTunnelsResult listTunnels(ListTunnelsRequest listTunnelsRequest);
/**
*
* 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 Result of the OpenTunnel operation returned by the service.
* @throws LimitExceededException
* Thrown when a tunnel limit is exceeded.
* @sample AWSIoTSecureTunneling.OpenTunnel
* @see AWS
* API Documentation
*/
OpenTunnelResult openTunnel(OpenTunnelRequest openTunnelRequest);
/**
*
* 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 Result of the RotateTunnelAccessToken operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.RotateTunnelAccessToken
* @see AWS API Documentation
*/
RotateTunnelAccessTokenResult rotateTunnelAccessToken(RotateTunnelAccessTokenRequest rotateTunnelAccessTokenRequest);
/**
*
* A resource tag.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* Thrown when an operation is attempted on a resource that does not exist.
* @sample AWSIoTSecureTunneling.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}