Package software.amazon.awssdk.services.iot1clickdevices

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 static builder() 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 Details

  • Method Details

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

    • 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.Builder avoiding the need to create one manually via ClaimDevicesByClaimCodeRequest.builder()

      Parameters:
      claimDevicesByClaimCodeRequest - A Consumer that will call methods on ClaimDevicesByClaimCodeRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via DescribeDeviceRequest.builder()

      Parameters:
      describeDeviceRequest - A Consumer that will call methods on DescribeDeviceRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via FinalizeDeviceClaimRequest.builder()

      Parameters:
      finalizeDeviceClaimRequest - A Consumer that will call methods on FinalizeDeviceClaimRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via GetDeviceMethodsRequest.builder()

      Parameters:
      getDeviceMethodsRequest - A Consumer that will call methods on GetDeviceMethodsRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via InitiateDeviceClaimRequest.builder()

      Parameters:
      initiateDeviceClaimRequest - A Consumer that will call methods on InitiateDeviceClaimRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via InvokeDeviceMethodRequest.builder()

      Parameters:
      invokeDeviceMethodRequest - A Consumer that will call methods on InvokeDeviceMethodRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via ListDeviceEventsRequest.builder()

      Parameters:
      listDeviceEventsRequest - A Consumer that will call methods on ListDeviceEventsRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via ListDevicesRequest.builder()

      Parameters:
      listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via UnclaimDeviceRequest.builder()

      Parameters:
      unclaimDeviceRequest - A Consumer that will call methods on UnclaimDeviceRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to 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:

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

    • 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.Builder avoiding the need to create one manually via UpdateDeviceStateRequest.builder()

      Parameters:
      updateDeviceStateRequest - A Consumer that will call methods on UpdateDeviceStateRequest.Builder to 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:

    • serviceClientConfiguration

      default Iot1ClickDevicesServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static Iot1ClickDevicesAsyncClient create()
      Create a Iot1ClickDevicesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static Iot1ClickDevicesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a Iot1ClickDevicesAsyncClient.