/* * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.iotdata; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.iotdata.model.*; /** * Interface for accessing AWS IoT Data <fullname>AWS IoT</fullname> * <p> * 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 thing shadows. A thing shadow is a persistent representation of your * things and their state in the AWS cloud. * </p> **/ public interface AWSIotData { /** * 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. * <p> * 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 * {@link ClientConfiguration} will be used, which by default is HTTPS. * <p> * 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: <a * href= * "http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912" * > http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912</a> * <p> * <b>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.</b> * * @param 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 IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AWSIotData#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. * <p> * By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. * <p> * <b>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.</b> * * @param region The region this client will communicate with. See * {@link 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 * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** * <p> * Deletes the thing shadow for the specified thing. * </p> * <p> * For more information, see <a href= * "http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html" * >DeleteThingShadow</a> in the <i>AWS IoT Developer Guide</i>. * </p> * * @param deleteThingShadowRequest <p> * The input for the DeleteThingShadow operation. * </p> * @return deleteThingShadowResult The response from the DeleteThingShadow * service method, as returned by AWS IoT Data. * @throws ResourceNotFoundException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws MethodNotAllowedException * @throws UnsupportedDocumentEncodingException * @throws 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. * @throws 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. */ DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest) throws AmazonClientException, AmazonServiceException; /** * <p> * Gets the thing shadow for the specified thing. * </p> * <p> * For more information, see <a href= * "http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html" * >GetThingShadow</a> in the <i>AWS IoT Developer Guide</i>. * </p> * * @param getThingShadowRequest <p> * The input for the GetThingShadow operation. * </p> * @return getThingShadowResult The response from the GetThingShadow service * method, as returned by AWS IoT Data. * @throws InvalidRequestException * @throws ResourceNotFoundException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws MethodNotAllowedException * @throws UnsupportedDocumentEncodingException * @throws 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. * @throws 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. */ GetThingShadowResult getThingShadow(GetThingShadowRequest getThingShadowRequest) throws AmazonClientException, AmazonServiceException; /** * <p> * Publishes state information. * </p> * <p> * For more information, see <a href= * "http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http" * >HTTP Protocol</a> in the <i>AWS IoT Developer Guide</i>. * </p> * * @param publishRequest <p> * The input for the Publish operation. * </p> * @throws InternalFailureException * @throws InvalidRequestException * @throws UnauthorizedException * @throws MethodNotAllowedException * @throws 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. * @throws 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. */ void publish(PublishRequest publishRequest) throws AmazonClientException, AmazonServiceException; /** * <p> * Updates the thing shadow for the specified thing. * </p> * <p> * For more information, see <a href= * "http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html" * >UpdateThingShadow</a> in the <i>AWS IoT Developer Guide</i>. * </p> * * @param updateThingShadowRequest <p> * The input for the UpdateThingShadow operation. * </p> * @return updateThingShadowResult The response from the UpdateThingShadow * service method, as returned by AWS IoT Data. * @throws ConflictException * @throws RequestEntityTooLargeException * @throws InvalidRequestException * @throws ThrottlingException * @throws UnauthorizedException * @throws ServiceUnavailableException * @throws InternalFailureException * @throws MethodNotAllowedException * @throws UnsupportedDocumentEncodingException * @throws 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. * @throws 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. */ UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest) throws AmazonClientException, AmazonServiceException; /** * 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. */ public void shutdown(); /** * 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. * <p> * 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. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }