1 | {
|
2 | "metadata": {
|
3 | "apiVersion": "2018-05-14",
|
4 | "endpointPrefix": "devices.iot1click",
|
5 | "signingName": "iot1click",
|
6 | "serviceFullName": "AWS IoT 1-Click Devices Service",
|
7 | "serviceId": "IoT 1Click Devices Service",
|
8 | "protocol": "rest-json",
|
9 | "jsonVersion": "1.1",
|
10 | "uid": "devices-2018-05-14",
|
11 | "signatureVersion": "v4"
|
12 | },
|
13 | "operations": {
|
14 | "ClaimDevicesByClaimCode": {
|
15 | "http": {
|
16 | "method": "PUT",
|
17 | "requestUri": "/claims/{claimCode}",
|
18 | "responseCode": 200
|
19 | },
|
20 | "input": {
|
21 | "type": "structure",
|
22 | "members": {
|
23 | "ClaimCode": {
|
24 | "location": "uri",
|
25 | "locationName": "claimCode"
|
26 | }
|
27 | },
|
28 | "required": [
|
29 | "ClaimCode"
|
30 | ]
|
31 | },
|
32 | "output": {
|
33 | "type": "structure",
|
34 | "members": {
|
35 | "ClaimCode": {
|
36 | "locationName": "claimCode"
|
37 | },
|
38 | "Total": {
|
39 | "locationName": "total",
|
40 | "type": "integer"
|
41 | }
|
42 | }
|
43 | }
|
44 | },
|
45 | "DescribeDevice": {
|
46 | "http": {
|
47 | "method": "GET",
|
48 | "requestUri": "/devices/{deviceId}",
|
49 | "responseCode": 200
|
50 | },
|
51 | "input": {
|
52 | "type": "structure",
|
53 | "members": {
|
54 | "DeviceId": {
|
55 | "location": "uri",
|
56 | "locationName": "deviceId"
|
57 | }
|
58 | },
|
59 | "required": [
|
60 | "DeviceId"
|
61 | ]
|
62 | },
|
63 | "output": {
|
64 | "type": "structure",
|
65 | "members": {
|
66 | "DeviceDescription": {
|
67 | "shape": "S8",
|
68 | "locationName": "deviceDescription"
|
69 | }
|
70 | }
|
71 | }
|
72 | },
|
73 | "FinalizeDeviceClaim": {
|
74 | "http": {
|
75 | "method": "PUT",
|
76 | "requestUri": "/devices/{deviceId}/finalize-claim",
|
77 | "responseCode": 200
|
78 | },
|
79 | "input": {
|
80 | "type": "structure",
|
81 | "members": {
|
82 | "DeviceId": {
|
83 | "location": "uri",
|
84 | "locationName": "deviceId"
|
85 | },
|
86 | "Tags": {
|
87 | "shape": "Sc",
|
88 | "locationName": "tags"
|
89 | }
|
90 | },
|
91 | "required": [
|
92 | "DeviceId"
|
93 | ]
|
94 | },
|
95 | "output": {
|
96 | "type": "structure",
|
97 | "members": {
|
98 | "State": {
|
99 | "locationName": "state"
|
100 | }
|
101 | }
|
102 | }
|
103 | },
|
104 | "GetDeviceMethods": {
|
105 | "http": {
|
106 | "method": "GET",
|
107 | "requestUri": "/devices/{deviceId}/methods",
|
108 | "responseCode": 200
|
109 | },
|
110 | "input": {
|
111 | "type": "structure",
|
112 | "members": {
|
113 | "DeviceId": {
|
114 | "location": "uri",
|
115 | "locationName": "deviceId"
|
116 | }
|
117 | },
|
118 | "required": [
|
119 | "DeviceId"
|
120 | ]
|
121 | },
|
122 | "output": {
|
123 | "type": "structure",
|
124 | "members": {
|
125 | "DeviceMethods": {
|
126 | "locationName": "deviceMethods",
|
127 | "type": "list",
|
128 | "member": {
|
129 | "shape": "Si"
|
130 | }
|
131 | }
|
132 | }
|
133 | }
|
134 | },
|
135 | "InitiateDeviceClaim": {
|
136 | "http": {
|
137 | "method": "PUT",
|
138 | "requestUri": "/devices/{deviceId}/initiate-claim",
|
139 | "responseCode": 200
|
140 | },
|
141 | "input": {
|
142 | "type": "structure",
|
143 | "members": {
|
144 | "DeviceId": {
|
145 | "location": "uri",
|
146 | "locationName": "deviceId"
|
147 | }
|
148 | },
|
149 | "required": [
|
150 | "DeviceId"
|
151 | ]
|
152 | },
|
153 | "output": {
|
154 | "type": "structure",
|
155 | "members": {
|
156 | "State": {
|
157 | "locationName": "state"
|
158 | }
|
159 | }
|
160 | }
|
161 | },
|
162 | "InvokeDeviceMethod": {
|
163 | "http": {
|
164 | "requestUri": "/devices/{deviceId}/methods",
|
165 | "responseCode": 200
|
166 | },
|
167 | "input": {
|
168 | "type": "structure",
|
169 | "members": {
|
170 | "DeviceId": {
|
171 | "location": "uri",
|
172 | "locationName": "deviceId"
|
173 | },
|
174 | "DeviceMethod": {
|
175 | "shape": "Si",
|
176 | "locationName": "deviceMethod"
|
177 | },
|
178 | "DeviceMethodParameters": {
|
179 | "locationName": "deviceMethodParameters"
|
180 | }
|
181 | },
|
182 | "required": [
|
183 | "DeviceId"
|
184 | ]
|
185 | },
|
186 | "output": {
|
187 | "type": "structure",
|
188 | "members": {
|
189 | "DeviceMethodResponse": {
|
190 | "locationName": "deviceMethodResponse"
|
191 | }
|
192 | }
|
193 | }
|
194 | },
|
195 | "ListDeviceEvents": {
|
196 | "http": {
|
197 | "method": "GET",
|
198 | "requestUri": "/devices/{deviceId}/events",
|
199 | "responseCode": 200
|
200 | },
|
201 | "input": {
|
202 | "type": "structure",
|
203 | "members": {
|
204 | "DeviceId": {
|
205 | "location": "uri",
|
206 | "locationName": "deviceId"
|
207 | },
|
208 | "FromTimeStamp": {
|
209 | "shape": "So",
|
210 | "location": "querystring",
|
211 | "locationName": "fromTimeStamp"
|
212 | },
|
213 | "MaxResults": {
|
214 | "location": "querystring",
|
215 | "locationName": "maxResults",
|
216 | "type": "integer"
|
217 | },
|
218 | "NextToken": {
|
219 | "location": "querystring",
|
220 | "locationName": "nextToken"
|
221 | },
|
222 | "ToTimeStamp": {
|
223 | "shape": "So",
|
224 | "location": "querystring",
|
225 | "locationName": "toTimeStamp"
|
226 | }
|
227 | },
|
228 | "required": [
|
229 | "DeviceId",
|
230 | "FromTimeStamp",
|
231 | "ToTimeStamp"
|
232 | ]
|
233 | },
|
234 | "output": {
|
235 | "type": "structure",
|
236 | "members": {
|
237 | "Events": {
|
238 | "locationName": "events",
|
239 | "type": "list",
|
240 | "member": {
|
241 | "type": "structure",
|
242 | "members": {
|
243 | "Device": {
|
244 | "locationName": "device",
|
245 | "type": "structure",
|
246 | "members": {
|
247 | "Attributes": {
|
248 | "locationName": "attributes",
|
249 | "type": "structure",
|
250 | "members": {}
|
251 | },
|
252 | "DeviceId": {
|
253 | "locationName": "deviceId"
|
254 | },
|
255 | "Type": {
|
256 | "locationName": "type"
|
257 | }
|
258 | }
|
259 | },
|
260 | "StdEvent": {
|
261 | "locationName": "stdEvent"
|
262 | }
|
263 | }
|
264 | }
|
265 | },
|
266 | "NextToken": {
|
267 | "locationName": "nextToken"
|
268 | }
|
269 | }
|
270 | }
|
271 | },
|
272 | "ListDevices": {
|
273 | "http": {
|
274 | "method": "GET",
|
275 | "requestUri": "/devices",
|
276 | "responseCode": 200
|
277 | },
|
278 | "input": {
|
279 | "type": "structure",
|
280 | "members": {
|
281 | "DeviceType": {
|
282 | "location": "querystring",
|
283 | "locationName": "deviceType"
|
284 | },
|
285 | "MaxResults": {
|
286 | "location": "querystring",
|
287 | "locationName": "maxResults",
|
288 | "type": "integer"
|
289 | },
|
290 | "NextToken": {
|
291 | "location": "querystring",
|
292 | "locationName": "nextToken"
|
293 | }
|
294 | }
|
295 | },
|
296 | "output": {
|
297 | "type": "structure",
|
298 | "members": {
|
299 | "Devices": {
|
300 | "locationName": "devices",
|
301 | "type": "list",
|
302 | "member": {
|
303 | "shape": "S8"
|
304 | }
|
305 | },
|
306 | "NextToken": {
|
307 | "locationName": "nextToken"
|
308 | }
|
309 | }
|
310 | }
|
311 | },
|
312 | "ListTagsForResource": {
|
313 | "http": {
|
314 | "method": "GET",
|
315 | "requestUri": "/tags/{resource-arn}",
|
316 | "responseCode": 200
|
317 | },
|
318 | "input": {
|
319 | "type": "structure",
|
320 | "members": {
|
321 | "ResourceArn": {
|
322 | "location": "uri",
|
323 | "locationName": "resource-arn"
|
324 | }
|
325 | },
|
326 | "required": [
|
327 | "ResourceArn"
|
328 | ]
|
329 | },
|
330 | "output": {
|
331 | "type": "structure",
|
332 | "members": {
|
333 | "Tags": {
|
334 | "shape": "Sc",
|
335 | "locationName": "tags"
|
336 | }
|
337 | }
|
338 | }
|
339 | },
|
340 | "TagResource": {
|
341 | "http": {
|
342 | "requestUri": "/tags/{resource-arn}",
|
343 | "responseCode": 204
|
344 | },
|
345 | "input": {
|
346 | "type": "structure",
|
347 | "members": {
|
348 | "ResourceArn": {
|
349 | "location": "uri",
|
350 | "locationName": "resource-arn"
|
351 | },
|
352 | "Tags": {
|
353 | "shape": "Sc",
|
354 | "locationName": "tags"
|
355 | }
|
356 | },
|
357 | "required": [
|
358 | "ResourceArn",
|
359 | "Tags"
|
360 | ]
|
361 | }
|
362 | },
|
363 | "UnclaimDevice": {
|
364 | "http": {
|
365 | "method": "PUT",
|
366 | "requestUri": "/devices/{deviceId}/unclaim",
|
367 | "responseCode": 200
|
368 | },
|
369 | "input": {
|
370 | "type": "structure",
|
371 | "members": {
|
372 | "DeviceId": {
|
373 | "location": "uri",
|
374 | "locationName": "deviceId"
|
375 | }
|
376 | },
|
377 | "required": [
|
378 | "DeviceId"
|
379 | ]
|
380 | },
|
381 | "output": {
|
382 | "type": "structure",
|
383 | "members": {
|
384 | "State": {
|
385 | "locationName": "state"
|
386 | }
|
387 | }
|
388 | }
|
389 | },
|
390 | "UntagResource": {
|
391 | "http": {
|
392 | "method": "DELETE",
|
393 | "requestUri": "/tags/{resource-arn}",
|
394 | "responseCode": 204
|
395 | },
|
396 | "input": {
|
397 | "type": "structure",
|
398 | "members": {
|
399 | "ResourceArn": {
|
400 | "location": "uri",
|
401 | "locationName": "resource-arn"
|
402 | },
|
403 | "TagKeys": {
|
404 | "location": "querystring",
|
405 | "locationName": "tagKeys",
|
406 | "type": "list",
|
407 | "member": {}
|
408 | }
|
409 | },
|
410 | "required": [
|
411 | "TagKeys",
|
412 | "ResourceArn"
|
413 | ]
|
414 | }
|
415 | },
|
416 | "UpdateDeviceState": {
|
417 | "http": {
|
418 | "method": "PUT",
|
419 | "requestUri": "/devices/{deviceId}/state",
|
420 | "responseCode": 200
|
421 | },
|
422 | "input": {
|
423 | "type": "structure",
|
424 | "members": {
|
425 | "DeviceId": {
|
426 | "location": "uri",
|
427 | "locationName": "deviceId"
|
428 | },
|
429 | "Enabled": {
|
430 | "locationName": "enabled",
|
431 | "type": "boolean"
|
432 | }
|
433 | },
|
434 | "required": [
|
435 | "DeviceId"
|
436 | ]
|
437 | },
|
438 | "output": {
|
439 | "type": "structure",
|
440 | "members": {}
|
441 | }
|
442 | }
|
443 | },
|
444 | "shapes": {
|
445 | "S8": {
|
446 | "type": "structure",
|
447 | "members": {
|
448 | "Arn": {
|
449 | "locationName": "arn"
|
450 | },
|
451 | "Attributes": {
|
452 | "locationName": "attributes",
|
453 | "type": "map",
|
454 | "key": {},
|
455 | "value": {}
|
456 | },
|
457 | "DeviceId": {
|
458 | "locationName": "deviceId"
|
459 | },
|
460 | "Enabled": {
|
461 | "locationName": "enabled",
|
462 | "type": "boolean"
|
463 | },
|
464 | "RemainingLife": {
|
465 | "locationName": "remainingLife",
|
466 | "type": "double"
|
467 | },
|
468 | "Type": {
|
469 | "locationName": "type"
|
470 | },
|
471 | "Tags": {
|
472 | "shape": "Sc",
|
473 | "locationName": "tags"
|
474 | }
|
475 | }
|
476 | },
|
477 | "Sc": {
|
478 | "type": "map",
|
479 | "key": {},
|
480 | "value": {}
|
481 | },
|
482 | "Si": {
|
483 | "type": "structure",
|
484 | "members": {
|
485 | "DeviceType": {
|
486 | "locationName": "deviceType"
|
487 | },
|
488 | "MethodName": {
|
489 | "locationName": "methodName"
|
490 | }
|
491 | }
|
492 | },
|
493 | "So": {
|
494 | "type": "timestamp",
|
495 | "timestampFormat": "iso8601"
|
496 | }
|
497 | }
|
498 | } |
\ | No newline at end of file |