/* * 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.iot1clickdevices; import javax.annotation.Generated; import com.amazonaws.services.iot1clickdevices.model.*; /** * Interface for accessing AWS IoT 1-Click Devices Service 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.iot1clickdevices.AbstractAWSIoT1ClickDevicesAsync} instead. *

*

*

* Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, * responses, and errors for the supported web services protocols. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoT1ClickDevicesAsync extends AWSIoT1ClickDevices { /** *

* Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with * the device(s). *

* * @param claimDevicesByClaimCodeRequest * @return A Java Future containing the result of the ClaimDevicesByClaimCode operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.ClaimDevicesByClaimCode * @see AWS API Documentation */ java.util.concurrent.Future claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest); /** *

* Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with * the device(s). *

* * @param claimDevicesByClaimCodeRequest * @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 ClaimDevicesByClaimCode operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.ClaimDevicesByClaimCode * @see AWS API Documentation */ java.util.concurrent.Future claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Given a device ID, returns a DescribeDeviceResponse object describing the details of the device. *

* * @param describeDeviceRequest * @return A Java Future containing the result of the DescribeDevice operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.DescribeDevice * @see AWS API * Documentation */ java.util.concurrent.Future describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest); /** *

* Given a device ID, returns a DescribeDeviceResponse object describing the details of the device. *

* * @param describeDeviceRequest * @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 DescribeDevice operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.DescribeDevice * @see AWS API * Documentation */ java.util.concurrent.Future describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Given a device ID, finalizes the claim request for the associated device. *

* *

* Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a * device of type button, a device event can be published by simply clicking the device. *

* * * @param finalizeDeviceClaimRequest * @return A Java Future containing the result of the FinalizeDeviceClaim operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.FinalizeDeviceClaim * @see AWS * API Documentation */ java.util.concurrent.Future finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest); /** *

* Given a device ID, finalizes the claim request for the associated device. *

* *

* Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a * device of type button, a device event can be published by simply clicking the device. *

* * * @param finalizeDeviceClaimRequest * @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 FinalizeDeviceClaim operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.FinalizeDeviceClaim * @see AWS * API Documentation */ java.util.concurrent.Future finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Given a device ID, returns the invokable methods associated with the device. *

* * @param getDeviceMethodsRequest * @return A Java Future containing the result of the GetDeviceMethods operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.GetDeviceMethods * @see AWS API * Documentation */ java.util.concurrent.Future getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest); /** *

* Given a device ID, returns the invokable methods associated with the device. *

* * @param getDeviceMethodsRequest * @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 GetDeviceMethods operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.GetDeviceMethods * @see AWS API * Documentation */ java.util.concurrent.Future getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Given a device ID, initiates a claim request for the associated device. *

* *

* Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a * device of type button, a device event can be published by simply clicking the device. *

* * * @param initiateDeviceClaimRequest * @return A Java Future containing the result of the InitiateDeviceClaim operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.InitiateDeviceClaim * @see AWS * API Documentation */ java.util.concurrent.Future initiateDeviceClaimAsync(InitiateDeviceClaimRequest initiateDeviceClaimRequest); /** *

* Given a device ID, initiates a claim request for the associated device. *

* *

* Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a * device of type button, a device event can be published by simply clicking the device. *

* * * @param initiateDeviceClaimRequest * @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 InitiateDeviceClaim operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.InitiateDeviceClaim * @see AWS * API Documentation */ java.util.concurrent.Future initiateDeviceClaimAsync(InitiateDeviceClaimRequest initiateDeviceClaimRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Given a device ID, issues a request to invoke a named device method (with possible parameters). See the * "Example POST" code snippet below. *

* * @param invokeDeviceMethodRequest * @return A Java Future containing the result of the InvokeDeviceMethod operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.InvokeDeviceMethod * @see AWS API * Documentation */ java.util.concurrent.Future invokeDeviceMethodAsync(InvokeDeviceMethodRequest invokeDeviceMethodRequest); /** *

* Given a device ID, issues a request to invoke a named device method (with possible parameters). See the * "Example POST" code snippet below. *

* * @param invokeDeviceMethodRequest * @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 InvokeDeviceMethod operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.InvokeDeviceMethod * @see AWS API * Documentation */ java.util.concurrent.Future invokeDeviceMethodAsync(InvokeDeviceMethodRequest invokeDeviceMethodRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device. *

* * @param listDeviceEventsRequest * @return A Java Future containing the result of the ListDeviceEvents operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.ListDeviceEvents * @see AWS API * Documentation */ java.util.concurrent.Future listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest); /** *

* Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device. *

* * @param listDeviceEventsRequest * @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 ListDeviceEvents operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.ListDeviceEvents * @see AWS API * Documentation */ java.util.concurrent.Future listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the 1-Click compatible devices associated with your AWS account. *

* * @param listDevicesRequest * @return A Java Future containing the result of the ListDevices operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.ListDevices * @see AWS API * Documentation */ java.util.concurrent.Future listDevicesAsync(ListDevicesRequest listDevicesRequest); /** *

* Lists the 1-Click compatible devices associated with your AWS account. *

* * @param listDevicesRequest * @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 ListDevices operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.ListDevices * @see AWS API * Documentation */ java.util.concurrent.Future listDevicesAsync(ListDevicesRequest listDevicesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the tags associated with the specified resource ARN. *

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

* Lists the tags associated with the specified resource ARN. *

* * @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 AWSIoT1ClickDevicesAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Adds or updates the tags associated with the resource ARN. See AWS IoT * 1-Click Service Limits for the maximum number of tags allowed per resource. *

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

* Adds or updates the tags associated with the resource ARN. See AWS IoT * 1-Click Service Limits for the maximum number of tags allowed per resource. *

* * @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 AWSIoT1ClickDevicesAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Disassociates a device from your AWS account using its device ID. *

* * @param unclaimDeviceRequest * @return A Java Future containing the result of the UnclaimDevice operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.UnclaimDevice * @see AWS API * Documentation */ java.util.concurrent.Future unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest); /** *

* Disassociates a device from your AWS account using its device ID. *

* * @param unclaimDeviceRequest * @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 UnclaimDevice operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.UnclaimDevice * @see AWS API * Documentation */ java.util.concurrent.Future unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. *

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

* Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. *

* * @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 AWSIoT1ClickDevicesAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Using a Boolean value (true or false), this operation enables or disables the device given a device ID. *

* * @param updateDeviceStateRequest * @return A Java Future containing the result of the UpdateDeviceState operation returned by the service. * @sample AWSIoT1ClickDevicesAsync.UpdateDeviceState * @see AWS API * Documentation */ java.util.concurrent.Future updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest); /** *

* Using a Boolean value (true or false), this operation enables or disables the device given a device ID. *

* * @param updateDeviceStateRequest * @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 UpdateDeviceState operation returned by the service. * @sample AWSIoT1ClickDevicesAsyncHandler.UpdateDeviceState * @see AWS API * Documentation */ java.util.concurrent.Future updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }