com.amazonaws.services.iotdata

Class AWSIotDataAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotdata.AWSIotDataClient

com.amazonaws.services.iotdata.AWSIotDataAsyncClient

All Implemented Interfaces:

AWSIotData, AWSIotDataAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIotDataAsyncClient
extends AWSIotDataClient
implements AWSIotDataAsync

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

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 class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSIotDataAsyncClient() Deprecated. use AWSIotDataAsyncClientBuilder.defaultClient()
AWSIotDataAsyncClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSIotDataAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSIotDataAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSIotDataAsyncClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSIotDataAsyncClientBuilder	asyncBuilder()
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest request) Deletes the shadow for the specified thing.
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest request, AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler) Deletes the shadow for the specified thing.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest request) Gets the shadow for the specified thing.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest request, AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler) Gets the shadow for the specified thing.
Future<ListNamedShadowsForThingResult>	listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest request) Lists the shadows for the specified thing.
Future<ListNamedShadowsForThingResult>	listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest request, AsyncHandler<ListNamedShadowsForThingRequest,ListNamedShadowsForThingResult> asyncHandler) Lists the shadows for the specified thing.
Future<PublishResult>	publishAsync(PublishRequest request) Publishes state information.
Future<PublishResult>	publishAsync(PublishRequest request, AsyncHandler<PublishRequest,PublishResult> asyncHandler) Publishes state information.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest request) Updates the shadow for the specified thing.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest request, AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler) Updates the shadow for the specified thing.

Methods inherited from class com.amazonaws.services.iotdata.AWSIotDataClient

builder, deleteThingShadow, getCachedResponseMetadata, getThingShadow, listNamedShadowsForThing, publish, updateThingShadow

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient()

Deprecated. use AWSIotDataAsyncClientBuilder.defaultClient()

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS IoT Data Plane (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentials awsCredentials,
                                         ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentials awsCredentials,
                                         ClientConfiguration clientConfiguration,
                                         ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSIotDataAsyncClient

@Deprecated
public AWSIotDataAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration,
                                         ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS IoT Data Plane using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

asyncBuilder

public static AWSIotDataAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

deleteThingShadowAsync

public Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest request)

Description copied from interface: AWSIotDataAsync

Deletes the shadow for the specified thing.

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

Specified by:

deleteThingShadowAsync in interface AWSIotDataAsync

Parameters:

request - The input for the DeleteThingShadow operation.

Returns:

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

deleteThingShadowAsync

public Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest request,
                                                              AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler)

Description copied from interface: AWSIotDataAsync

Deletes the shadow for the specified thing.

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

Specified by:

deleteThingShadowAsync in interface AWSIotDataAsync

Parameters:

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

public Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest request)

Description copied from interface: AWSIotDataAsync

Gets the shadow for the specified thing.

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

Specified by:

getThingShadowAsync in interface AWSIotDataAsync

Parameters:

request - The input for the GetThingShadow operation.

Returns:

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

getThingShadowAsync

public Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest request,
                                                        AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler)

Description copied from interface: AWSIotDataAsync

Gets the shadow for the specified thing.

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

Specified by:

getThingShadowAsync in interface AWSIotDataAsync

Parameters:

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

public Future<ListNamedShadowsForThingResult> listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest request)

Description copied from interface: AWSIotDataAsync

Lists the shadows for the specified thing.

Specified by:

listNamedShadowsForThingAsync in interface AWSIotDataAsync

Returns:

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

listNamedShadowsForThingAsync

public Future<ListNamedShadowsForThingResult> listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest request,
                                                                            AsyncHandler<ListNamedShadowsForThingRequest,ListNamedShadowsForThingResult> asyncHandler)

Description copied from interface: AWSIotDataAsync

Lists the shadows for the specified thing.

Specified by:

listNamedShadowsForThingAsync in interface AWSIotDataAsync

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

public Future<PublishResult> publishAsync(PublishRequest request)

Description copied from interface: AWSIotDataAsync

Publishes state information.

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

Specified by:

publishAsync in interface AWSIotDataAsync

Parameters:

request - The input for the Publish operation.

Returns:

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

publishAsync

public Future<PublishResult> publishAsync(PublishRequest request,
                                          AsyncHandler<PublishRequest,PublishResult> asyncHandler)

Description copied from interface: AWSIotDataAsync

Publishes state information.

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

Specified by:

publishAsync in interface AWSIotDataAsync

Parameters:

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

public Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest request)

Description copied from interface: AWSIotDataAsync

Updates the shadow for the specified thing.

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

Specified by:

updateThingShadowAsync in interface AWSIotDataAsync

Parameters:

request - The input for the UpdateThingShadow operation.

Returns:

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

updateThingShadowAsync

public Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest request,
                                                              AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler)

Description copied from interface: AWSIotDataAsync

Updates the shadow for the specified thing.

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

Specified by:

updateThingShadowAsync in interface AWSIotDataAsync

Parameters:

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

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSIotData

Overrides:

shutdown in class AWSIotDataClient