aws_iot_1click_devices
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.Summary
Functions
-
claim_devices_by_claim_code(Client, ClaimCode, Input)
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).
- claim_devices_by_claim_code(Client, ClaimCode, Input0, Options0)
-
describe_device(Client, DeviceId)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
- describe_device(Client, DeviceId, QueryMap, HeadersMap)
- describe_device(Client, DeviceId, QueryMap, HeadersMap, Options0)
-
finalize_device_claim(Client, DeviceId, Input)
Given a device ID, finalizes the claim request for the associated device.
- finalize_device_claim(Client, DeviceId, Input0, Options0)
-
get_device_methods(Client, DeviceId)
Given a device ID, returns the invokable methods associated with the device.
- get_device_methods(Client, DeviceId, QueryMap, HeadersMap)
- get_device_methods(Client, DeviceId, QueryMap, HeadersMap, Options0)
-
initiate_device_claim(Client, DeviceId, Input)
Given a device ID, initiates a claim request for the associated device.
- initiate_device_claim(Client, DeviceId, Input0, Options0)
-
invoke_device_method(Client, DeviceId, Input)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
- invoke_device_method(Client, DeviceId, Input0, Options0)
-
list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
- list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp, QueryMap, HeadersMap)
- list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp, QueryMap, HeadersMap, Options0)
-
list_devices(Client)
Lists the 1-Click compatible devices associated with your AWS account.
- list_devices(Client, QueryMap, HeadersMap)
- list_devices(Client, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Lists the tags associated with the specified resource ARN.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
tag_resource(Client, ResourceArn, Input)
Adds or updates the tags associated with the resource ARN.
- tag_resource(Client, ResourceArn, Input0, Options0)
-
unclaim_device(Client, DeviceId, Input)
Disassociates a device from your AWS account using its device ID.
- unclaim_device(Client, DeviceId, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_device_state(Client, DeviceId, Input)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
- update_device_state(Client, DeviceId, Input0, Options0)
Functions
claim_devices_by_claim_code(Client, ClaimCode, Input)
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).
claim_devices_by_claim_code(Client, ClaimCode, Input0, Options0)
describe_device(Client, DeviceId)
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
describe_device(Client, DeviceId, QueryMap, HeadersMap)
describe_device(Client, DeviceId, QueryMap, HeadersMap, Options0)
finalize_device_claim(Client, DeviceId, Input)
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.finalize_device_claim(Client, DeviceId, Input0, Options0)
get_device_methods(Client, DeviceId)
Given a device ID, returns the invokable methods associated with the device.
get_device_methods(Client, DeviceId, QueryMap, HeadersMap)
get_device_methods(Client, DeviceId, QueryMap, HeadersMap, Options0)
initiate_device_claim(Client, DeviceId, Input)
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.initiate_device_claim(Client, DeviceId, Input0, Options0)
invoke_device_method(Client, DeviceId, Input)
Given a device ID, issues a request to invoke a named device method (with possible parameters).
See the "Example POST" code snippet below.invoke_device_method(Client, DeviceId, Input0, Options0)
list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp)
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp, QueryMap, HeadersMap)
list_device_events(Client, DeviceId, FromTimeStamp, ToTimeStamp, QueryMap, HeadersMap, Options0)
list_devices(Client)
Lists the 1-Click compatible devices associated with your AWS account.
list_devices(Client, QueryMap, HeadersMap)
list_devices(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
Lists the tags associated with the specified resource ARN.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
tag_resource(Client, ResourceArn, Input)
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.tag_resource(Client, ResourceArn, Input0, Options0)
unclaim_device(Client, DeviceId, Input)
Disassociates a device from your AWS account using its device ID.
unclaim_device(Client, DeviceId, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
untag_resource(Client, ResourceArn, Input0, Options0)
update_device_state(Client, DeviceId, Input)
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.