Interface Iot1ClickDevicesClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aIot1ClickDevicesClient
.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 aIot1ClickDevicesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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 viaClaimDevicesByClaimCodeRequest.builder()
- Parameters:
claimDevicesByClaimCodeRequest
- AConsumer
that will call methods onClaimDevicesByClaimCodeRequest.Builder
to create a request.- Returns:
- Result of the ClaimDevicesByClaimCode operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDescribeDeviceRequest.builder()
- Parameters:
describeDeviceRequest
- AConsumer
that will call methods onDescribeDeviceRequest.Builder
to create a request.- Returns:
- Result of the DescribeDevice operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaFinalizeDeviceClaimRequest.builder()
- Parameters:
finalizeDeviceClaimRequest
- AConsumer
that will call methods onFinalizeDeviceClaimRequest.Builder
to create a request.- Returns:
- Result of the FinalizeDeviceClaim operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetDeviceMethodsRequest.builder()
- Parameters:
getDeviceMethodsRequest
- AConsumer
that will call methods onGetDeviceMethodsRequest.Builder
to create a request.- Returns:
- Result of the GetDeviceMethods operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaInitiateDeviceClaimRequest.builder()
- Parameters:
initiateDeviceClaimRequest
- AConsumer
that will call methods onInitiateDeviceClaimRequest.Builder
to create a request.- Returns:
- Result of the InitiateDeviceClaim operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaInvokeDeviceMethodRequest.builder()
- Parameters:
invokeDeviceMethodRequest
- AConsumer
that will call methods onInvokeDeviceMethodRequest.Builder
to create a request.- Returns:
- Result of the InvokeDeviceMethod operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListDeviceEventsRequest.builder()
- Parameters:
listDeviceEventsRequest
- AConsumer
that will call methods onListDeviceEventsRequest.Builder
to create a request.- Returns:
- Result of the ListDeviceEvents operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- Result of the ListDevices operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUnclaimDeviceRequest.builder()
- Parameters:
unclaimDeviceRequest
- AConsumer
that will call methods onUnclaimDeviceRequest.Builder
to create a request.- Returns:
- Result of the UnclaimDevice operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateDeviceStateRequest.builder()
- Parameters:
updateDeviceStateRequest
- AConsumer
that will call methods onUpdateDeviceStateRequest.Builder
to create a request.- Returns:
- Result of the UpdateDeviceState operation returned by the service.
- See Also:
-
create
Create aIot1ClickDevicesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIot1ClickDevicesClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-