@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIoT1ClickDevicesClient extends AmazonWebServiceClient implements AWSIoT1ClickDevices
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSIoT1ClickDevicesClientBuilder |
builder() |
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSIoT1ClickDevicesClientBuilder builder()
public 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).
claimDevicesByClaimCode in interface AWSIoT1ClickDevicesclaimDevicesByClaimCodeRequest - InvalidRequestException - 400 responseInternalFailureException - 500 responseForbiddenException - 403 responsepublic DescribeDeviceResult describeDevice(DescribeDeviceRequest request)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describeDevice in interface AWSIoT1ClickDevicesdescribeDeviceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic FinalizeDeviceClaimResult finalizeDeviceClaim(FinalizeDeviceClaimRequest request)
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 AWSIoT1ClickDevicesfinalizeDeviceClaimRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsePreconditionFailedException - 412 responseResourceConflictException - 409 responsepublic GetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest request)
Given a device ID, returns the invokable methods associated with the device.
getDeviceMethods in interface AWSIoT1ClickDevicesgetDeviceMethodsRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic InitiateDeviceClaimResult initiateDeviceClaim(InitiateDeviceClaimRequest request)
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 AWSIoT1ClickDevicesinitiateDeviceClaimRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responseResourceConflictException - 409 responsepublic InvokeDeviceMethodResult invokeDeviceMethod(InvokeDeviceMethodRequest request)
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 AWSIoT1ClickDevicesinvokeDeviceMethodRequest - InvalidRequestException - 400 responsePreconditionFailedException - 412 responseInternalFailureException - 500 responseResourceNotFoundException - 404 responseRangeNotSatisfiableException - 416 responseResourceConflictException - 409 responsepublic ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest request)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
listDeviceEvents in interface AWSIoT1ClickDeviceslistDeviceEventsRequest - ResourceNotFoundException - 404 responseRangeNotSatisfiableException - 416 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic ListDevicesResult listDevices(ListDevicesRequest request)
Lists the 1-Click compatible devices associated with your AWS account.
listDevices in interface AWSIoT1ClickDeviceslistDevicesRequest - RangeNotSatisfiableException - 416 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags associated with the specified resource ARN.
listTagsForResource in interface AWSIoT1ClickDeviceslistTagsForResourceRequest - ResourceNotFoundException - 404 responseInternalFailureException - 500 responsepublic TagResourceResult tagResource(TagResourceRequest request)
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 AWSIoT1ClickDevicestagResourceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic UnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest request)
Disassociates a device from your AWS account using its device ID.
unclaimDevice in interface AWSIoT1ClickDevicesunclaimDeviceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic UntagResourceResult untagResource(UntagResourceRequest request)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untagResource in interface AWSIoT1ClickDevicesuntagResourceRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic UpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest request)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
updateDeviceState in interface AWSIoT1ClickDevicesupdateDeviceStateRequest - ResourceNotFoundException - 404 responseInvalidRequestException - 400 responseInternalFailureException - 500 responsepublic 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 the request.
getCachedResponseMetadata in interface AWSIoT1ClickDevicesrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSIoT1ClickDevicesshutdown in class AmazonWebServiceClient