import { IoT1ClickDevicesServiceClient } from "./IoT1ClickDevicesServiceClient"; import { ClaimDevicesByClaimCodeInput } from "./types/ClaimDevicesByClaimCodeInput"; import { ClaimDevicesByClaimCodeOutput } from "./types/ClaimDevicesByClaimCodeOutput"; import { DescribeDeviceInput } from "./types/DescribeDeviceInput"; import { DescribeDeviceOutput } from "./types/DescribeDeviceOutput"; import { FinalizeDeviceClaimInput } from "./types/FinalizeDeviceClaimInput"; import { FinalizeDeviceClaimOutput } from "./types/FinalizeDeviceClaimOutput"; import { GetDeviceMethodsInput } from "./types/GetDeviceMethodsInput"; import { GetDeviceMethodsOutput } from "./types/GetDeviceMethodsOutput"; import { InitiateDeviceClaimInput } from "./types/InitiateDeviceClaimInput"; import { InitiateDeviceClaimOutput } from "./types/InitiateDeviceClaimOutput"; import { InvokeDeviceMethodInput } from "./types/InvokeDeviceMethodInput"; import { InvokeDeviceMethodOutput } from "./types/InvokeDeviceMethodOutput"; import { ListDeviceEventsInput } from "./types/ListDeviceEventsInput"; import { ListDeviceEventsOutput } from "./types/ListDeviceEventsOutput"; import { ListDevicesInput } from "./types/ListDevicesInput"; import { ListDevicesOutput } from "./types/ListDevicesOutput"; import { ListTagsForResourceInput } from "./types/ListTagsForResourceInput"; import { ListTagsForResourceOutput } from "./types/ListTagsForResourceOutput"; import { TagResourceInput } from "./types/TagResourceInput"; import { TagResourceOutput } from "./types/TagResourceOutput"; import { UnclaimDeviceInput } from "./types/UnclaimDeviceInput"; import { UnclaimDeviceOutput } from "./types/UnclaimDeviceOutput"; import { UntagResourceInput } from "./types/UntagResourceInput"; import { UntagResourceOutput } from "./types/UntagResourceOutput"; import { UpdateDeviceStateInput } from "./types/UpdateDeviceStateInput"; import { UpdateDeviceStateOutput } from "./types/UpdateDeviceStateOutput"; export declare class IoT1ClickDevicesService extends IoT1ClickDevicesServiceClient { /** *
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).
* * This operation may fail with one of the following errors: * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {ForbiddenException} ForbiddenException shape * - {Error} An error originating from the SDK or customizations rather than the service */ claimDevicesByClaimCode(args: ClaimDevicesByClaimCodeInput): PromiseGiven a device ID, returns a DescribeDeviceResponse object describing the details of the device.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ describeDevice(args: DescribeDeviceInput): PromiseGiven 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.
Given a device ID, returns the invokable methods associated with the device.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ getDeviceMethods(args: GetDeviceMethodsInput): PromiseGiven 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.
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
* * This operation may fail with one of the following errors: * - {InvalidRequestException} InvalidRequestException shape * - {PreconditionFailedException} PreconditionFailedException shape * - {InternalFailureException} InternalFailureException shape * - {ResourceNotFoundException} ResourceNotFoundException shape * - {RangeNotSatisfiableException} RangeNotSatisfiableException shape * - {ResourceConflictException} ResourceConflictException shape * - {Error} An error originating from the SDK or customizations rather than the service */ invokeDeviceMethod(args: InvokeDeviceMethodInput): PromiseUsing a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {RangeNotSatisfiableException} RangeNotSatisfiableException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ listDeviceEvents(args: ListDeviceEventsInput): PromiseLists the 1-Click compatible devices associated with your AWS account.
* * This operation may fail with one of the following errors: * - {RangeNotSatisfiableException} RangeNotSatisfiableException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ listDevices(args: ListDevicesInput): PromiseLists the tags associated with the specified resource ARN.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ listTagsForResource(args: ListTagsForResourceInput): PromiseAdds 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.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ tagResource(args: TagResourceInput): PromiseDisassociates a device from your AWS account using its device ID.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ unclaimDevice(args: UnclaimDeviceInput): PromiseUsing tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ untagResource(args: UntagResourceInput): PromiseUsing a Boolean value (true or false), this operation enables or disables the device given a device ID.
* * This operation may fail with one of the following errors: * - {ResourceNotFoundException} ResourceNotFoundException shape * - {InvalidRequestException} InvalidRequestException shape * - {InternalFailureException} InternalFailureException shape * - {Error} An error originating from the SDK or customizations rather than the service */ updateDeviceState(args: UpdateDeviceStateInput): Promise