software.amazon.awssdk.services.iotdataplane

Interface IotDataPlaneAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS IoT Data Plane asynchronously. 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 IotDataPlaneAsyncClientBuilder	builder() Create a builder that can be used to configure and create a IotDataPlaneAsyncClient.
static IotDataPlaneAsyncClient	create() Create a IotDataPlaneAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<DeleteThingShadowResponse>	deleteThingShadow(Consumer<DeleteThingShadowRequest.Builder> deleteThingShadowRequest) Deletes the shadow for the specified thing.
default CompletableFuture<DeleteThingShadowResponse>	deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest) Deletes the shadow for the specified thing.
default CompletableFuture<GetThingShadowResponse>	getThingShadow(Consumer<GetThingShadowRequest.Builder> getThingShadowRequest) Gets the shadow for the specified thing.
default CompletableFuture<GetThingShadowResponse>	getThingShadow(GetThingShadowRequest getThingShadowRequest) Gets the shadow for the specified thing.
default CompletableFuture<ListNamedShadowsForThingResponse>	listNamedShadowsForThing(Consumer<ListNamedShadowsForThingRequest.Builder> listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
default CompletableFuture<ListNamedShadowsForThingResponse>	listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest) Lists the shadows for the specified thing.
default CompletableFuture<PublishResponse>	publish(Consumer<PublishRequest.Builder> publishRequest) Publishes state information.
default CompletableFuture<PublishResponse>	publish(PublishRequest publishRequest) Publishes state information.
default CompletableFuture<UpdateThingShadowResponse>	updateThingShadow(Consumer<UpdateThingShadowRequest.Builder> updateThingShadowRequest) Updates the shadow for the specified thing.
default CompletableFuture<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 IotDataPlaneAsyncClient create()

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

builder

static IotDataPlaneAsyncClientBuilder builder()

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

deleteThingShadow

default CompletableFuture<DeleteThingShadowResponse> deleteThingShadow(DeleteThingShadowRequest deleteThingShadowRequest)

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:

A Java Future containing the result of the DeleteThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

deleteThingShadow

default CompletableFuture<DeleteThingShadowResponse> deleteThingShadow(Consumer<DeleteThingShadowRequest.Builder> deleteThingShadowRequest)

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:

A Java Future containing the result of the DeleteThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

getThingShadow

default CompletableFuture<GetThingShadowResponse> getThingShadow(GetThingShadowRequest getThingShadowRequest)

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:

A Java Future containing the result of the GetThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

getThingShadow

default CompletableFuture<GetThingShadowResponse> getThingShadow(Consumer<GetThingShadowRequest.Builder> getThingShadowRequest)

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:

A Java Future containing the result of the GetThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

listNamedShadowsForThing

default CompletableFuture<ListNamedShadowsForThingResponse> listNamedShadowsForThing(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest)

Lists the shadows for the specified thing.

Parameters:

listNamedShadowsForThingRequest -

Returns:

A Java Future containing the result of the ListNamedShadowsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

listNamedShadowsForThing

default CompletableFuture<ListNamedShadowsForThingResponse> listNamedShadowsForThing(Consumer<ListNamedShadowsForThingRequest.Builder> listNamedShadowsForThingRequest)

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:

A Java Future containing the result of the ListNamedShadowsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

publish

default CompletableFuture<PublishResponse> publish(PublishRequest publishRequest)

Publishes state information.

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

Parameters:

publishRequest - The input for the Publish operation.

Returns:

A Java Future containing the result of the Publish operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

publish

default CompletableFuture<PublishResponse> publish(Consumer<PublishRequest.Builder> publishRequest)

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:

A Java Future containing the result of the Publish operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

updateThingShadow

default CompletableFuture<UpdateThingShadowResponse> updateThingShadow(UpdateThingShadowRequest updateThingShadowRequest)

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:

A Java Future containing the result of the UpdateThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.

updateThingShadow

default CompletableFuture<UpdateThingShadowResponse> updateThingShadow(Consumer<UpdateThingShadowRequest.Builder> updateThingShadowRequest)

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:

A Java Future containing the result of the UpdateThingShadow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.