AWSIotData (AWS SDK for Java

All Known Subinterfaces:

AWSIotDataAsync

All Known Implementing Classes:

AbstractAWSIotData, AbstractAWSIotDataAsync, AWSIotDataAsyncClient, AWSIotDataClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIotData
```
Interface for accessing AWS IoT Data Plane.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIotData instead.

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

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.
`GetRetainedMessageResult`	`getRetainedMessage(GetRetainedMessageRequest getRetainedMessageRequest)` Gets the details of a single retained message for the specified topic.
`GetThingShadowResult`	`getThingShadow(GetThingShadowRequest getThingShadowRequest)` Gets the shadow for the specified thing.
`ListNamedShadowsForThingResult`	`listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)` Lists the shadows for the specified thing.
`ListRetainedMessagesResult`	`listRetainedMessages(ListRetainedMessagesRequest listRetainedMessagesRequest)` Lists summary information about the retained messages stored for the account.
`PublishResult`	`publish(PublishRequest publishRequest)` Publishes an MQTT message.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    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. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - deleteThingShadow
```
DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)
```
    Deletes the shadow for the specified thing.
    
    Requires permission to access the DeleteThingShadow action.
    
    For more information, see DeleteThingShadow in the IoT Developer Guide.
    
    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
```
GetRetainedMessageResult getRetainedMessage(GetRetainedMessageRequest getRetainedMessageRequest)
```
    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.
    
    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
```
GetThingShadowResult getThingShadow(GetThingShadowRequest getThingShadowRequest)
```
    Gets the shadow for the specified thing.
    
    Requires permission to access the GetThingShadow action.
    
    For more information, see GetThingShadow in the IoT Developer Guide.
    
    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
```
ListNamedShadowsForThingResult listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)
```
    Lists the shadows for the specified thing.
    
    Requires permission to access the ListNamedShadowsForThing action.
    
    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
```
ListRetainedMessagesResult listRetainedMessages(ListRetainedMessagesRequest listRetainedMessagesRequest)
```
    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.
    
    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
```
PublishResult publish(PublishRequest publishRequest)
```
    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.
    
    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
```
UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)
```
    Updates the shadow for the specified thing.
    
    Requires permission to access the UpdateThingShadow action.
    
    For more information, see UpdateThingShadow in the IoT Developer Guide.
    
    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
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.782

Interface AWSIotData

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

deleteThingShadow

getRetainedMessage

getThingShadow

listNamedShadowsForThing

listRetainedMessages

publish

updateThingShadow

shutdown

getCachedResponseMetadata