com.amazonaws.services.iotdata

Interface AWSIotData

All Known Implementing Classes:

AWSIotDataClient

public interface AWSIotData

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

Method Summary

Modifier and Type	Method and Description
DeleteThingShadowResult	deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest) 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.
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.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://data.iot.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateThingShadowResult	updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest) Updates the shadow for the specified thing.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://data.iot.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "data.iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://data.iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "data.iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://data.iot.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteThingShadow

DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

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:

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

GetThingShadowResult getThingShadow(GetThingShadowRequest getThingShadowRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

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:

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

ListNamedShadowsForThingResult listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Lists the shadows for the specified thing.

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

void publish(PublishRequest publishRequest)
      throws AmazonClientException,
             AmazonServiceException

Publishes state information.

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

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

UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

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:

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.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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