* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.iot1clickdevices.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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoT1ClickDevices { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "devices.iot1click"; /** ** 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). *
* * @param claimDevicesByClaimCodeRequest * @return Result of the ClaimDevicesByClaimCode operation returned by the service. * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @throws ForbiddenException * 403 response * @sample AWSIoT1ClickDevices.ClaimDevicesByClaimCode * @see AWS API Documentation */ ClaimDevicesByClaimCodeResult claimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest claimDevicesByClaimCodeRequest); /** ** Given a device ID, returns a DescribeDeviceResponse object describing the details of the device. *
* * @param describeDeviceRequest * @return Result of the DescribeDevice operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.DescribeDevice * @see AWS API * Documentation */ DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest); /** ** 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. *
** Given a device ID, returns the invokable methods associated with the device. *
* * @param getDeviceMethodsRequest * @return Result of the GetDeviceMethods operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.GetDeviceMethods * @see AWS API * Documentation */ GetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest); /** ** 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. *
** Given a device ID, issues a request to invoke a named device method (with possible parameters). See the * "Example POST" code snippet below. *
* * @param invokeDeviceMethodRequest * @return Result of the InvokeDeviceMethod operation returned by the service. * @throws InvalidRequestException * 400 response * @throws PreconditionFailedException * 412 response * @throws InternalFailureException * 500 response * @throws ResourceNotFoundException * 404 response * @throws RangeNotSatisfiableException * 416 response * @throws ResourceConflictException * 409 response * @sample AWSIoT1ClickDevices.InvokeDeviceMethod * @see AWS API * Documentation */ InvokeDeviceMethodResult invokeDeviceMethod(InvokeDeviceMethodRequest invokeDeviceMethodRequest); /** ** Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device. *
* * @param listDeviceEventsRequest * @return Result of the ListDeviceEvents operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws RangeNotSatisfiableException * 416 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.ListDeviceEvents * @see AWS API * Documentation */ ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest); /** ** Lists the 1-Click compatible devices associated with your AWS account. *
* * @param listDevicesRequest * @return Result of the ListDevices operation returned by the service. * @throws RangeNotSatisfiableException * 416 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.ListDevices * @see AWS API * Documentation */ ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest); /** ** Lists the tags associated with the specified resource ARN. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** 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. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Disassociates a device from your AWS account using its device ID. *
* * @param unclaimDeviceRequest * @return Result of the UnclaimDevice operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.UnclaimDevice * @see AWS API * Documentation */ UnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest); /** ** Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** Using a Boolean value (true or false), this operation enables or disables the device given a device ID. *
* * @param updateDeviceStateRequest * @return Result of the UpdateDeviceState operation returned by the service. * @throws ResourceNotFoundException * 404 response * @throws InvalidRequestException * 400 response * @throws InternalFailureException * 500 response * @sample AWSIoT1ClickDevices.UpdateDeviceState * @see AWS API * Documentation */ UpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }