IoT1ClickDevicesService

import { IoT1ClickDevicesService } from "https://aws-api.deno.dev/v0.1/services/iot1clickdevicesservice.ts?docs=full";

class IoT1ClickDevicesService {

constructor(apiFactory: client.ApiFactory);

async claimDevicesByClaimCode(params: ClaimDevicesByClaimCodeRequest): Promise<ClaimDevicesByClaimCodeResponse>;

async describeDevice(params: DescribeDeviceRequest): Promise<DescribeDeviceResponse>;

async finalizeDeviceClaim(params: FinalizeDeviceClaimRequest): Promise<FinalizeDeviceClaimResponse>;

async getDeviceMethods(params: GetDeviceMethodsRequest): Promise<GetDeviceMethodsResponse>;

async initiateDeviceClaim(params: InitiateDeviceClaimRequest): Promise<InitiateDeviceClaimResponse>;

async invokeDeviceMethod(params: InvokeDeviceMethodRequest): Promise<InvokeDeviceMethodResponse>;

async listDeviceEvents(params: ListDeviceEventsRequest): Promise<ListDeviceEventsResponse>;

async listDevices(params?: ListDevicesRequest): Promise<ListDevicesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest): Promise<ListTagsForResourceResponse>;

async tagResource(params: TagResourceRequest): Promise<void>;

async unclaimDevice(params: UnclaimDeviceRequest): Promise<UnclaimDeviceResponse>;

async untagResource(params: UntagResourceRequest): Promise<void>;

async updateDeviceState(params: UpdateDeviceStateRequest): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IoT1ClickDevicesService(apiFactory: client.ApiFactory)

[src]

§Methods

claimDevicesByClaimCode(params: ClaimDevicesByClaimCodeRequest): Promise<ClaimDevicesByClaimCodeResponse>

[src]

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

describeDevice(params: DescribeDeviceRequest): Promise<DescribeDeviceResponse>

[src]

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

finalizeDeviceClaim(params: FinalizeDeviceClaimRequest): Promise<FinalizeDeviceClaimResponse>

[src]

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

Note: 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.

getDeviceMethods(params: GetDeviceMethodsRequest): Promise<GetDeviceMethodsResponse>

[src]

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

initiateDeviceClaim(params: InitiateDeviceClaimRequest): Promise<InitiateDeviceClaimResponse>

[src]

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

invokeDeviceMethod(params: InvokeDeviceMethodRequest): Promise<InvokeDeviceMethodResponse>

[src]

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

listDeviceEvents(params: ListDeviceEventsRequest): Promise<ListDeviceEventsResponse>

[src]

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

listDevices(params?: ListDevicesRequest): Promise<ListDevicesResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest): Promise<ListTagsForResourceResponse>

[src]

Lists the tags associated with the specified resource ARN.

tagResource(params: TagResourceRequest): Promise<void>

[src]

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.

unclaimDevice(params: UnclaimDeviceRequest): Promise<UnclaimDeviceResponse>

[src]

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

untagResource(params: UntagResourceRequest): Promise<void>

[src]

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

updateDeviceState(params: UpdateDeviceStateRequest): Promise<void>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]