com.amazonaws.services.iotdata

Class AWSIotDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotdata.AWSIotDataClient

All Implemented Interfaces:

AWSIotData

public class AWSIotDataClient
extends AmazonWebServiceClient
implements AWSIotData

Client for accessing AWS IoT Data. All service calls made using this client are blocking, and will not return until the service call 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

Constructor Summary

Constructors

Constructor and Description
AWSIotDataClient() Deprecated.
AWSIotDataClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials.
AWSIotDataClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials and client configuration options.
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider.
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider and client configuration options.
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AWSIotDataClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
DeleteThingShadowResult	deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest) Deletes the shadow for the specified thing.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetThingShadowResult	getThingShadow(GetThingShadowRequest getThingShadowRequest) Gets the shadow for the specified thing.
ListNamedShadowsForThingResult	listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
void	publish(PublishRequest publishRequest) Publishes state information.
UpdateThingShadowResult	updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest) Updates the shadow for the specified thing.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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

setEndpoint, setRegion, shutdown

Constructor Detail

AWSIotDataClient

@Deprecated
public AWSIotDataClient()

Deprecated.

Constructs a new client to invoke service methods on AWSIotData. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSIotDataClient

@Deprecated
public AWSIotDataClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AWSIotData. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

See Also:

DefaultAWSCredentialsProviderChain

AWSIotDataClient

public AWSIotDataClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSIotDataClient client = new AWSIotDataClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

AWSIotDataClient

public AWSIotDataClient(AWSCredentials awsCredentials,
                        ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSIotDataClient client = new AWSIotDataClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

AWSIotDataClient

public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSIotDataClient client = new AWSIotDataClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

AWSIotDataClient

public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSIotDataClient client = new AWSIotDataClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

AWSIotDataClient

@Deprecated
public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

requestMetricCollector - optional request metric collector

AWSIotDataClient

public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration,
                        HttpClient httpClient)

Constructs a new client to invoke service methods on AWSIotData using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSIotDataClient client = new AWSIotDataClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

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

httpClient - A http client

Method Detail

deleteThingShadow

public DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Deletes the shadow for the specified thing.

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

Specified by:

deleteThingShadow in interface AWSIotData

Parameters:

deleteThingShadowRequest -

The input for the DeleteThingShadow operation.

Returns:

deleteThingShadowResult The response from the DeleteThingShadow service method, as returned by AWS IoT Data.

Throws:

ResourceNotFoundException

InvalidRequestException

ThrottlingException

UnauthorizedException

ServiceUnavailableException

InternalFailureException

MethodNotAllowedException

UnsupportedDocumentEncodingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS IoT Data indicating either a problem with the data in the request, or a server side issue.

getThingShadow

public GetThingShadowResult getThingShadow(GetThingShadowRequest getThingShadowRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Gets the shadow for the specified thing.

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

Specified by:

getThingShadow in interface AWSIotData

Parameters:

getThingShadowRequest -

The input for the GetThingShadow operation.

Returns:

getThingShadowResult The response from the GetThingShadow service method, as returned by AWS IoT Data.

Throws:

InvalidRequestException

ResourceNotFoundException

ThrottlingException

UnauthorizedException

ServiceUnavailableException

InternalFailureException

MethodNotAllowedException

UnsupportedDocumentEncodingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS IoT Data indicating either a problem with the data in the request, or a server side issue.

listNamedShadowsForThing

public ListNamedShadowsForThingResult listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists the shadows for the specified thing.

Specified by:

listNamedShadowsForThing in interface AWSIotData

Parameters:

listNamedShadowsForThingRequest -

Returns:

listNamedShadowsForThingResult The response from the ListNamedShadowsForThing service method, as returned by AWS IoT Data.

Throws:

ResourceNotFoundException

InvalidRequestException

ThrottlingException

UnauthorizedException

ServiceUnavailableException

InternalFailureException

MethodNotAllowedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS IoT Data indicating either a problem with the data in the request, or a server side issue.

publish

public void publish(PublishRequest publishRequest)
             throws AmazonServiceException,
                    AmazonClientException

Publishes state information.

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

Specified by:

publish in interface AWSIotData

Parameters:

publishRequest -

The input for the Publish operation.

Throws:

InternalFailureException

InvalidRequestException

UnauthorizedException

MethodNotAllowedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS IoT Data indicating either a problem with the data in the request, or a server side issue.

updateThingShadow

public UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Updates the shadow for the specified thing.

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

Specified by:

updateThingShadow in interface AWSIotData

Parameters:

updateThingShadowRequest -

The input for the UpdateThingShadow operation.

Returns:

updateThingShadowResult The response from the UpdateThingShadow service method, as returned by AWS IoT Data.

Throws:

ConflictException

RequestEntityTooLargeException

InvalidRequestException

ThrottlingException

UnauthorizedException

ServiceUnavailableException

InternalFailureException

MethodNotAllowedException

UnsupportedDocumentEncodingException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWS IoT Data indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSIotData

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.