@datafire/amazonaws_iot1click_devices v5.0.0

@datafire/amazonaws_iot1click_devices

Client library for AWS IoT 1-Click Devices Service

Installation and Usage

npm install --save @datafire/amazonaws_iot1click_devices

let amazonaws_iot1click_devices = require('@datafire/amazonaws_iot1click_devices').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_iot1click_devices.ClaimDevicesByClaimCode({
  "claimCode": ""
}).then(data => {
  console.log(data);
});

Description

Stub description

Actions

ClaimDevicesByClaimCode

amazonaws_iot1click_devices.ClaimDevicesByClaimCode({
  "claimCode": ""
}, context)

Input

• input object
  • claimCode required string

Output

• output ClaimDevicesByClaimCodeResponse

ListDevices

amazonaws_iot1click_devices.ListDevices({}, context)

Input

• input object

Output

• output ListDevicesResponse

DescribeDevice

amazonaws_iot1click_devices.DescribeDevice({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output DescribeDeviceResponse

ListDeviceEvents

amazonaws_iot1click_devices.ListDeviceEvents({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output ListDeviceEventsResponse

FinalizeDeviceClaim

amazonaws_iot1click_devices.FinalizeDeviceClaim({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output FinalizeDeviceClaimResponse

InitiateDeviceClaim

amazonaws_iot1click_devices.InitiateDeviceClaim({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output InitiateDeviceClaimResponse

GetDeviceMethods

amazonaws_iot1click_devices.GetDeviceMethods({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output GetDeviceMethodsResponse

InvokeDeviceMethod

amazonaws_iot1click_devices.InvokeDeviceMethod({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string
  • DeviceMethod DeviceMethod
  • DeviceMethodParameters __string

Output

• output InvokeDeviceMethodResponse

UpdateDeviceState

amazonaws_iot1click_devices.UpdateDeviceState({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string
  • Enabled __boolean

Output

• output UpdateDeviceStateResponse

UnclaimDevice

amazonaws_iot1click_devices.UnclaimDevice({
  "deviceId": ""
}, context)

Input

• input object
  • deviceId required string

Output

• output UnclaimDeviceResponse

Definitions

Attributes

• Attributes object

ClaimDevicesByClaimCodeRequest

• ClaimDevicesByClaimCodeRequest object

ClaimDevicesByClaimCodeResponse

• ClaimDevicesByClaimCodeResponse object
  • ClaimCode __stringMin12Max40
  • Total __integer

DescribeDeviceRequest

• DescribeDeviceRequest object

DescribeDeviceResponse

• DescribeDeviceResponse object
  • DeviceDescription DeviceDescription

Device

• Device object
  • Attributes Attributes
  • DeviceId __string
  • Type __string

DeviceAttributes

• DeviceAttributes array:
  • items object
    • key __string
    • value __string

DeviceClaimResponse

• DeviceClaimResponse object
  • State __string

DeviceDescription

• DeviceDescription object
  • Attributes DeviceAttributes
  • DeviceId __string
  • Enabled __boolean
  • RemainingLife __doubleMin0Max100
  • Type __string

DeviceEvent

• DeviceEvent object
  • Device Device
  • StdEvent __string

DeviceEventsResponse

• DeviceEventsResponse object
  • Events __listOfDeviceEvent
  • NextToken __string

DeviceMethod

• DeviceMethod object
  • DeviceType __string
  • MethodName __string

Empty

• Empty object: On success, an empty object is returned.

FinalizeDeviceClaimRequest

• FinalizeDeviceClaimRequest object

FinalizeDeviceClaimResponse

• FinalizeDeviceClaimResponse object
  • State __string

ForbiddenException

• ForbiddenException object
  • Code __string
  • Message __string

GetDeviceMethodsRequest

• GetDeviceMethodsRequest object

GetDeviceMethodsResponse

• GetDeviceMethodsResponse object
  • DeviceMethods __listOfDeviceMethod

InitiateDeviceClaimRequest

• InitiateDeviceClaimRequest object

InitiateDeviceClaimResponse

• InitiateDeviceClaimResponse object
  • State __string

InternalFailureException

• InternalFailureException object
  • Code __string
  • Message __string

InvalidRequestException

• InvalidRequestException object
  • Code __string
  • Message __string

InvokeDeviceMethodRequest

• InvokeDeviceMethodRequest object
  • DeviceMethod DeviceMethod
  • DeviceMethodParameters __string

InvokeDeviceMethodResponse

• InvokeDeviceMethodResponse object
  • DeviceMethodResponse __string

ListDeviceEventsRequest

• ListDeviceEventsRequest object

ListDeviceEventsResponse

• ListDeviceEventsResponse object
  • Events __listOfDeviceEvent
  • NextToken __string

ListDevicesRequest

• ListDevicesRequest object

ListDevicesResponse

• ListDevicesResponse object
  • Devices __listOfDeviceDescription
  • NextToken __string

MaxResults

• MaxResults integer

PreconditionFailedException

• PreconditionFailedException object
  • Code __string
  • Message __string

RangeNotSatisfiableException

• RangeNotSatisfiableException object
  • Code __string
  • Message __string

ResourceConflictException

• ResourceConflictException object
  • Code __string
  • Message __string

ResourceNotFoundException

• ResourceNotFoundException object
  • Code __string
  • Message __string

UnclaimDeviceRequest

• UnclaimDeviceRequest object

UnclaimDeviceResponse

• UnclaimDeviceResponse object
  • State __string

UpdateDeviceStateRequest

• UpdateDeviceStateRequest object
  • Enabled __boolean

UpdateDeviceStateResponse

• UpdateDeviceStateResponse object

__boolean

• __boolean boolean

__double

• __double number

__doubleMin0Max100

• __doubleMin0Max100 number

__integer

• __integer integer

__listOfDeviceDescription

• __listOfDeviceDescription array
  • items DeviceDescription

__listOfDeviceEvent

• __listOfDeviceEvent array
  • items DeviceEvent

__listOfDeviceMethod

• __listOfDeviceMethod array
  • items DeviceMethod

__long

• __long integer

__string

• __string string

__stringMin12Max40

• __stringMin12Max40 string

__timestampIso8601

• __timestampIso8601 string

__timestampUnix

• __timestampUnix string