@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIoT1ClickDevices extends Object implements AWSIoT1ClickDevices
AWSIoT1ClickDevices
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
ClaimDevicesByClaimCodeResult |
claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request)
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 request)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
|
FinalizeDeviceClaimResult |
finalizeDeviceClaim(FinalizeDeviceClaimRequest request)
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 request)
Given a device ID, returns the invokable methods associated with the device.
|
InitiateDeviceClaimResult |
initiateDeviceClaim(InitiateDeviceClaimRequest request)
Given a device ID, initiates a claim request for the associated device.
|
InvokeDeviceMethodResult |
invokeDeviceMethod(InvokeDeviceMethodRequest request)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
|
ListDeviceEventsResult |
listDeviceEvents(ListDeviceEventsRequest request)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
|
ListDevicesResult |
listDevices(ListDevicesRequest request)
Lists the 1-Click compatible devices associated with your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 request)
Adds or updates the tags associated with the resource ARN.
|
UnclaimDeviceResult |
unclaimDevice(UnclaimDeviceRequest request)
Disassociates a device from your AWS account using its device ID.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
|
UpdateDeviceStateResult |
updateDeviceState(UpdateDeviceStateRequest request)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
|
public ClaimDevicesByClaimCodeResult claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request)
AWSIoT1ClickDevices
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).
claimDevicesByClaimCode
in interface AWSIoT1ClickDevices
public DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
AWSIoT1ClickDevices
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDevice
in interface AWSIoT1ClickDevices
public FinalizeDeviceClaimResult finalizeDeviceClaim(FinalizeDeviceClaimRequest request)
AWSIoT1ClickDevices
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.
finalizeDeviceClaim
in interface AWSIoT1ClickDevices
public GetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest request)
AWSIoT1ClickDevices
Given a device ID, returns the invokable methods associated with the device.
getDeviceMethods
in interface AWSIoT1ClickDevices
public InitiateDeviceClaimResult initiateDeviceClaim(InitiateDeviceClaimRequest request)
AWSIoT1ClickDevices
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.
initiateDeviceClaim
in interface AWSIoT1ClickDevices
public InvokeDeviceMethodResult invokeDeviceMethod(InvokeDeviceMethodRequest request)
AWSIoT1ClickDevices
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
invokeDeviceMethod
in interface AWSIoT1ClickDevices
public ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
AWSIoT1ClickDevices
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEvents
in interface AWSIoT1ClickDevices
public ListDevicesResult listDevices(ListDevicesRequest request)
AWSIoT1ClickDevices
Lists the 1-Click compatible devices associated with your AWS account.
listDevices
in interface AWSIoT1ClickDevices
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIoT1ClickDevices
Lists the tags associated with the specified resource ARN.
listTagsForResource
in interface AWSIoT1ClickDevices
public TagResourceResult tagResource(TagResourceRequest request)
AWSIoT1ClickDevices
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.
tagResource
in interface AWSIoT1ClickDevices
public UnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest request)
AWSIoT1ClickDevices
Disassociates a device from your AWS account using its device ID.
unclaimDevice
in interface AWSIoT1ClickDevices
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSIoT1ClickDevices
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untagResource
in interface AWSIoT1ClickDevices
public UpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest request)
AWSIoT1ClickDevices
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceState
in interface AWSIoT1ClickDevices
public void shutdown()
AWSIoT1ClickDevices
shutdown
in interface AWSIoT1ClickDevices
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIoT1ClickDevices
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.
getCachedResponseMetadata
in interface AWSIoT1ClickDevices
request
- The originally executed request.