AWS.IoT1ClickDevices (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

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

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Given a device ID, finalizes the claim request for the associated device.

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

Given a device ID, initiates a claim request for the associated device.

Given a device ID, issues a request to invoke a named device method (with possible parameters).

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

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

Lists the tags associated with the specified resource ARN.

Adds or updates the tags associated with the resource ARN.

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

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Link to this section Functions

Link to this function

claim_devices_by_claim_code(client, claim_code, input, options \\ [])

View Source

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

Link to this function

describe_device(client, device_id, options \\ [])

View Source

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Link to this function

finalize_device_claim(client, device_id, input, options \\ [])

View Source

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.

Link to this function

get_device_methods(client, device_id, options \\ [])

View Source

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

Link to this function

initiate_device_claim(client, device_id, input, options \\ [])

View Source

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.

Link to this function

invoke_device_method(client, device_id, input, options \\ [])

View Source

Given a device ID, issues a request to invoke a named device method (with possible parameters).

See the "Example POST" code snippet below.

Link to this function

list_device_events(client, device_id, from_time_stamp, max_results \\ nil, next_token \\ nil, to_time_stamp, options \\ [])

View Source

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

Link to this function

list_devices(client, device_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags associated with the specified resource ARN.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

unclaim_device(client, device_id, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Link to this function

update_device_state(client, device_id, input, options \\ [])

View Source

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.