Interface Iot1ClickDevicesAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface Iot1ClickDevicesAsyncClient extends AwsClient
Service client for accessing AWS IoT 1-Click Devices Service asynchronously. This can be created using the staticbuilder()method.Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static Iot1ClickDevicesAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aIot1ClickDevicesAsyncClient.default CompletableFuture<ClaimDevicesByClaimCodeResponse>claimDevicesByClaimCode(Consumer<ClaimDevicesByClaimCodeRequest.Builder> claimDevicesByClaimCodeRequest)Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).default CompletableFuture<ClaimDevicesByClaimCodeResponse>claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest)Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).static Iot1ClickDevicesAsyncClientcreate()Create aIot1ClickDevicesAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<DescribeDeviceResponse>describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.default CompletableFuture<DescribeDeviceResponse>describeDevice(DescribeDeviceRequest describeDeviceRequest)Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.default CompletableFuture<FinalizeDeviceClaimResponse>finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)Given a device ID, finalizes the claim request for the associated device.default CompletableFuture<FinalizeDeviceClaimResponse>finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)Given a device ID, finalizes the claim request for the associated device.default CompletableFuture<GetDeviceMethodsResponse>getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)Given a device ID, returns the invokable methods associated with the device.default CompletableFuture<GetDeviceMethodsResponse>getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)Given a device ID, returns the invokable methods associated with the device.default CompletableFuture<InitiateDeviceClaimResponse>initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)Given a device ID, initiates a claim request for the associated device.default CompletableFuture<InitiateDeviceClaimResponse>initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)Given a device ID, initiates a claim request for the associated device.default CompletableFuture<InvokeDeviceMethodResponse>invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)Given a device ID, issues a request to invoke a named device method (with possible parameters).default CompletableFuture<InvokeDeviceMethodResponse>invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)Given a device ID, issues a request to invoke a named device method (with possible parameters).default CompletableFuture<ListDeviceEventsResponse>listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.default CompletableFuture<ListDeviceEventsResponse>listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.default CompletableFuture<ListDevicesResponse>listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)Lists the 1-Click compatible devices associated with your AWS account.default CompletableFuture<ListDevicesResponse>listDevices(ListDevicesRequest listDevicesRequest)Lists the 1-Click compatible devices associated with your AWS account.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags associated with the specified resource ARN.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags associated with the specified resource ARN.default Iot1ClickDevicesServiceClientConfigurationserviceClientConfiguration()default CompletableFuture<TagResourceResponse>tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds or updates the tags associated with the resource ARN.default CompletableFuture<TagResourceResponse>tagResource(TagResourceRequest tagResourceRequest)Adds or updates the tags associated with the resource ARN.default CompletableFuture<UnclaimDeviceResponse>unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)Disassociates a device from your AWS account using its device ID.default CompletableFuture<UnclaimDeviceResponse>unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)Disassociates a device from your AWS account using its device ID.default CompletableFuture<UntagResourceResponse>untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.default CompletableFuture<UntagResourceResponse>untagResource(UntagResourceRequest untagResourceRequest)Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.default CompletableFuture<UpdateDeviceStateResponse>updateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest)Using a Boolean value (true or false), this operation enables or disables the device given a device ID.default CompletableFuture<UpdateDeviceStateResponse>updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)Using a Boolean value (true or false), this operation enables or disables the device given a device ID.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
claimDevicesByClaimCode
default CompletableFuture<ClaimDevicesByClaimCodeResponse> claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
- Parameters:
claimDevicesByClaimCodeRequest-- Returns:
- A Java Future containing the result of the ClaimDevicesByClaimCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException 400 response
- InternalFailureException 500 response
- ForbiddenException 403 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
claimDevicesByClaimCode
default CompletableFuture<ClaimDevicesByClaimCodeResponse> claimDevicesByClaimCode(Consumer<ClaimDevicesByClaimCodeRequest.Builder> claimDevicesByClaimCodeRequest)
Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
This is a convenience which creates an instance of the
ClaimDevicesByClaimCodeRequest.Builderavoiding the need to create one manually viaClaimDevicesByClaimCodeRequest.builder()- Parameters:
claimDevicesByClaimCodeRequest- AConsumerthat will call methods onClaimDevicesByClaimCodeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ClaimDevicesByClaimCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException 400 response
- InternalFailureException 500 response
- ForbiddenException 403 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDevice
default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
- Parameters:
describeDeviceRequest-- Returns:
- A Java Future containing the result of the DescribeDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDevice
default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
This is a convenience which creates an instance of the
DescribeDeviceRequest.Builderavoiding the need to create one manually viaDescribeDeviceRequest.builder()- Parameters:
describeDeviceRequest- AConsumerthat will call methods onDescribeDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
finalizeDeviceClaim
default CompletableFuture<FinalizeDeviceClaimResponse> finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
- Parameters:
finalizeDeviceClaimRequest-- Returns:
- A Java Future containing the result of the FinalizeDeviceClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- PreconditionFailedException 412 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
finalizeDeviceClaim
default CompletableFuture<FinalizeDeviceClaimResponse> finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
This is a convenience which creates an instance of the
FinalizeDeviceClaimRequest.Builderavoiding the need to create one manually viaFinalizeDeviceClaimRequest.builder()- Parameters:
finalizeDeviceClaimRequest- AConsumerthat will call methods onFinalizeDeviceClaimRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the FinalizeDeviceClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- PreconditionFailedException 412 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDeviceMethods
default CompletableFuture<GetDeviceMethodsResponse> getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
- Parameters:
getDeviceMethodsRequest-- Returns:
- A Java Future containing the result of the GetDeviceMethods operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDeviceMethods
default CompletableFuture<GetDeviceMethodsResponse> getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
This is a convenience which creates an instance of the
GetDeviceMethodsRequest.Builderavoiding the need to create one manually viaGetDeviceMethodsRequest.builder()- Parameters:
getDeviceMethodsRequest- AConsumerthat will call methods onGetDeviceMethodsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDeviceMethods operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
initiateDeviceClaim
default CompletableFuture<InitiateDeviceClaimResponse> initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
- Parameters:
initiateDeviceClaimRequest-- Returns:
- A Java Future containing the result of the InitiateDeviceClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
initiateDeviceClaim
default CompletableFuture<InitiateDeviceClaimResponse> initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
This is a convenience which creates an instance of the
InitiateDeviceClaimRequest.Builderavoiding the need to create one manually viaInitiateDeviceClaimRequest.builder()- Parameters:
initiateDeviceClaimRequest- AConsumerthat will call methods onInitiateDeviceClaimRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the InitiateDeviceClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
invokeDeviceMethod
default CompletableFuture<InvokeDeviceMethodResponse> invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
- Parameters:
invokeDeviceMethodRequest-- Returns:
- A Java Future containing the result of the InvokeDeviceMethod operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException 400 response
- PreconditionFailedException 412 response
- InternalFailureException 500 response
- ResourceNotFoundException 404 response
- RangeNotSatisfiableException 416 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
invokeDeviceMethod
default CompletableFuture<InvokeDeviceMethodResponse> invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
This is a convenience which creates an instance of the
InvokeDeviceMethodRequest.Builderavoiding the need to create one manually viaInvokeDeviceMethodRequest.builder()- Parameters:
invokeDeviceMethodRequest- AConsumerthat will call methods onInvokeDeviceMethodRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the InvokeDeviceMethod operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException 400 response
- PreconditionFailedException 412 response
- InternalFailureException 500 response
- ResourceNotFoundException 404 response
- RangeNotSatisfiableException 416 response
- ResourceConflictException 409 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDeviceEvents
default CompletableFuture<ListDeviceEventsResponse> listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
- Parameters:
listDeviceEventsRequest-- Returns:
- A Java Future containing the result of the ListDeviceEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- RangeNotSatisfiableException 416 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDeviceEvents
default CompletableFuture<ListDeviceEventsResponse> listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
This is a convenience which creates an instance of the
ListDeviceEventsRequest.Builderavoiding the need to create one manually viaListDeviceEventsRequest.builder()- Parameters:
listDeviceEventsRequest- AConsumerthat will call methods onListDeviceEventsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDeviceEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- RangeNotSatisfiableException 416 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDevices
default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
- Parameters:
listDevicesRequest-- Returns:
- A Java Future containing the result of the ListDevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RangeNotSatisfiableException 416 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDevices
default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RangeNotSatisfiableException 416 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the specified resource ARN.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with the specified resource ARN.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
unclaimDevice
default CompletableFuture<UnclaimDeviceResponse> unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
- Parameters:
unclaimDeviceRequest-- Returns:
- A Java Future containing the result of the UnclaimDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
unclaimDevice
default CompletableFuture<UnclaimDeviceResponse> unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
This is a convenience which creates an instance of the
UnclaimDeviceRequest.Builderavoiding the need to create one manually viaUnclaimDeviceRequest.builder()- Parameters:
unclaimDeviceRequest- AConsumerthat will call methods onUnclaimDeviceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UnclaimDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDeviceState
default CompletableFuture<UpdateDeviceStateResponse> updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
- Parameters:
updateDeviceStateRequest-- Returns:
- A Java Future containing the result of the UpdateDeviceState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDeviceState
default CompletableFuture<UpdateDeviceStateResponse> updateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
This is a convenience which creates an instance of the
UpdateDeviceStateRequest.Builderavoiding the need to create one manually viaUpdateDeviceStateRequest.builder()- Parameters:
updateDeviceStateRequest- AConsumerthat will call methods onUpdateDeviceStateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDeviceState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException 404 response
- InvalidRequestException 400 response
- InternalFailureException 500 response
- 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.
- Iot1ClickDevicesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default Iot1ClickDevicesServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static Iot1ClickDevicesAsyncClient create()
Create aIot1ClickDevicesAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static Iot1ClickDevicesAsyncClientBuilder builder()
Create a builder that can be used to configure and create aIot1ClickDevicesAsyncClient.
-
-