com.amazonaws.services.iotdata

Interface AWSIotDataAsync

All Superinterfaces:

AWSIotData

All Known Implementing Classes:

AbstractAWSIotDataAsync, AWSIotDataAsyncClient

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

Interface for accessing AWS IoT Data Plane 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 AbstractAWSIotDataAsync instead.

AWS IoT

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the AWS cloud.

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by AWS Signature Version 4 to sign requests is: iotdevicegateway.

Field Summary

Fields inherited from interface com.amazonaws.services.iotdata.AWSIotData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest) Deletes the shadow for the specified thing.
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest, AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler) Deletes the shadow for the specified thing.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest getThingShadowRequest) Gets the shadow for the specified thing.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest getThingShadowRequest, AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler) Gets the shadow for the specified thing.
Future<ListNamedShadowsForThingResult>	listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
Future<ListNamedShadowsForThingResult>	listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest, AsyncHandler<ListNamedShadowsForThingRequest,ListNamedShadowsForThingResult> asyncHandler) Lists the shadows for the specified thing.
Future<PublishResult>	publishAsync(PublishRequest publishRequest) Publishes state information.
Future<PublishResult>	publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler) Publishes state information.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest) Updates the shadow for the specified thing.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest, AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler) Updates the shadow for the specified thing.

Methods inherited from interface com.amazonaws.services.iotdata.AWSIotData

deleteThingShadow, getCachedResponseMetadata, getThingShadow, listNamedShadowsForThing, publish, setEndpoint, setRegion, shutdown, updateThingShadow

Method Detail

deleteThingShadowAsync

Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest)

Deletes the shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Parameters:

deleteThingShadowRequest - The input for the DeleteThingShadow operation.

Returns:

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

deleteThingShadowAsync

Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest,
                                                       AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler)

Deletes the shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Parameters:

deleteThingShadowRequest - The input for the DeleteThingShadow operation.

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 DeleteThingShadow operation returned by the service.

getThingShadowAsync

Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest getThingShadowRequest)

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

Parameters:

getThingShadowRequest - The input for the GetThingShadow operation.

Returns:

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

getThingShadowAsync

Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest getThingShadowRequest,
                                                 AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler)

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

Parameters:

getThingShadowRequest - The input for the GetThingShadow operation.

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 GetThingShadow operation returned by the service.

listNamedShadowsForThingAsync

Future<ListNamedShadowsForThingResult> listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)

Lists the shadows for the specified thing.

Parameters:

listNamedShadowsForThingRequest -

Returns:

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

listNamedShadowsForThingAsync

Future<ListNamedShadowsForThingResult> listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest,
                                                                     AsyncHandler<ListNamedShadowsForThingRequest,ListNamedShadowsForThingResult> asyncHandler)

Lists the shadows for the specified thing.

Parameters:

listNamedShadowsForThingRequest -

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 ListNamedShadowsForThing operation returned by the service.

publishAsync

Future<PublishResult> publishAsync(PublishRequest publishRequest)

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Parameters:

publishRequest - The input for the Publish operation.

Returns:

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

publishAsync

Future<PublishResult> publishAsync(PublishRequest publishRequest,
                                   AsyncHandler<PublishRequest,PublishResult> asyncHandler)

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Parameters:

publishRequest - The input for the Publish operation.

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 Publish operation returned by the service.

updateThingShadowAsync

Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest)

Updates the shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Parameters:

updateThingShadowRequest - The input for the UpdateThingShadow operation.

Returns:

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

updateThingShadowAsync

Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest,
                                                       AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler)

Updates the shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Parameters:

updateThingShadowRequest - The input for the UpdateThingShadow operation.

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 UpdateThingShadow operation returned by the service.