integrations.sh
← all integrations

amazonaws.com – iot1click-devices

OpenAPI apis-guru cloud

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.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:iot1click-devices/2018-05-14.json
Provider
amazonaws.com:iot1click-devices / iot1click-devices
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/iot1click-devices/2018-05-14/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/iot1click-devices/2018-05-14/openapi.yaml

Tools (15)

Extracted live via the executor SDK.

  • claims.claimDevicesByClaimCode

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

  • devices.describeDevice

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

  • devices.finalizeDeviceClaim

    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.

  • devices.getDeviceMethods

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

  • devices.initiateDeviceClaim

    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.

  • devices.invokeDeviceMethod

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

  • devices.listDeviceEvents

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

  • devices.listDevices

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

  • devices.unclaimDevice

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

  • devices.updateDeviceState

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

  • tags.listTagsForResource

    Lists the tags associated with the specified resource ARN.

  • tags.tagResource

    Adds or updates the tags associated with the resource ARN. See for the maximum number of tags allowed per resource.

  • tags.untagResource

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

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools