Package software.amazon.awssdk.services.iotdataplane

Interface IoTDataPlaneClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface IoTDataPlaneClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. 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 thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static IoTDataPlaneClientBuilder	builder()	Create a builder that can be used to configure and create a IoTDataPlaneClient.
static IoTDataPlaneClient	create()	Create a IoTDataPlaneClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteThingShadowResponse	deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)	Deletes the thing shadow for the specified thing.
default GetThingShadowResponse	getThingShadow(GetThingShadowRequest getThingShadowRequest)	Gets the thing shadow for the specified thing.
default PublishResponse	publish(PublishRequest publishRequest)	Publishes state information.
static ServiceMetadata	serviceMetadata()
default UpdateThingShadowResponse	updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)	Updates the thing shadow for the specified thing.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static IoTDataPlaneClient create()

Create a IoTDataPlaneClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IoTDataPlaneClientBuilder builder()

Create a builder that can be used to configure and create a IoTDataPlaneClient.

deleteThingShadow

default DeleteThingShadowResponse deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)
                                             throws ResourceNotFoundException,
                                                    InvalidRequestException,
                                                    ThrottlingException,
                                                    UnauthorizedException,
                                                    ServiceUnavailableException,
                                                    InternalFailureException,
                                                    MethodNotAllowedException,
                                                    UnsupportedDocumentEncodingException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    IoTDataPlaneException

Deletes the thing 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:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

IoTDataPlaneException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getThingShadow

default GetThingShadowResponse getThingShadow(GetThingShadowRequest getThingShadowRequest)
                                       throws InvalidRequestException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              UnauthorizedException,
                                              ServiceUnavailableException,
                                              InternalFailureException,
                                              MethodNotAllowedException,
                                              UnsupportedDocumentEncodingException,
                                              SdkBaseException,
                                              SdkClientException,
                                              IoTDataPlaneException

Gets the thing 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:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

IoTDataPlaneException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

publish

default PublishResponse publish(PublishRequest publishRequest)
                         throws InternalFailureException,
                                InvalidRequestException,
                                UnauthorizedException,
                                MethodNotAllowedException,
                                SdkBaseException,
                                SdkClientException,
                                IoTDataPlaneException

Publishes state information.

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

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

IoTDataPlaneException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateThingShadow

default UpdateThingShadowResponse updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)
                                             throws ConflictException,
                                                    RequestEntityTooLargeException,
                                                    InvalidRequestException,
                                                    ThrottlingException,
                                                    UnauthorizedException,
                                                    ServiceUnavailableException,
                                                    InternalFailureException,
                                                    MethodNotAllowedException,
                                                    UnsupportedDocumentEncodingException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    IoTDataPlaneException

Updates the thing 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:

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

IoTDataPlaneException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

serviceMetadata

static ServiceMetadata serviceMetadata()