@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoT1ClickDevices
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoT1ClickDevices instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ClaimDevicesByClaimCodeResult |
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).
|
DescribeDeviceResult |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
FinalizeDeviceClaimResult |
finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDeviceMethodsResult |
getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
|
InitiateDeviceClaimResult |
initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
|
InvokeDeviceMethodResult |
invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
ListDeviceEventsResult |
listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the specified resource ARN.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates the tags associated with the resource ARN.
|
UnclaimDeviceResult |
unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
|
UpdateDeviceStateResult |
updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
static final String ENDPOINT_PREFIX
ClaimDevicesByClaimCodeResult 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).
claimDevicesByClaimCodeRequest - InvalidRequestException - 400 responseInternalFailureException - 500 responseForbiddenException - 403 responseDescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDeviceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseFinalizeDeviceClaimResult finalizeDeviceClaim(FinalizeDeviceClaimRequest finalizeDeviceClaimRequest)
Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
finalizeDeviceClaimRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsePreconditionFailedException - 412 responseResourceConflictException - 409 responseGetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)
Given a device ID, returns the invokable methods associated with the device.
getDeviceMethodsRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseInitiateDeviceClaimResult initiateDeviceClaim(InitiateDeviceClaimRequest initiateDeviceClaimRequest)
Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
initiateDeviceClaimRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseResourceConflictException - 409 responseInvokeDeviceMethodResult invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest)
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
invokeDeviceMethodRequest - InvalidRequestException - 400 responsePreconditionFailedException - 412 responseInternalFailureException - 500 responseResourceNotFoundException - 404 responseRangeNotSatisfiableException - 416 responseResourceConflictException - 409 responseListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEventsRequest - ResourceNotFoundException - 404 responseRangeNotSatisfiableException - 416 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Lists the 1-Click compatible devices associated with your AWS account.
listDevicesRequest - RangeNotSatisfiableException - 416 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the specified resource ARN.
listTagsForResourceRequest - ResourceNotFoundException - 404 responseInternalFailureException - 500 responseTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.
tagResourceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseUnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)
Disassociates a device from your AWS account using its device ID.
unclaimDeviceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untagResourceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseUpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceStateRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsevoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.