UNPKG

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