@Generated(value="software.amazon.awssdk:codegen") public interface IotDataPlaneClient extends SdkClient
builder()
method.
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.
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 |
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.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static IotDataPlaneClient create()
IotDataPlaneClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static IotDataPlaneClientBuilder builder()
IotDataPlaneClient
.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.
deleteThingShadowRequest
- The input for the DeleteThingShadow operation.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
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()
deleteThingShadowRequest
- A Consumer
that will call methods on DeleteThingShadowRequest.Builder
to create a request.
The input for the DeleteThingShadow operation.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
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.
getThingShadowRequest
- The input for the GetThingShadow operation.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
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()
getThingShadowRequest
- A Consumer
that will call methods on GetThingShadowRequest.Builder
to create a request.
The input for the GetThingShadow operation.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
default ListNamedShadowsForThingResponse listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, MethodNotAllowedException, AwsServiceException, SdkClientException, IotDataPlaneException
Lists the shadows for the specified thing.
listNamedShadowsForThingRequest
- 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
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()
listNamedShadowsForThingRequest
- A Consumer
that will call methods on ListNamedShadowsForThingRequest.Builder
to create a
request.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
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.
publishRequest
- The input for the Publish operation.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
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()
publishRequest
- A Consumer
that will call methods on PublishRequest.Builder
to create a request. The input
for the Publish operation.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
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.
updateThingShadowRequest
- The input for the UpdateThingShadow operation.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
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()
updateThingShadowRequest
- A Consumer
that will call methods on UpdateThingShadowRequest.Builder
to create a request.
The input for the UpdateThingShadow operation.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
static ServiceMetadata serviceMetadata()