com.amazonaws.services.iot1clickdevices

Interface AWSIoT1ClickDevices

All Known Subinterfaces:

AWSIoT1ClickDevicesAsync

All Known Implementing Classes:

AbstractAWSIoT1ClickDevices, AbstractAWSIoT1ClickDevicesAsync, AWSIoT1ClickDevicesAsyncClient, AWSIoT1ClickDevicesClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoT1ClickDevices

Interface for accessing AWS IoT 1-Click Devices Service.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

claimDevicesByClaimCode

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).

Parameters:

claimDevicesByClaimCodeRequest -

Returns:

Result of the ClaimDevicesByClaimCode operation returned by the service.

Throws:

InvalidRequestException - 400 response

InternalFailureException - 500 response

ForbiddenException - 403 response

See Also:

AWS API Documentation

describeDevice

DescribeDeviceResult describeDevice(DescribeDeviceRequest describeDeviceRequest)

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.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

finalizeDeviceClaim

FinalizeDeviceClaimResult 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.

Parameters:

finalizeDeviceClaimRequest -

Returns:

Result of the FinalizeDeviceClaim operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

PreconditionFailedException - 412 response

ResourceConflictException - 409 response

See Also:

AWS API Documentation

getDeviceMethods

GetDeviceMethodsResult getDeviceMethods(GetDeviceMethodsRequest getDeviceMethodsRequest)

Given a device ID, returns the invokable methods associated with the device.

Parameters:

getDeviceMethodsRequest -

Returns:

Result of the GetDeviceMethods operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

initiateDeviceClaim

InitiateDeviceClaimResult 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.

Parameters:

initiateDeviceClaimRequest -

Returns:

Result of the InitiateDeviceClaim operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

ResourceConflictException - 409 response

See Also:

AWS API Documentation

invokeDeviceMethod

InvokeDeviceMethodResult 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.

Parameters:

invokeDeviceMethodRequest -

Returns:

Result of the InvokeDeviceMethod operation returned by the service.

Throws:

InvalidRequestException - 400 response

PreconditionFailedException - 412 response

InternalFailureException - 500 response

ResourceNotFoundException - 404 response

RangeNotSatisfiableException - 416 response

ResourceConflictException - 409 response

See Also:

AWS API Documentation

listDeviceEvents

ListDeviceEventsResult listDeviceEvents(ListDeviceEventsRequest listDeviceEventsRequest)

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.

Throws:

ResourceNotFoundException - 404 response

RangeNotSatisfiableException - 416 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

listDevices

ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)

Lists the 1-Click compatible devices associated with your AWS account.

Parameters:

listDevicesRequest -

Returns:

Result of the ListDevices operation returned by the service.

Throws:

RangeNotSatisfiableException - 416 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags associated with the specified resource ARN.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

tagResource

TagResourceResult 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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

unclaimDevice

UnclaimDeviceResult unclaimDevice(UnclaimDeviceRequest unclaimDeviceRequest)

Disassociates a device from your AWS account using its device ID.

Parameters:

unclaimDeviceRequest -

Returns:

Result of the UnclaimDevice operation returned by the service.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

updateDeviceState

UpdateDeviceStateResult updateDeviceState(UpdateDeviceStateRequest updateDeviceStateRequest)

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.

Throws:

ResourceNotFoundException - 404 response

InvalidRequestException - 400 response

InternalFailureException - 500 response

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.