@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIoT1ClickDevicesAsyncClient extends AWSIoT1ClickDevicesClient implements AWSIoT1ClickDevicesAsync
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
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.
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSIoT1ClickDevicesAsyncClientBuilder |
asyncBuilder() |
Future<ClaimDevicesByClaimCodeResult> |
claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest request)
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 request,
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 request)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
Future<DescribeDeviceResult> |
describeDeviceAsync(DescribeDeviceRequest request,
AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
Future<FinalizeDeviceClaimResult> |
finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest request)
Given a device ID, finalizes the claim request for the associated device.
|
Future<FinalizeDeviceClaimResult> |
finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest request,
AsyncHandler<FinalizeDeviceClaimRequest,FinalizeDeviceClaimResult> asyncHandler)
Given a device ID, finalizes the claim request for the associated device.
|
Future<GetDeviceMethodsResult> |
getDeviceMethodsAsync(GetDeviceMethodsRequest request)
Given a device ID, returns the invokable methods associated with the device.
|
Future<GetDeviceMethodsResult> |
getDeviceMethodsAsync(GetDeviceMethodsRequest request,
AsyncHandler<GetDeviceMethodsRequest,GetDeviceMethodsResult> asyncHandler)
Given a device ID, returns the invokable methods associated with the device.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<InitiateDeviceClaimResult> |
initiateDeviceClaimAsync(InitiateDeviceClaimRequest request)
Given a device ID, initiates a claim request for the associated device.
|
Future<InitiateDeviceClaimResult> |
initiateDeviceClaimAsync(InitiateDeviceClaimRequest request,
AsyncHandler<InitiateDeviceClaimRequest,InitiateDeviceClaimResult> asyncHandler)
Given a device ID, initiates a claim request for the associated device.
|
Future<InvokeDeviceMethodResult> |
invokeDeviceMethodAsync(InvokeDeviceMethodRequest request)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
Future<InvokeDeviceMethodResult> |
invokeDeviceMethodAsync(InvokeDeviceMethodRequest request,
AsyncHandler<InvokeDeviceMethodRequest,InvokeDeviceMethodResult> asyncHandler)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
Future<ListDeviceEventsResult> |
listDeviceEventsAsync(ListDeviceEventsRequest request)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
Future<ListDeviceEventsResult> |
listDeviceEventsAsync(ListDeviceEventsRequest request,
AsyncHandler<ListDeviceEventsRequest,ListDeviceEventsResult> asyncHandler)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
Future<ListDevicesResult> |
listDevicesAsync(ListDevicesRequest request)
Lists the 1-Click compatible devices associated with your AWS account.
|
Future<ListDevicesResult> |
listDevicesAsync(ListDevicesRequest request,
AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
Lists the 1-Click compatible devices associated with your AWS account.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Lists the tags associated with the specified resource ARN.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags associated with the specified resource ARN.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Adds or updates the tags associated with the resource ARN.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or updates the tags associated with the resource ARN.
|
Future<UnclaimDeviceResult> |
unclaimDeviceAsync(UnclaimDeviceRequest request)
Disassociates a device from your AWS account using its device ID.
|
Future<UnclaimDeviceResult> |
unclaimDeviceAsync(UnclaimDeviceRequest request,
AsyncHandler<UnclaimDeviceRequest,UnclaimDeviceResult> asyncHandler)
Disassociates a device from your AWS account using its device ID.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
|
Future<UpdateDeviceStateResult> |
updateDeviceStateAsync(UpdateDeviceStateRequest request)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
Future<UpdateDeviceStateResult> |
updateDeviceStateAsync(UpdateDeviceStateRequest request,
AsyncHandler<UpdateDeviceStateRequest,UpdateDeviceStateResult> asyncHandler)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
builder, claimDevicesByClaimCode, describeDevice, finalizeDeviceClaim, getCachedResponseMetadata, getDeviceMethods, initiateDeviceClaim, invokeDeviceMethod, listDeviceEvents, listDevices, listTagsForResource, tagResource, unclaimDevice, untagResource, updateDeviceStateaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclaimDevicesByClaimCode, describeDevice, finalizeDeviceClaim, getCachedResponseMetadata, getDeviceMethods, initiateDeviceClaim, invokeDeviceMethod, listDeviceEvents, listDevices, listTagsForResource, tagResource, unclaimDevice, untagResource, updateDeviceStatepublic static AWSIoT1ClickDevicesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<ClaimDevicesByClaimCodeResult> claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest request)
AWSIoT1ClickDevicesAsyncAdds 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).
claimDevicesByClaimCodeAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<ClaimDevicesByClaimCodeResult> claimDevicesByClaimCodeAsync(ClaimDevicesByClaimCodeRequest request, AsyncHandler<ClaimDevicesByClaimCodeRequest,ClaimDevicesByClaimCodeResult> asyncHandler)
AWSIoT1ClickDevicesAsyncAdds 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).
claimDevicesByClaimCodeAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest request)
AWSIoT1ClickDevicesAsyncGiven a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDeviceAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<DescribeDeviceResult> describeDeviceAsync(DescribeDeviceRequest request, AsyncHandler<DescribeDeviceRequest,DescribeDeviceResult> asyncHandler)
AWSIoT1ClickDevicesAsyncGiven a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDeviceAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<FinalizeDeviceClaimResult> finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest request)
AWSIoT1ClickDevicesAsyncGiven 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.
finalizeDeviceClaimAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<FinalizeDeviceClaimResult> finalizeDeviceClaimAsync(FinalizeDeviceClaimRequest request, AsyncHandler<FinalizeDeviceClaimRequest,FinalizeDeviceClaimResult> asyncHandler)
AWSIoT1ClickDevicesAsyncGiven 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.
finalizeDeviceClaimAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<GetDeviceMethodsResult> getDeviceMethodsAsync(GetDeviceMethodsRequest request)
AWSIoT1ClickDevicesAsyncGiven a device ID, returns the invokable methods associated with the device.
getDeviceMethodsAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<GetDeviceMethodsResult> getDeviceMethodsAsync(GetDeviceMethodsRequest request, AsyncHandler<GetDeviceMethodsRequest,GetDeviceMethodsResult> asyncHandler)
AWSIoT1ClickDevicesAsyncGiven a device ID, returns the invokable methods associated with the device.
getDeviceMethodsAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<InitiateDeviceClaimResult> initiateDeviceClaimAsync(InitiateDeviceClaimRequest request)
AWSIoT1ClickDevicesAsyncGiven 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.
initiateDeviceClaimAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<InitiateDeviceClaimResult> initiateDeviceClaimAsync(InitiateDeviceClaimRequest request, AsyncHandler<InitiateDeviceClaimRequest,InitiateDeviceClaimResult> asyncHandler)
AWSIoT1ClickDevicesAsyncGiven 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.
initiateDeviceClaimAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<InvokeDeviceMethodResult> invokeDeviceMethodAsync(InvokeDeviceMethodRequest request)
AWSIoT1ClickDevicesAsyncGiven a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
invokeDeviceMethodAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<InvokeDeviceMethodResult> invokeDeviceMethodAsync(InvokeDeviceMethodRequest request, AsyncHandler<InvokeDeviceMethodRequest,InvokeDeviceMethodResult> asyncHandler)
AWSIoT1ClickDevicesAsyncGiven a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
invokeDeviceMethodAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<ListDeviceEventsResult> listDeviceEventsAsync(ListDeviceEventsRequest request)
AWSIoT1ClickDevicesAsyncUsing a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEventsAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<ListDeviceEventsResult> listDeviceEventsAsync(ListDeviceEventsRequest request, AsyncHandler<ListDeviceEventsRequest,ListDeviceEventsResult> asyncHandler)
AWSIoT1ClickDevicesAsyncUsing a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEventsAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request)
AWSIoT1ClickDevicesAsyncLists the 1-Click compatible devices associated with your AWS account.
listDevicesAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
AWSIoT1ClickDevicesAsyncLists the 1-Click compatible devices associated with your AWS account.
listDevicesAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSIoT1ClickDevicesAsyncLists the tags associated with the specified resource ARN.
listTagsForResourceAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSIoT1ClickDevicesAsyncLists the tags associated with the specified resource ARN.
listTagsForResourceAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSIoT1ClickDevicesAsyncAdds 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.
tagResourceAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSIoT1ClickDevicesAsyncAdds 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.
tagResourceAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<UnclaimDeviceResult> unclaimDeviceAsync(UnclaimDeviceRequest request)
AWSIoT1ClickDevicesAsyncDisassociates a device from your AWS account using its device ID.
unclaimDeviceAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<UnclaimDeviceResult> unclaimDeviceAsync(UnclaimDeviceRequest request, AsyncHandler<UnclaimDeviceRequest,UnclaimDeviceResult> asyncHandler)
AWSIoT1ClickDevicesAsyncDisassociates a device from your AWS account using its device ID.
unclaimDeviceAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSIoT1ClickDevicesAsyncUsing tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untagResourceAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSIoT1ClickDevicesAsyncUsing tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untagResourceAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public Future<UpdateDeviceStateResult> updateDeviceStateAsync(UpdateDeviceStateRequest request)
AWSIoT1ClickDevicesAsyncUsing a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceStateAsync in interface AWSIoT1ClickDevicesAsyncpublic Future<UpdateDeviceStateResult> updateDeviceStateAsync(UpdateDeviceStateRequest request, AsyncHandler<UpdateDeviceStateRequest,UpdateDeviceStateResult> asyncHandler)
AWSIoT1ClickDevicesAsyncUsing a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceStateAsync in interface AWSIoT1ClickDevicesAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSIoT1ClickDevicesshutdown in class AWSIoT1ClickDevicesClientCopyright © 2021. All rights reserved.