1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class IoT1ClickDevicesService extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: IoT1ClickDevicesService.Types.ClientConfiguration)
|
13 | config: Config & IoT1ClickDevicesService.Types.ClientConfiguration;
|
14 | /**
|
15 | * Adds device(s) to your account (i.e., claim one or more devices) if and only if you
|
16 | received a claim code with the device(s).
|
17 | */
|
18 | claimDevicesByClaimCode(params: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse) => void): Request<IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse, AWSError>;
|
19 | /**
|
20 | * Adds device(s) to your account (i.e., claim one or more devices) if and only if you
|
21 | received a claim code with the device(s).
|
22 | */
|
23 | claimDevicesByClaimCode(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse) => void): Request<IoT1ClickDevicesService.Types.ClaimDevicesByClaimCodeResponse, AWSError>;
|
24 | /**
|
25 | * Given a device ID, returns a DescribeDeviceResponse object describing the
|
26 | details of the device.
|
27 | */
|
28 | describeDevice(params: IoT1ClickDevicesService.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.DescribeDeviceResponse) => void): Request<IoT1ClickDevicesService.Types.DescribeDeviceResponse, AWSError>;
|
29 | /**
|
30 | * Given a device ID, returns a DescribeDeviceResponse object describing the
|
31 | details of the device.
|
32 | */
|
33 | describeDevice(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.DescribeDeviceResponse) => void): Request<IoT1ClickDevicesService.Types.DescribeDeviceResponse, AWSError>;
|
34 | /**
|
35 | * Given a device ID, finalizes the claim request for the associated device.
|
36 | Claiming a device consists of initiating a claim, then publishing a device event,
|
37 | and finalizing the claim. For a device of type button, a device event can
|
38 | be published by simply clicking the device.
|
39 |
|
40 | */
|
41 | finalizeDeviceClaim(params: IoT1ClickDevicesService.Types.FinalizeDeviceClaimRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse) => void): Request<IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse, AWSError>;
|
42 | /**
|
43 | * Given a device ID, finalizes the claim request for the associated device.
|
44 | Claiming a device consists of initiating a claim, then publishing a device event,
|
45 | and finalizing the claim. For a device of type button, a device event can
|
46 | be published by simply clicking the device.
|
47 |
|
48 | */
|
49 | finalizeDeviceClaim(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse) => void): Request<IoT1ClickDevicesService.Types.FinalizeDeviceClaimResponse, AWSError>;
|
50 | /**
|
51 | * Given a device ID, returns the invokable methods associated with the device.
|
52 | */
|
53 | getDeviceMethods(params: IoT1ClickDevicesService.Types.GetDeviceMethodsRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.GetDeviceMethodsResponse) => void): Request<IoT1ClickDevicesService.Types.GetDeviceMethodsResponse, AWSError>;
|
54 | /**
|
55 | * Given a device ID, returns the invokable methods associated with the device.
|
56 | */
|
57 | getDeviceMethods(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.GetDeviceMethodsResponse) => void): Request<IoT1ClickDevicesService.Types.GetDeviceMethodsResponse, AWSError>;
|
58 | /**
|
59 | * Given a device ID, initiates a claim request for the associated device.
|
60 | Claiming a device consists of initiating a claim, then publishing a device event,
|
61 | and finalizing the claim. For a device of type button, a device event can
|
62 | be published by simply clicking the device.
|
63 |
|
64 | */
|
65 | initiateDeviceClaim(params: IoT1ClickDevicesService.Types.InitiateDeviceClaimRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse) => void): Request<IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse, AWSError>;
|
66 | /**
|
67 | * Given a device ID, initiates a claim request for the associated device.
|
68 | Claiming a device consists of initiating a claim, then publishing a device event,
|
69 | and finalizing the claim. For a device of type button, a device event can
|
70 | be published by simply clicking the device.
|
71 |
|
72 | */
|
73 | initiateDeviceClaim(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse) => void): Request<IoT1ClickDevicesService.Types.InitiateDeviceClaimResponse, AWSError>;
|
74 | /**
|
75 | * Given a device ID, issues a request to invoke a named device method (with possible
|
76 | parameters). See the "Example POST" code snippet below.
|
77 | */
|
78 | invokeDeviceMethod(params: IoT1ClickDevicesService.Types.InvokeDeviceMethodRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse) => void): Request<IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse, AWSError>;
|
79 | /**
|
80 | * Given a device ID, issues a request to invoke a named device method (with possible
|
81 | parameters). See the "Example POST" code snippet below.
|
82 | */
|
83 | invokeDeviceMethod(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse) => void): Request<IoT1ClickDevicesService.Types.InvokeDeviceMethodResponse, AWSError>;
|
84 | /**
|
85 | * Using a device ID, returns a DeviceEventsResponse object containing an
|
86 | array of events for the device.
|
87 | */
|
88 | listDeviceEvents(params: IoT1ClickDevicesService.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDeviceEventsResponse) => void): Request<IoT1ClickDevicesService.Types.ListDeviceEventsResponse, AWSError>;
|
89 | /**
|
90 | * Using a device ID, returns a DeviceEventsResponse object containing an
|
91 | array of events for the device.
|
92 | */
|
93 | listDeviceEvents(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDeviceEventsResponse) => void): Request<IoT1ClickDevicesService.Types.ListDeviceEventsResponse, AWSError>;
|
94 | /**
|
95 | * Lists the 1-Click compatible devices associated with your AWS account.
|
96 | */
|
97 | listDevices(params: IoT1ClickDevicesService.Types.ListDevicesRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDevicesResponse) => void): Request<IoT1ClickDevicesService.Types.ListDevicesResponse, AWSError>;
|
98 | /**
|
99 | * Lists the 1-Click compatible devices associated with your AWS account.
|
100 | */
|
101 | listDevices(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListDevicesResponse) => void): Request<IoT1ClickDevicesService.Types.ListDevicesResponse, AWSError>;
|
102 | /**
|
103 | * Lists the tags associated with the specified resource ARN.
|
104 | */
|
105 | listTagsForResource(params: IoT1ClickDevicesService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListTagsForResourceResponse) => void): Request<IoT1ClickDevicesService.Types.ListTagsForResourceResponse, AWSError>;
|
106 | /**
|
107 | * Lists the tags associated with the specified resource ARN.
|
108 | */
|
109 | listTagsForResource(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.ListTagsForResourceResponse) => void): Request<IoT1ClickDevicesService.Types.ListTagsForResourceResponse, AWSError>;
|
110 | /**
|
111 | * 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
|
112 | resource.
|
113 | */
|
114 | tagResource(params: IoT1ClickDevicesService.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
115 | |
116 |
|
117 |
|
118 |
|
119 | tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
120 | |
121 |
|
122 |
|
123 | unclaimDevice(params: IoT1ClickDevicesService.Types.UnclaimDeviceRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UnclaimDeviceResponse) => void): Request<IoT1ClickDevicesService.Types.UnclaimDeviceResponse, AWSError>;
|
124 | |
125 |
|
126 |
|
127 | unclaimDevice(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UnclaimDeviceResponse) => void): Request<IoT1ClickDevicesService.Types.UnclaimDeviceResponse, AWSError>;
|
128 | |
129 |
|
130 |
|
131 |
|
132 | untagResource(params: IoT1ClickDevicesService.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
133 | |
134 |
|
135 |
|
136 |
|
137 | untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
138 | |
139 |
|
140 |
|
141 |
|
142 | updateDeviceState(params: IoT1ClickDevicesService.Types.UpdateDeviceStateRequest, callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UpdateDeviceStateResponse) => void): Request<IoT1ClickDevicesService.Types.UpdateDeviceStateResponse, AWSError>;
|
143 | |
144 |
|
145 |
|
146 |
|
147 | updateDeviceState(callback?: (err: AWSError, data: IoT1ClickDevicesService.Types.UpdateDeviceStateResponse) => void): Request<IoT1ClickDevicesService.Types.UpdateDeviceStateResponse, AWSError>;
|
148 | }
|
149 | declare namespace IoT1ClickDevicesService {
|
150 | export interface Attributes {
|
151 | }
|
152 | export interface ClaimDevicesByClaimCodeRequest {
|
153 | |
154 |
|
155 |
|
156 | ClaimCode: __string;
|
157 | }
|
158 | export interface ClaimDevicesByClaimCodeResponse {
|
159 | |
160 |
|
161 |
|
162 | ClaimCode?: __stringMin12Max40;
|
163 | |
164 |
|
165 |
|
166 |
|
167 | Total?: __integer;
|
168 | }
|
169 | export interface DescribeDeviceRequest {
|
170 | |
171 |
|
172 |
|
173 | DeviceId: __string;
|
174 | }
|
175 | export interface DescribeDeviceResponse {
|
176 | |
177 |
|
178 |
|
179 | DeviceDescription?: DeviceDescription;
|
180 | }
|
181 | export interface Device {
|
182 | |
183 |
|
184 |
|
185 | Attributes?: Attributes;
|
186 | |
187 |
|
188 |
|
189 | DeviceId?: __string;
|
190 | |
191 |
|
192 |
|
193 | Type?: __string;
|
194 | }
|
195 | export type DeviceAttributes = {[key: string]: __string};
|
196 | export interface DeviceDescription {
|
197 | |
198 |
|
199 |
|
200 | Arn?: __string;
|
201 | |
202 |
|
203 |
|
204 |
|
205 | Attributes?: DeviceAttributes;
|
206 | |
207 |
|
208 |
|
209 | DeviceId?: __string;
|
210 | |
211 |
|
212 |
|
213 | Enabled?: __boolean;
|
214 | |
215 |
|
216 |
|
217 |
|
218 | RemainingLife?: __doubleMin0Max100;
|
219 | |
220 |
|
221 |
|
222 | Type?: __string;
|
223 | |
224 |
|
225 |
|
226 | Tags?: __mapOf__string;
|
227 | }
|
228 | export interface DeviceEvent {
|
229 | |
230 |
|
231 |
|
232 | Device?: Device;
|
233 | |
234 |
|
235 |
|
236 | StdEvent?: __string;
|
237 | }
|
238 | export interface DeviceMethod {
|
239 | |
240 |
|
241 |
|
242 | DeviceType?: __string;
|
243 | |
244 |
|
245 |
|
246 | MethodName?: __string;
|
247 | }
|
248 | export interface FinalizeDeviceClaimRequest {
|
249 | |
250 |
|
251 |
|
252 | DeviceId: __string;
|
253 | |
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 |
|
260 | Tags?: __mapOf__string;
|
261 | }
|
262 | export interface FinalizeDeviceClaimResponse {
|
263 | |
264 |
|
265 |
|
266 | State?: __string;
|
267 | }
|
268 | export interface GetDeviceMethodsRequest {
|
269 | |
270 |
|
271 |
|
272 | DeviceId: __string;
|
273 | }
|
274 | export interface GetDeviceMethodsResponse {
|
275 | |
276 |
|
277 |
|
278 | DeviceMethods?: __listOfDeviceMethod;
|
279 | }
|
280 | export interface InitiateDeviceClaimRequest {
|
281 | |
282 |
|
283 |
|
284 | DeviceId: __string;
|
285 | }
|
286 | export interface InitiateDeviceClaimResponse {
|
287 | |
288 |
|
289 |
|
290 | State?: __string;
|
291 | }
|
292 | export interface InvokeDeviceMethodRequest {
|
293 | |
294 |
|
295 |
|
296 | DeviceId: __string;
|
297 | |
298 |
|
299 |
|
300 | DeviceMethod?: DeviceMethod;
|
301 | |
302 |
|
303 |
|
304 | DeviceMethodParameters?: __string;
|
305 | }
|
306 | export interface InvokeDeviceMethodResponse {
|
307 | |
308 |
|
309 |
|
310 | DeviceMethodResponse?: __string;
|
311 | }
|
312 | export interface ListDeviceEventsRequest {
|
313 | |
314 |
|
315 |
|
316 | DeviceId: __string;
|
317 | |
318 |
|
319 |
|
320 |
|
321 |
|
322 | FromTimeStamp: __timestampIso8601;
|
323 | |
324 |
|
325 |
|
326 |
|
327 | MaxResults?: MaxResults;
|
328 | |
329 |
|
330 |
|
331 | NextToken?: __string;
|
332 | |
333 |
|
334 |
|
335 |
|
336 |
|
337 | ToTimeStamp: __timestampIso8601;
|
338 | }
|
339 | export interface ListDeviceEventsResponse {
|
340 | |
341 |
|
342 |
|
343 |
|
344 | Events?: __listOfDeviceEvent;
|
345 | |
346 |
|
347 |
|
348 | NextToken?: __string;
|
349 | }
|
350 | export interface ListDevicesRequest {
|
351 | |
352 |
|
353 |
|
354 | DeviceType?: __string;
|
355 | |
356 |
|
357 |
|
358 |
|
359 | MaxResults?: MaxResults;
|
360 | |
361 |
|
362 |
|
363 | NextToken?: __string;
|
364 | }
|
365 | export interface ListDevicesResponse {
|
366 | |
367 |
|
368 |
|
369 | Devices?: __listOfDeviceDescription;
|
370 | |
371 |
|
372 |
|
373 | NextToken?: __string;
|
374 | }
|
375 | export interface ListTagsForResourceRequest {
|
376 | |
377 |
|
378 |
|
379 | ResourceArn: __string;
|
380 | }
|
381 | export interface ListTagsForResourceResponse {
|
382 | |
383 |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 | Tags?: __mapOf__string;
|
390 | }
|
391 | export type MaxResults = number;
|
392 | export interface TagResourceRequest {
|
393 | |
394 |
|
395 |
|
396 | ResourceArn: __string;
|
397 | |
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 | Tags: __mapOf__string;
|
405 | }
|
406 | export interface UnclaimDeviceRequest {
|
407 | |
408 |
|
409 |
|
410 | DeviceId: __string;
|
411 | }
|
412 | export interface UnclaimDeviceResponse {
|
413 | |
414 |
|
415 |
|
416 | State?: __string;
|
417 | }
|
418 | export interface UntagResourceRequest {
|
419 | |
420 |
|
421 |
|
422 | ResourceArn: __string;
|
423 | |
424 |
|
425 |
|
426 | TagKeys: __listOf__string;
|
427 | }
|
428 | export interface UpdateDeviceStateRequest {
|
429 | |
430 |
|
431 |
|
432 | DeviceId: __string;
|
433 | |
434 |
|
435 |
|
436 |
|
437 | Enabled?: __boolean;
|
438 | }
|
439 | export interface UpdateDeviceStateResponse {
|
440 | }
|
441 | export type __boolean = boolean;
|
442 | export type __doubleMin0Max100 = number;
|
443 | export type __integer = number;
|
444 | export type __listOfDeviceDescription = DeviceDescription[];
|
445 | export type __listOfDeviceEvent = DeviceEvent[];
|
446 | export type __listOfDeviceMethod = DeviceMethod[];
|
447 | export type __listOf__string = __string[];
|
448 | export type __mapOf__string = {[key: string]: __string};
|
449 | export type __string = string;
|
450 | export type __stringMin12Max40 = string;
|
451 | export type __timestampIso8601 = Date;
|
452 | |
453 |
|
454 |
|
455 | export type apiVersion = "2018-05-14"|"latest"|string;
|
456 | export interface ClientApiVersions {
|
457 | |
458 |
|
459 |
|
460 | apiVersion?: apiVersion;
|
461 | }
|
462 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
463 | |
464 |
|
465 |
|
466 | export import Types = IoT1ClickDevicesService;
|
467 | }
|
468 | export = IoT1ClickDevicesService;
|