*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSIoTSecureTunnelingClient extends AmazonWebServiceClient implements AWSIoTSecureTunneling { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSIoTSecureTunneling.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "IoTSecuredTunneling"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.iotsecuretunneling.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.iotsecuretunneling.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.iotsecuretunneling.model.AWSIoTSecureTunnelingException.class)); public static AWSIoTSecureTunnelingClientBuilder builder() { return AWSIoTSecureTunnelingClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS IoT Secure Tunneling using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTSecureTunnelingClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS IoT Secure Tunneling using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSIoTSecureTunnelingClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("api.tunneling.iot.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/iotsecuretunneling/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/iotsecuretunneling/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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 */ @Override public CloseTunnelResult closeTunnel(CloseTunnelRequest request) { request = beforeClientExecution(request); return executeCloseTunnel(request); } @SdkInternalApi final CloseTunnelResult executeCloseTunnel(CloseTunnelRequest closeTunnelRequest) { ExecutionContext executionContext = createExecutionContext(closeTunnelRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public DescribeTunnelResult describeTunnel(DescribeTunnelRequest request) { request = beforeClientExecution(request); return executeDescribeTunnel(request); } @SdkInternalApi final DescribeTunnelResult executeDescribeTunnel(DescribeTunnelRequest describeTunnelRequest) { ExecutionContext executionContext = createExecutionContext(describeTunnelRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
* * @param listTunnelsRequest * @return Result of the ListTunnels operation returned by the service. * @sample AWSIoTSecureTunneling.ListTunnels * @see AWS * API Documentation */ @Override public ListTunnelsResult listTunnels(ListTunnelsRequest request) { request = beforeClientExecution(request); return executeListTunnels(request); } @SdkInternalApi final ListTunnelsResult executeListTunnels(ListTunnelsRequest listTunnelsRequest) { ExecutionContext executionContext = createExecutionContext(listTunnelsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
* * @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 */ @Override public OpenTunnelResult openTunnel(OpenTunnelRequest request) { request = beforeClientExecution(request); return executeOpenTunnel(request); } @SdkInternalApi final OpenTunnelResult executeOpenTunnel(OpenTunnelRequest openTunnelRequest) { ExecutionContext executionContext = createExecutionContext(openTunnelRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
** 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 */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public UntagResourceResult untagResource(UntagResourceRequest request) { request = beforeClientExecution(request); return executeUntagResource(request); } @SdkInternalApi final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) { ExecutionContext executionContext = createExecutionContext(untagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private