Iot 1Click Devices Service

claim_devices_by_claim_code(claim_code)
claim_devices_by_claim_code(claim_code, params::Dict{String,<:Any})

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

Arguments

• claim_code: The claim code, starting with "C-", as provided by the device manufacturer.

describe_device(device_id)
describe_device(device_id, params::Dict{String,<:Any})

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

Arguments

• device_id: The unique identifier of the device.

finalize_device_claim(device_id)
finalize_device_claim(device_id, params::Dict{String,<:Any})

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.

Arguments

• device_id: The unique identifier of the device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

get_device_methods(device_id)
get_device_methods(device_id, params::Dict{String,<:Any})

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

Arguments

• device_id: The unique identifier of the device.

initiate_device_claim(device_id)
initiate_device_claim(device_id, params::Dict{String,<:Any})

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.

Arguments

• device_id: The unique identifier of the device.

invoke_device_method(device_id)
invoke_device_method(device_id, params::Dict{String,<:Any})

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

Arguments

• device_id: The unique identifier of the device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deviceMethod": The device method to invoke.
• "deviceMethodParameters": A JSON encoded string containing the device method request parameters.

list_device_events(device_id, from_time_stamp, to_time_stamp)
list_device_events(device_id, from_time_stamp, to_time_stamp, params::Dict{String,<:Any})

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

Arguments

• device_id: The unique identifier of the device.
• from_time_stamp: The start date for the device event query, in ISO8061 format. For example,

2018-03-28T15:45:12.880Z

• to_time_stamp: The end date for the device event query, in ISO8061 format. For example,

2018-03-28T15:45:12.880Z

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of results to return per request. If not set, a default value of

100 is used.

• "nextToken": The token to retrieve the next set of results.

list_devices()
list_devices(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deviceType": The type of the device, such as "button".
• "maxResults": The maximum number of results to return per request. If not set, a default value of

100 is used.

• "nextToken": The token to retrieve the next set of results.

list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})

Lists the tags associated with the specified resource ARN.

Arguments

• resource-arn: The ARN of the resource.

tag_resource(resource-arn, tags)
tag_resource(resource-arn, tags, params::Dict{String,<:Any})

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.

Arguments

• resource-arn: The ARN of the resource.
• tags: A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

unclaim_device(device_id)
unclaim_device(device_id, params::Dict{String,<:Any})

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

Arguments

• device_id: The unique identifier of the device.

untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

• resource-arn: The ARN of the resource.
• tag_keys: A collections of tag keys. For example, {"key1","key2"}

update_device_state(device_id)
update_device_state(device_id, params::Dict{String,<:Any})

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

Arguments

• device_id: The unique identifier of the device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "enabled": If true, the device is enabled. If false, the device is

disabled.