Package software.amazon.awssdk.services.iot1clickdevices

Interface Iot1ClickDevicesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Iot1ClickDevicesClient
extends AwsClient

Service client for accessing AWS IoT 1-Click Devices Service. 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 Summary

Fields

Modifier and Type	Field	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	Description
static Iot1ClickDevicesClientBuilder	builder()	Create a builder that can be used to configure and create a Iot1ClickDevicesClient.
default 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 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 Iot1ClickDevicesClient	create()	Create a Iot1ClickDevicesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeDeviceResponse	describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)	Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
default DescribeDeviceResponse	describeDevice(DescribeDeviceRequest describeDeviceRequest)	Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
default FinalizeDeviceClaimResponse	finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)	Given a device ID, finalizes the claim request for the associated device.
default FinalizeDeviceClaimResponse	finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)	Given a device ID, finalizes the claim request for the associated device.
default GetDeviceMethodsResponse	getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)	Given a device ID, returns the invokable methods associated with the device.
default GetDeviceMethodsResponse	getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)	Given a device ID, returns the invokable methods associated with the device.
default InitiateDeviceClaimResponse	initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)	Given a device ID, initiates a claim request for the associated device.
default InitiateDeviceClaimResponse	initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)	Given a device ID, initiates a claim request for the associated device.
default InvokeDeviceMethodResponse	invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)	Given a device ID, issues a request to invoke a named device method (with possible parameters).
default InvokeDeviceMethodResponse	invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)	Given a device ID, issues a request to invoke a named device method (with possible parameters).
default ListDeviceEventsResponse	listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)	Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
default ListDeviceEventsResponse	listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)	Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
default ListDevicesResponse	listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)	Lists the 1-Click compatible devices associated with your AWS account.
default ListDevicesResponse	listDevices(ListDevicesRequest listDevicesRequest)	Lists the 1-Click compatible devices associated with your AWS account.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags associated with the specified resource ARN.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags associated with the specified resource ARN.
default Iot1ClickDevicesServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or updates the tags associated with the resource ARN.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or updates the tags associated with the resource ARN.
default UnclaimDeviceResponse	unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)	Disassociates a device from your AWS account using its device ID.
default UnclaimDeviceResponse	unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)	Disassociates a device from your AWS account using its device ID.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
default 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 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 the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

claimDevicesByClaimCode

default ClaimDevicesByClaimCodeResponse claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest)
                                                         throws InvalidRequestException,
                                                                InternalFailureException,
                                                                ForbiddenException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                Iot1ClickDevicesException

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:

Result of the ClaimDevicesByClaimCode operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

claimDevicesByClaimCode

default ClaimDevicesByClaimCodeResponse claimDevicesByClaimCode(Consumer<ClaimDevicesByClaimCodeRequest.Builder> claimDevicesByClaimCodeRequest)
                                                         throws InvalidRequestException,
                                                                InternalFailureException,
                                                                ForbiddenException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                Iot1ClickDevicesException

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:

Result of the ClaimDevicesByClaimCode operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeDevice

default DescribeDeviceResponse describeDevice(DescribeDeviceRequest describeDeviceRequest)
                                       throws ResourceNotFoundException,
                                              InvalidRequestException,
                                              InternalFailureException,
                                              AwsServiceException,
                                              SdkClientException,
                                              Iot1ClickDevicesException

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Parameters:

describeDeviceRequest -

Returns:

Result of the DescribeDevice operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeDevice

default DescribeDeviceResponse describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
                                       throws ResourceNotFoundException,
                                              InvalidRequestException,
                                              InternalFailureException,
                                              AwsServiceException,
                                              SdkClientException,
                                              Iot1ClickDevicesException

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:

Result of the DescribeDevice operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

finalizeDeviceClaim

default FinalizeDeviceClaimResponse finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        InternalFailureException,
                                                        PreconditionFailedException,
                                                        ResourceConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

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:

Result of the FinalizeDeviceClaim operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

finalizeDeviceClaim

default FinalizeDeviceClaimResponse finalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        InternalFailureException,
                                                        PreconditionFailedException,
                                                        ResourceConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

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:

Result of the FinalizeDeviceClaim operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getDeviceMethods

default GetDeviceMethodsResponse getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
                                           throws ResourceNotFoundException,
                                                  InvalidRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Iot1ClickDevicesException

Given a device ID, returns the invokable methods associated with the device.

Parameters:

getDeviceMethodsRequest -

Returns:

Result of the GetDeviceMethods operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getDeviceMethods

default GetDeviceMethodsResponse getDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest)
                                           throws ResourceNotFoundException,
                                                  InvalidRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Iot1ClickDevicesException

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:

Result of the GetDeviceMethods operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

initiateDeviceClaim

default InitiateDeviceClaimResponse initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        InternalFailureException,
                                                        ResourceConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

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:

Result of the InitiateDeviceClaim operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

initiateDeviceClaim

default InitiateDeviceClaimResponse initiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest)
                                                 throws ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        InternalFailureException,
                                                        ResourceConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

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:

Result of the InitiateDeviceClaim operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

invokeDeviceMethod

default InvokeDeviceMethodResponse invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
                                               throws InvalidRequestException,
                                                      PreconditionFailedException,
                                                      InternalFailureException,
                                                      ResourceNotFoundException,
                                                      RangeNotSatisfiableException,
                                                      ResourceConflictException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      Iot1ClickDevicesException

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:

Result of the InvokeDeviceMethod operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

invokeDeviceMethod

default InvokeDeviceMethodResponse invokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest)
                                               throws InvalidRequestException,
                                                      PreconditionFailedException,
                                                      InternalFailureException,
                                                      ResourceNotFoundException,
                                                      RangeNotSatisfiableException,
                                                      ResourceConflictException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      Iot1ClickDevicesException

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:

Result of the InvokeDeviceMethod operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listDeviceEvents

default ListDeviceEventsResponse listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
                                           throws ResourceNotFoundException,
                                                  RangeNotSatisfiableException,
                                                  InvalidRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Iot1ClickDevicesException

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

Parameters:

listDeviceEventsRequest -

Returns:

Result of the ListDeviceEvents operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listDeviceEvents

default ListDeviceEventsResponse listDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest)
                                           throws ResourceNotFoundException,
                                                  RangeNotSatisfiableException,
                                                  InvalidRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Iot1ClickDevicesException

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:

Result of the ListDeviceEvents operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listDevices

default ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest)
                                 throws RangeNotSatisfiableException,
                                        InvalidRequestException,
                                        InternalFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        Iot1ClickDevicesException

Lists the 1-Click compatible devices associated with your AWS account.

Parameters:

listDevicesRequest -

Returns:

Result of the ListDevices operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listDevices

default ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
                                 throws RangeNotSatisfiableException,
                                        InvalidRequestException,
                                        InternalFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        Iot1ClickDevicesException

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:

Result of the ListDevices operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalFailureException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

Lists the tags associated with the specified resource ARN.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalFailureException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        Iot1ClickDevicesException

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InvalidRequestException,
                                        InternalFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        Iot1ClickDevicesException

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:

Result of the TagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InvalidRequestException,
                                        InternalFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        Iot1ClickDevicesException

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:

Result of the TagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

unclaimDevice

default UnclaimDeviceResponse unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InternalFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            Iot1ClickDevicesException

Disassociates a device from your AWS account using its device ID.

Parameters:

unclaimDeviceRequest -

Returns:

Result of the UnclaimDevice operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

unclaimDevice

default UnclaimDeviceResponse unclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InternalFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            Iot1ClickDevicesException

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:

Result of the UnclaimDevice operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InternalFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            Iot1ClickDevicesException

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InvalidRequestException,
                                            InternalFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            Iot1ClickDevicesException

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:

Result of the UntagResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

updateDeviceState

default UpdateDeviceStateResponse updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
                                             throws ResourceNotFoundException,
                                                    InvalidRequestException,
                                                    InternalFailureException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    Iot1ClickDevicesException

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Parameters:

updateDeviceStateRequest -

Returns:

Result of the UpdateDeviceState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

updateDeviceState

default UpdateDeviceStateResponse updateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest)
                                             throws ResourceNotFoundException,
                                                    InvalidRequestException,
                                                    InternalFailureException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    Iot1ClickDevicesException

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:

Result of the UpdateDeviceState operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static Iot1ClickDevicesClient create()

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

builder

static Iot1ClickDevicesClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Iot1ClickDevicesServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient