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
FieldsModifier and TypeFieldDescriptionstatic final StringValue 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 ClaimDevicesByClaimCodeResponseclaimDevicesByClaimCode(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 ClaimDevicesByClaimCodeResponseclaimDevicesByClaimCode(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 Iot1ClickDevicesClientcreate()Create aIot1ClickDevicesClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DescribeDeviceResponsedescribeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest) Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.default DescribeDeviceResponsedescribeDevice(DescribeDeviceRequest describeDeviceRequest) Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.default FinalizeDeviceClaimResponsefinalizeDeviceClaim(Consumer<FinalizeDeviceClaimRequest.Builder> finalizeDeviceClaimRequest) Given a device ID, finalizes the claim request for the associated device.default FinalizeDeviceClaimResponsefinalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest) Given a device ID, finalizes the claim request for the associated device.default GetDeviceMethodsResponsegetDeviceMethods(Consumer<GetDeviceMethodsRequest.Builder> getDeviceMethodsRequest) Given a device ID, returns the invokable methods associated with the device.default GetDeviceMethodsResponsegetDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest) Given a device ID, returns the invokable methods associated with the device.default InitiateDeviceClaimResponseinitiateDeviceClaim(Consumer<InitiateDeviceClaimRequest.Builder> initiateDeviceClaimRequest) Given a device ID, initiates a claim request for the associated device.default InitiateDeviceClaimResponseinitiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest) Given a device ID, initiates a claim request for the associated device.default InvokeDeviceMethodResponseinvokeDeviceMethod(Consumer<InvokeDeviceMethodRequest.Builder> invokeDeviceMethodRequest) Given a device ID, issues a request to invoke a named device method (with possible parameters).default InvokeDeviceMethodResponseinvokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest) Given a device ID, issues a request to invoke a named device method (with possible parameters).default ListDeviceEventsResponselistDeviceEvents(Consumer<ListDeviceEventsRequest.Builder> listDeviceEventsRequest) Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.default ListDeviceEventsResponselistDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest) Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.default ListDevicesResponselistDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) Lists the 1-Click compatible devices associated with your AWS account.default ListDevicesResponselistDevices(ListDevicesRequest listDevicesRequest) Lists the 1-Click compatible devices associated with your AWS account.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with the specified resource ARN.default ListTagsForResourceResponselistTagsForResource(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 ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates the tags associated with the resource ARN.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds or updates the tags associated with the resource ARN.default UnclaimDeviceResponseunclaimDevice(Consumer<UnclaimDeviceRequest.Builder> unclaimDeviceRequest) Disassociates a device from your AWS account using its device ID.default UnclaimDeviceResponseunclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest) Disassociates a device from your AWS account using its device ID.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.default UpdateDeviceStateResponseupdateDeviceState(Consumer<UpdateDeviceStateRequest.Builder> updateDeviceStateRequest) Using a Boolean value (true or false), this operation enables or disables the device given a device ID.default UpdateDeviceStateResponseupdateDeviceState(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
closeMethods 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.Builderavoiding the need to create one manually viaClaimDevicesByClaimCodeRequest.builder()- Parameters:
claimDevicesByClaimCodeRequest- AConsumerthat will call methods onClaimDevicesByClaimCodeRequest.Builderto 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.Builderavoiding the need to create one manually viaDescribeDeviceRequest.builder()- Parameters:
describeDeviceRequest- AConsumerthat will call methods onDescribeDeviceRequest.Builderto 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.Builderavoiding the need to create one manually viaFinalizeDeviceClaimRequest.builder()- Parameters:
finalizeDeviceClaimRequest- AConsumerthat will call methods onFinalizeDeviceClaimRequest.Builderto 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.Builderavoiding the need to create one manually viaGetDeviceMethodsRequest.builder()- Parameters:
getDeviceMethodsRequest- AConsumerthat will call methods onGetDeviceMethodsRequest.Builderto 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.Builderavoiding the need to create one manually viaInitiateDeviceClaimRequest.builder()- Parameters:
initiateDeviceClaimRequest- AConsumerthat will call methods onInitiateDeviceClaimRequest.Builderto 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.Builderavoiding the need to create one manually viaInvokeDeviceMethodRequest.builder()- Parameters:
invokeDeviceMethodRequest- AConsumerthat will call methods onInvokeDeviceMethodRequest.Builderto 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.Builderavoiding the need to create one manually viaListDeviceEventsRequest.builder()- Parameters:
listDeviceEventsRequest- AConsumerthat will call methods onListDeviceEventsRequest.Builderto 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.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUnclaimDeviceRequest.builder()- Parameters:
unclaimDeviceRequest- AConsumerthat will call methods onUnclaimDeviceRequest.Builderto 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateDeviceStateRequest.builder()- Parameters:
updateDeviceStateRequest- AConsumerthat will call methods onUpdateDeviceStateRequest.Builderto create a request.- Returns:
- Result of the UpdateDeviceState operation returned by the service.
- See Also:
-
create
Create aIot1ClickDevicesClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aIot1ClickDevicesClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-