com.amazonaws.services.iotdata

Class AWSIotDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotdata.AWSIotDataClient

All Implemented Interfaces:

AWSIotData

Direct Known Subclasses:

AWSIotDataAsyncClient

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

Client for accessing AWS IoT Data Plane. All service calls made using this client are blocking, and will not return until the service call completes.

IoT data

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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 Amazon Web Services cloud.

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

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

The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSIotDataClient() Deprecated. use AWSIotDataClientBuilder.defaultClient()
AWSIotDataClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSIotDataClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSIotDataClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSIotDataClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSIotDataClientBuilder	builder()
DeleteThingShadowResult	deleteThingShadow(DeleteThingShadowRequest request) Deletes the shadow for the specified thing.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetRetainedMessageResult	getRetainedMessage(GetRetainedMessageRequest request) Gets the details of a single retained message for the specified topic.
GetThingShadowResult	getThingShadow(GetThingShadowRequest request) Gets the shadow for the specified thing.
ListNamedShadowsForThingResult	listNamedShadowsForThing(ListNamedShadowsForThingRequest request) Lists the shadows for the specified thing.
ListRetainedMessagesResult	listRetainedMessages(ListRetainedMessagesRequest request) Lists summary information about the retained messages stored for the account.
PublishResult	publish(PublishRequest request) Publishes an MQTT message.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateThingShadowResult	updateThingShadow(UpdateThingShadowRequest request) Updates the shadow for the specified thing.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, 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, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSIotDataClient

@Deprecated
public AWSIotDataClient()

Deprecated. use AWSIotDataClientBuilder.defaultClient()

Constructs a new 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
• 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. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new 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
• 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 AWS IoT Data Plane (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSIotDataClient

@Deprecated
public AWSIotDataClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSIotDataClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

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

@Deprecated
public AWSIotDataClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration)

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

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

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 AWS IoT Data Plane (ex: proxy settings, retry counts, etc.).

AWSIotDataClient

@Deprecated
public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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

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

@Deprecated
public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration)

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

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

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 AWS IoT Data Plane (ex: proxy settings, retry counts, etc.).

AWSIotDataClient

@Deprecated
public AWSIotDataClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    RequestMetricCollector requestMetricCollector)

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

Constructs a new client to invoke service methods on AWS IoT Data Plane 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 AWS IoT Data Plane (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSIotDataClientBuilder builder()

deleteThingShadow

public DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest request)

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

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

Specified by:

deleteThingShadow in interface AWSIotData

Parameters:

deleteThingShadowRequest - The input for the DeleteThingShadow operation.

Returns:

Result of the DeleteThingShadow operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

InvalidRequestException - The request is not valid.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

UnsupportedDocumentEncodingException - The document encoding is not supported.

See Also:

AWS API Documentation

getRetainedMessage

public GetRetainedMessageResult getRetainedMessage(GetRetainedMessageRequest request)

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages.

Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

Specified by:

getRetainedMessage in interface AWSIotData

Parameters:

getRetainedMessageRequest - The input for the GetRetainedMessage operation.

Returns:

Result of the GetRetainedMessage operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

See Also:

AWS API Documentation

getThingShadow

public GetThingShadowResult getThingShadow(GetThingShadowRequest request)

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

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

Specified by:

getThingShadow in interface AWSIotData

Parameters:

getThingShadowRequest - The input for the GetThingShadow operation.

Returns:

Result of the GetThingShadow operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ResourceNotFoundException - The specified resource does not exist.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

UnsupportedDocumentEncodingException - The document encoding is not supported.

See Also:

AWS API Documentation

listNamedShadowsForThing

public ListNamedShadowsForThingResult listNamedShadowsForThing(ListNamedShadowsForThingRequest request)

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

Specified by:

listNamedShadowsForThing in interface AWSIotData

Parameters:

listNamedShadowsForThingRequest -

Returns:

Result of the ListNamedShadowsForThing operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

InvalidRequestException - The request is not valid.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

See Also:

AWS API Documentation

listRetainedMessages

public ListRetainedMessagesResult listRetainedMessages(ListRetainedMessagesRequest request)

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

Specified by:

listRetainedMessages in interface AWSIotData

Parameters:

listRetainedMessagesRequest -

Returns:

Result of the ListRetainedMessages operation returned by the service.

Throws:

InvalidRequestException - The request is not valid.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

See Also:

AWS API Documentation

publish

public PublishResult publish(PublishRequest request)

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

Specified by:

publish in interface AWSIotData

Parameters:

publishRequest - The input for the Publish operation.

Returns:

Result of the Publish operation returned by the service.

Throws:

InternalFailureException - An unexpected error has occurred.

InvalidRequestException - The request is not valid.

UnauthorizedException - You are not authorized to perform this operation.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

ThrottlingException - The rate exceeds the limit.

See Also:

AWS API Documentation

updateThingShadow

public UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest request)

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

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

Specified by:

updateThingShadow in interface AWSIotData

Parameters:

updateThingShadowRequest - The input for the UpdateThingShadow operation.

Returns:

Result of the UpdateThingShadow operation returned by the service.

Throws:

ConflictException - The specified version does not match the version of the document.

RequestEntityTooLargeException - The payload exceeds the maximum size allowed.

InvalidRequestException - The request is not valid.

ThrottlingException - The rate exceeds the limit.

UnauthorizedException - You are not authorized to perform this operation.

ServiceUnavailableException - The service is temporarily unavailable.

InternalFailureException - An unexpected error has occurred.

MethodNotAllowedException - The specified combination of HTTP verb and URI is not supported.

UnsupportedDocumentEncodingException - The document encoding is not supported.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

shutdown

public void shutdown()

Description copied from interface: AWSIotData

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSIotData

Overrides:

shutdown in class AmazonWebServiceClient