com.amazonaws.services.iot1clickdevices

Interface AWSIoT1ClickDevicesAsync

All Superinterfaces:

AWSIoT1ClickDevices

All Known Implementing Classes:

AbstractAWSIoT1ClickDevicesAsync, AWSIoT1ClickDevicesAsyncClient

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

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 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 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.

Field Summary

Fields inherited from interface com.amazonaws.services.iot1clickdevices.AWSIoT1ClickDevices

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<ClaimDevicesByClaimCodeResult>	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).
Future<ClaimDevicesByClaimCodeResult>	claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest, AsyncHandler<ClaimDevicesByClaimCodeRequest,ClaimDevicesByClaimCodeResult> asyncHandler) 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).
Future<DescribeDeviceResult>	describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest) Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
Future<DescribeDeviceResult>	describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest, AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler) Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
Future<FinalizeDeviceClaimResult>	finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest) Given a device ID, finalizes the claim request for the associated device.
Future<FinalizeDeviceClaimResult>	finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest, AsyncHandler<FinalizeDeviceClaimRequest,FinalizeDeviceClaimResult> asyncHandler) Given a device ID, finalizes the claim request for the associated device.
Future<GetDeviceMethodsResult>	getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest) Given a device ID, returns the invokable methods associated with the device.
Future<GetDeviceMethodsResult>	getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest, AsyncHandler<GetDeviceMethodsRequest,GetDeviceMethodsResult> asyncHandler) Given a device ID, returns the invokable methods associated with the device.
Future<InitiateDeviceClaimResult>	initiateDeviceClaimAsync(InitiateDeviceClaimRequest initiateDeviceClaimRequest) Given a device ID, initiates a claim request for the associated device.
Future<InitiateDeviceClaimResult>	initiateDeviceClaimAsync(InitiateDeviceClaimRequest initiateDeviceClaimRequest, AsyncHandler<InitiateDeviceClaimRequest,InitiateDeviceClaimResult> asyncHandler) Given a device ID, initiates a claim request for the associated device.
Future<InvokeDeviceMethodResult>	invokeDeviceMethodAsync(InvokeDeviceMethodRequest invokeDeviceMethodRequest) Given a device ID, issues a request to invoke a named device method (with possible parameters).
Future<InvokeDeviceMethodResult>	invokeDeviceMethodAsync(InvokeDeviceMethodRequest invokeDeviceMethodRequest, AsyncHandler<InvokeDeviceMethodRequest,InvokeDeviceMethodResult> asyncHandler) Given a device ID, issues a request to invoke a named device method (with possible parameters).
Future<ListDeviceEventsResult>	listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest) Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
Future<ListDeviceEventsResult>	listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest, AsyncHandler<ListDeviceEventsRequest,ListDeviceEventsResult> asyncHandler) Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
Future<ListDevicesResult>	listDevicesAsync(ListDevicesRequest listDevicesRequest) Lists the 1-Click compatible devices associated with your AWS account.
Future<ListDevicesResult>	listDevicesAsync(ListDevicesRequest listDevicesRequest, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler) Lists the 1-Click compatible devices associated with your AWS account.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with the specified resource ARN.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the tags associated with the specified resource ARN.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Adds or updates the tags associated with the resource ARN.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds or updates the tags associated with the resource ARN.
Future<UnclaimDeviceResult>	unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest) Disassociates a device from your AWS account using its device ID.
Future<UnclaimDeviceResult>	unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest, AsyncHandler<UnclaimDeviceRequest,UnclaimDeviceResult> asyncHandler) Disassociates a device from your AWS account using its device ID.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
Future<UpdateDeviceStateResult>	updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest) Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
Future<UpdateDeviceStateResult>	updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest, AsyncHandler<UpdateDeviceStateRequest,UpdateDeviceStateResult> asyncHandler) Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Methods inherited from interface com.amazonaws.services.iot1clickdevices.AWSIoT1ClickDevices

claimDevicesByClaimCode, describeDevice, finalizeDeviceClaim, getCachedResponseMetadata, getDeviceMethods, initiateDeviceClaim, invokeDeviceMethod, listDeviceEvents, listDevices, listTagsForResource, shutdown, tagResource, unclaimDevice, untagResource, updateDeviceState

Method Detail

claimDevicesByClaimCodeAsync

Future<ClaimDevicesByClaimCodeResult> 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).

Parameters:

claimDevicesByClaimCodeRequest -

Returns:

A Java Future containing the result of the ClaimDevicesByClaimCode operation returned by the service.

See Also:

AWS API Documentation

claimDevicesByClaimCodeAsync

Future<ClaimDevicesByClaimCodeResult> claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest,
                                                                   AsyncHandler<ClaimDevicesByClaimCodeRequest,ClaimDevicesByClaimCodeResult> asyncHandler)

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).

Parameters:

claimDevicesByClaimCodeRequest -

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.

Returns:

A Java Future containing the result of the ClaimDevicesByClaimCode operation returned by the service.

See Also:

AWS API Documentation

describeDeviceAsync

Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest)

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

Parameters:

describeDeviceRequest -

Returns:

A Java Future containing the result of the DescribeDevice operation returned by the service.

See Also:

AWS API Documentation

describeDeviceAsync

Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest describeDeviceRequest,
                                                 AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler)

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

Parameters:

describeDeviceRequest -

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.

Returns:

A Java Future containing the result of the DescribeDevice operation returned by the service.

See Also:

AWS API Documentation

finalizeDeviceClaimAsync

Future<FinalizeDeviceClaimResult> 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.

Parameters:

finalizeDeviceClaimRequest -

Returns:

A Java Future containing the result of the FinalizeDeviceClaim operation returned by the service.

See Also:

AWS API Documentation

finalizeDeviceClaimAsync

Future<FinalizeDeviceClaimResult> finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest,
                                                           AsyncHandler<FinalizeDeviceClaimRequest,FinalizeDeviceClaimResult> 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.

Parameters:

finalizeDeviceClaimRequest -

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.

Returns:

A Java Future containing the result of the FinalizeDeviceClaim operation returned by the service.

See Also:

AWS API Documentation

getDeviceMethodsAsync

Future<GetDeviceMethodsResult> getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest)

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

Parameters:

getDeviceMethodsRequest -

Returns:

A Java Future containing the result of the GetDeviceMethods operation returned by the service.

See Also:

AWS API Documentation

getDeviceMethodsAsync

Future<GetDeviceMethodsResult> getDeviceMethodsAsync(GetDeviceMethodsRequest getDeviceMethodsRequest,
                                                     AsyncHandler<GetDeviceMethodsRequest,GetDeviceMethodsResult> asyncHandler)

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

Parameters:

getDeviceMethodsRequest -

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.

Returns:

A Java Future containing the result of the GetDeviceMethods operation returned by the service.

See Also:

AWS API Documentation

initiateDeviceClaimAsync

Future<InitiateDeviceClaimResult> 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.

Parameters:

initiateDeviceClaimRequest -

Returns:

A Java Future containing the result of the InitiateDeviceClaim operation returned by the service.

See Also:

AWS API Documentation

initiateDeviceClaimAsync

Future<InitiateDeviceClaimResult> initiateDeviceClaimAsync(InitiateDeviceClaimRequest initiateDeviceClaimRequest,
                                                           AsyncHandler<InitiateDeviceClaimRequest,InitiateDeviceClaimResult> 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.

Parameters:

initiateDeviceClaimRequest -

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.

Returns:

A Java Future containing the result of the InitiateDeviceClaim operation returned by the service.

See Also:

AWS API Documentation

invokeDeviceMethodAsync

Future<InvokeDeviceMethodResult> 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.

Parameters:

invokeDeviceMethodRequest -

Returns:

A Java Future containing the result of the InvokeDeviceMethod operation returned by the service.

See Also:

AWS API Documentation

invokeDeviceMethodAsync

Future<InvokeDeviceMethodResult> invokeDeviceMethodAsync(InvokeDeviceMethodRequest invokeDeviceMethodRequest,
                                                         AsyncHandler<InvokeDeviceMethodRequest,InvokeDeviceMethodResult> asyncHandler)

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

Parameters:

invokeDeviceMethodRequest -

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.

Returns:

A Java Future containing the result of the InvokeDeviceMethod operation returned by the service.

See Also:

AWS API Documentation

listDeviceEventsAsync

Future<ListDeviceEventsResult> listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest)

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

Parameters:

listDeviceEventsRequest -

Returns:

A Java Future containing the result of the ListDeviceEvents operation returned by the service.

See Also:

AWS API Documentation

listDeviceEventsAsync

Future<ListDeviceEventsResult> listDeviceEventsAsync(ListDeviceEventsRequest listDeviceEventsRequest,
                                                     AsyncHandler<ListDeviceEventsRequest,ListDeviceEventsResult> asyncHandler)

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

Parameters:

listDeviceEventsRequest -

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.

Returns:

A Java Future containing the result of the ListDeviceEvents operation returned by the service.

See Also:

AWS API Documentation

listDevicesAsync

Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest)

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

Parameters:

listDevicesRequest -

Returns:

A Java Future containing the result of the ListDevices operation returned by the service.

See Also:

AWS API Documentation

listDevicesAsync

Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest,
                                           AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)

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

Parameters:

listDevicesRequest -

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.

Returns:

A Java Future containing the result of the ListDevices operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags associated with the specified resource ARN.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Lists the tags associated with the specified resource ARN.

Parameters:

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.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> 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.

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> 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.

Parameters:

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.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

unclaimDeviceAsync

Future<UnclaimDeviceResult> unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest)

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

Parameters:

unclaimDeviceRequest -

Returns:

A Java Future containing the result of the UnclaimDevice operation returned by the service.

See Also:

AWS API Documentation

unclaimDeviceAsync

Future<UnclaimDeviceResult> unclaimDeviceAsync(UnclaimDeviceRequest unclaimDeviceRequest,
                                               AsyncHandler<UnclaimDeviceRequest,UnclaimDeviceResult> asyncHandler)

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

Parameters:

unclaimDeviceRequest -

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.

Returns:

A Java Future containing the result of the UnclaimDevice operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

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

Parameters:

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.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateDeviceStateAsync

Future<UpdateDeviceStateResult> updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest)

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

Parameters:

updateDeviceStateRequest -

Returns:

A Java Future containing the result of the UpdateDeviceState operation returned by the service.

See Also:

AWS API Documentation

updateDeviceStateAsync

Future<UpdateDeviceStateResult> updateDeviceStateAsync(UpdateDeviceStateRequest updateDeviceStateRequest,
                                                       AsyncHandler<UpdateDeviceStateRequest,UpdateDeviceStateResult> asyncHandler)

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

Parameters:

updateDeviceStateRequest -

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.

Returns:

A Java Future containing the result of the UpdateDeviceState operation returned by the service.

See Also:

AWS API Documentation