software.amazon.awssdk.services.iotdataplane

Interface IotDataPlaneClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface IotDataPlaneClient
extends SdkClient

Service client for accessing AWS IoT Data Plane. 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 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and 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(Consumer<DeleteThingShadowRequest.Builder> deleteThingShadowRequest) Deletes the shadow for the specified thing.
default DeleteThingShadowResponse	deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest) Deletes the shadow for the specified thing.
default GetThingShadowResponse	getThingShadow(Consumer<GetThingShadowRequest.Builder> getThingShadowRequest) Gets the shadow for the specified thing.
default GetThingShadowResponse	getThingShadow(GetThingShadowRequest getThingShadowRequest) Gets the shadow for the specified thing.
default ListNamedShadowsForThingResponse	listNamedShadowsForThing(Consumer<ListNamedShadowsForThingRequest.Builder> listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
default ListNamedShadowsForThingResponse	listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
default PublishResponse	publish(Consumer<PublishRequest.Builder> publishRequest) Publishes state information.
default PublishResponse	publish(PublishRequest publishRequest) Publishes state information.
static ServiceMetadata	serviceMetadata()
default UpdateThingShadowResponse	updateThingShadow(Consumer<UpdateThingShadowRequest.Builder> updateThingShadowRequest) Updates the shadow for the specified thing.
default UpdateThingShadowResponse	updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest) Updates the shadow for the specified thing.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

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,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    IotDataPlaneException

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:

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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteThingShadow

default DeleteThingShadowResponse deleteThingShadow(Consumer<DeleteThingShadowRequest.Builder> deleteThingShadowRequest)
                                             throws ResourceNotFoundException,
                                                    InvalidRequestException,
                                                    ThrottlingException,
                                                    UnauthorizedException,
                                                    ServiceUnavailableException,
                                                    InternalFailureException,
                                                    MethodNotAllowedException,
                                                    UnsupportedDocumentEncodingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    IotDataPlaneException

Deletes the shadow for the specified thing.

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

This is a convenience which creates an instance of the DeleteThingShadowRequest.Builder avoiding the need to create one manually via DeleteThingShadowRequest.builder()

Parameters:

deleteThingShadowRequest - A Consumer that will call methods on DeleteThingShadowRequest.Builder to create a request. 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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

getThingShadow

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

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:

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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

getThingShadow

default GetThingShadowResponse getThingShadow(Consumer<GetThingShadowRequest.Builder> getThingShadowRequest)
                                       throws InvalidRequestException,
                                              ResourceNotFoundException,
                                              ThrottlingException,
                                              UnauthorizedException,
                                              ServiceUnavailableException,
                                              InternalFailureException,
                                              MethodNotAllowedException,
                                              UnsupportedDocumentEncodingException,
                                              AwsServiceException,
                                              SdkClientException,
                                              IotDataPlaneException

Gets the shadow for the specified thing.

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

This is a convenience which creates an instance of the GetThingShadowRequest.Builder avoiding the need to create one manually via GetThingShadowRequest.builder()

Parameters:

getThingShadowRequest - A Consumer that will call methods on GetThingShadowRequest.Builder to create a request. 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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

listNamedShadowsForThing

default ListNamedShadowsForThingResponse listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  ThrottlingException,
                                                                  UnauthorizedException,
                                                                  ServiceUnavailableException,
                                                                  InternalFailureException,
                                                                  MethodNotAllowedException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  IotDataPlaneException

Lists the shadows for the specified thing.

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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

listNamedShadowsForThing

default ListNamedShadowsForThingResponse listNamedShadowsForThing(Consumer<ListNamedShadowsForThingRequest.Builder> listNamedShadowsForThingRequest)
                                                           throws ResourceNotFoundException,
                                                                  InvalidRequestException,
                                                                  ThrottlingException,
                                                                  UnauthorizedException,
                                                                  ServiceUnavailableException,
                                                                  InternalFailureException,
                                                                  MethodNotAllowedException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  IotDataPlaneException

Lists the shadows for the specified thing.

This is a convenience which creates an instance of the ListNamedShadowsForThingRequest.Builder avoiding the need to create one manually via ListNamedShadowsForThingRequest.builder()

Parameters:

listNamedShadowsForThingRequest - A Consumer that will call methods on ListNamedShadowsForThingRequest.Builder to create a request.

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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

publish

default PublishResponse publish(PublishRequest publishRequest)
                         throws InternalFailureException,
                                InvalidRequestException,
                                UnauthorizedException,
                                MethodNotAllowedException,
                                AwsServiceException,
                                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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

publish

default PublishResponse publish(Consumer<PublishRequest.Builder> publishRequest)
                         throws InternalFailureException,
                                InvalidRequestException,
                                UnauthorizedException,
                                MethodNotAllowedException,
                                AwsServiceException,
                                SdkClientException,
                                IotDataPlaneException

Publishes state information.

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

This is a convenience which creates an instance of the PublishRequest.Builder avoiding the need to create one manually via PublishRequest.builder()

Parameters:

publishRequest - A Consumer that will call methods on PublishRequest.Builder to create a request. 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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateThingShadow

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

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:

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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateThingShadow

default UpdateThingShadowResponse updateThingShadow(Consumer<UpdateThingShadowRequest.Builder> updateThingShadowRequest)
                                             throws ConflictException,
                                                    RequestEntityTooLargeException,
                                                    InvalidRequestException,
                                                    ThrottlingException,
                                                    UnauthorizedException,
                                                    ServiceUnavailableException,
                                                    InternalFailureException,
                                                    MethodNotAllowedException,
                                                    UnsupportedDocumentEncodingException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    IotDataPlaneException

Updates the shadow for the specified thing.

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

This is a convenience which creates an instance of the UpdateThingShadowRequest.Builder avoiding the need to create one manually via UpdateThingShadowRequest.builder()

Parameters:

updateThingShadowRequest - A Consumer that will call methods on UpdateThingShadowRequest.Builder to create a request. 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.

SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

serviceMetadata

static ServiceMetadata serviceMetadata()