snow-device-management-2021-08-04.min.json 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2021-08-04",
  5. "endpointPrefix": "snow-device-management",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceFullName": "AWS Snow Device Management",
  9. "serviceId": "Snow Device Management",
  10. "signatureVersion": "v4",
  11. "signingName": "snow-device-management",
  12. "uid": "snow-device-management-2021-08-04"
  13. },
  14. "operations": {
  15. "CancelTask": {
  16. "http": {
  17. "requestUri": "/task/{taskId}/cancel",
  18. "responseCode": 200
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "taskId"
  24. ],
  25. "members": {
  26. "taskId": {
  27. "location": "uri",
  28. "locationName": "taskId"
  29. }
  30. }
  31. },
  32. "output": {
  33. "type": "structure",
  34. "members": {
  35. "taskId": {}
  36. }
  37. }
  38. },
  39. "CreateTask": {
  40. "http": {
  41. "requestUri": "/task",
  42. "responseCode": 200
  43. },
  44. "input": {
  45. "type": "structure",
  46. "required": [
  47. "command",
  48. "targets"
  49. ],
  50. "members": {
  51. "clientToken": {
  52. "idempotencyToken": true
  53. },
  54. "command": {
  55. "type": "structure",
  56. "members": {
  57. "reboot": {
  58. "type": "structure",
  59. "members": {}
  60. },
  61. "unlock": {
  62. "type": "structure",
  63. "members": {}
  64. }
  65. },
  66. "union": true
  67. },
  68. "description": {},
  69. "tags": {
  70. "shape": "Sb"
  71. },
  72. "targets": {
  73. "shape": "Sc"
  74. }
  75. }
  76. },
  77. "output": {
  78. "type": "structure",
  79. "members": {
  80. "taskArn": {},
  81. "taskId": {}
  82. }
  83. }
  84. },
  85. "DescribeDevice": {
  86. "http": {
  87. "requestUri": "/managed-device/{managedDeviceId}/describe",
  88. "responseCode": 200
  89. },
  90. "input": {
  91. "type": "structure",
  92. "required": [
  93. "managedDeviceId"
  94. ],
  95. "members": {
  96. "managedDeviceId": {
  97. "location": "uri",
  98. "locationName": "managedDeviceId"
  99. }
  100. }
  101. },
  102. "output": {
  103. "type": "structure",
  104. "members": {
  105. "associatedWithJob": {},
  106. "deviceCapacities": {
  107. "type": "list",
  108. "member": {
  109. "type": "structure",
  110. "members": {
  111. "available": {
  112. "type": "long"
  113. },
  114. "name": {},
  115. "total": {
  116. "type": "long"
  117. },
  118. "unit": {},
  119. "used": {
  120. "type": "long"
  121. }
  122. }
  123. }
  124. },
  125. "deviceState": {},
  126. "deviceType": {},
  127. "lastReachedOutAt": {
  128. "type": "timestamp"
  129. },
  130. "lastUpdatedAt": {
  131. "type": "timestamp"
  132. },
  133. "managedDeviceArn": {},
  134. "managedDeviceId": {},
  135. "physicalNetworkInterfaces": {
  136. "type": "list",
  137. "member": {
  138. "type": "structure",
  139. "members": {
  140. "defaultGateway": {},
  141. "ipAddress": {},
  142. "ipAddressAssignment": {},
  143. "macAddress": {},
  144. "netmask": {},
  145. "physicalConnectorType": {},
  146. "physicalNetworkInterfaceId": {}
  147. }
  148. }
  149. },
  150. "software": {
  151. "type": "structure",
  152. "members": {
  153. "installState": {},
  154. "installedVersion": {},
  155. "installingVersion": {}
  156. }
  157. },
  158. "tags": {
  159. "shape": "Sb"
  160. }
  161. }
  162. }
  163. },
  164. "DescribeDeviceEc2Instances": {
  165. "http": {
  166. "requestUri": "/managed-device/{managedDeviceId}/resources/ec2/describe",
  167. "responseCode": 200
  168. },
  169. "input": {
  170. "type": "structure",
  171. "required": [
  172. "instanceIds",
  173. "managedDeviceId"
  174. ],
  175. "members": {
  176. "instanceIds": {
  177. "type": "list",
  178. "member": {}
  179. },
  180. "managedDeviceId": {
  181. "location": "uri",
  182. "locationName": "managedDeviceId"
  183. }
  184. }
  185. },
  186. "output": {
  187. "type": "structure",
  188. "members": {
  189. "instances": {
  190. "type": "list",
  191. "member": {
  192. "type": "structure",
  193. "members": {
  194. "instance": {
  195. "type": "structure",
  196. "members": {
  197. "amiLaunchIndex": {
  198. "type": "integer"
  199. },
  200. "blockDeviceMappings": {
  201. "type": "list",
  202. "member": {
  203. "type": "structure",
  204. "members": {
  205. "deviceName": {},
  206. "ebs": {
  207. "type": "structure",
  208. "members": {
  209. "attachTime": {
  210. "type": "timestamp"
  211. },
  212. "deleteOnTermination": {
  213. "type": "boolean"
  214. },
  215. "status": {},
  216. "volumeId": {}
  217. }
  218. }
  219. }
  220. }
  221. },
  222. "cpuOptions": {
  223. "type": "structure",
  224. "members": {
  225. "coreCount": {
  226. "type": "integer"
  227. },
  228. "threadsPerCore": {
  229. "type": "integer"
  230. }
  231. }
  232. },
  233. "createdAt": {
  234. "type": "timestamp"
  235. },
  236. "imageId": {},
  237. "instanceId": {},
  238. "instanceType": {},
  239. "privateIpAddress": {},
  240. "publicIpAddress": {},
  241. "rootDeviceName": {},
  242. "securityGroups": {
  243. "type": "list",
  244. "member": {
  245. "type": "structure",
  246. "members": {
  247. "groupId": {},
  248. "groupName": {}
  249. }
  250. }
  251. },
  252. "state": {
  253. "type": "structure",
  254. "members": {
  255. "code": {
  256. "type": "integer"
  257. },
  258. "name": {}
  259. }
  260. },
  261. "updatedAt": {
  262. "type": "timestamp"
  263. }
  264. }
  265. },
  266. "lastUpdatedAt": {
  267. "type": "timestamp"
  268. }
  269. }
  270. }
  271. }
  272. }
  273. }
  274. },
  275. "DescribeExecution": {
  276. "http": {
  277. "requestUri": "/task/{taskId}/execution/{managedDeviceId}",
  278. "responseCode": 200
  279. },
  280. "input": {
  281. "type": "structure",
  282. "required": [
  283. "managedDeviceId",
  284. "taskId"
  285. ],
  286. "members": {
  287. "managedDeviceId": {
  288. "location": "uri",
  289. "locationName": "managedDeviceId"
  290. },
  291. "taskId": {
  292. "location": "uri",
  293. "locationName": "taskId"
  294. }
  295. }
  296. },
  297. "output": {
  298. "type": "structure",
  299. "members": {
  300. "executionId": {},
  301. "lastUpdatedAt": {
  302. "type": "timestamp"
  303. },
  304. "managedDeviceId": {},
  305. "startedAt": {
  306. "type": "timestamp"
  307. },
  308. "state": {},
  309. "taskId": {}
  310. }
  311. }
  312. },
  313. "DescribeTask": {
  314. "http": {
  315. "requestUri": "/task/{taskId}",
  316. "responseCode": 200
  317. },
  318. "input": {
  319. "type": "structure",
  320. "required": [
  321. "taskId"
  322. ],
  323. "members": {
  324. "taskId": {
  325. "location": "uri",
  326. "locationName": "taskId"
  327. }
  328. }
  329. },
  330. "output": {
  331. "type": "structure",
  332. "members": {
  333. "completedAt": {
  334. "type": "timestamp"
  335. },
  336. "createdAt": {
  337. "type": "timestamp"
  338. },
  339. "description": {},
  340. "lastUpdatedAt": {
  341. "type": "timestamp"
  342. },
  343. "state": {},
  344. "tags": {
  345. "shape": "Sb"
  346. },
  347. "targets": {
  348. "shape": "Sc"
  349. },
  350. "taskArn": {},
  351. "taskId": {}
  352. }
  353. }
  354. },
  355. "ListDeviceResources": {
  356. "http": {
  357. "method": "GET",
  358. "requestUri": "/managed-device/{managedDeviceId}/resources",
  359. "responseCode": 200
  360. },
  361. "input": {
  362. "type": "structure",
  363. "required": [
  364. "managedDeviceId"
  365. ],
  366. "members": {
  367. "managedDeviceId": {
  368. "location": "uri",
  369. "locationName": "managedDeviceId"
  370. },
  371. "maxResults": {
  372. "location": "querystring",
  373. "locationName": "maxResults",
  374. "type": "integer"
  375. },
  376. "nextToken": {
  377. "location": "querystring",
  378. "locationName": "nextToken"
  379. },
  380. "type": {
  381. "location": "querystring",
  382. "locationName": "type"
  383. }
  384. }
  385. },
  386. "output": {
  387. "type": "structure",
  388. "members": {
  389. "nextToken": {},
  390. "resources": {
  391. "type": "list",
  392. "member": {
  393. "type": "structure",
  394. "required": [
  395. "resourceType"
  396. ],
  397. "members": {
  398. "arn": {},
  399. "id": {},
  400. "resourceType": {}
  401. }
  402. }
  403. }
  404. }
  405. }
  406. },
  407. "ListDevices": {
  408. "http": {
  409. "method": "GET",
  410. "requestUri": "/managed-devices",
  411. "responseCode": 200
  412. },
  413. "input": {
  414. "type": "structure",
  415. "members": {
  416. "jobId": {
  417. "location": "querystring",
  418. "locationName": "jobId"
  419. },
  420. "maxResults": {
  421. "location": "querystring",
  422. "locationName": "maxResults",
  423. "type": "integer"
  424. },
  425. "nextToken": {
  426. "location": "querystring",
  427. "locationName": "nextToken"
  428. }
  429. }
  430. },
  431. "output": {
  432. "type": "structure",
  433. "members": {
  434. "devices": {
  435. "type": "list",
  436. "member": {
  437. "type": "structure",
  438. "members": {
  439. "associatedWithJob": {},
  440. "managedDeviceArn": {},
  441. "managedDeviceId": {},
  442. "tags": {
  443. "shape": "Sb"
  444. }
  445. }
  446. }
  447. },
  448. "nextToken": {}
  449. }
  450. }
  451. },
  452. "ListExecutions": {
  453. "http": {
  454. "method": "GET",
  455. "requestUri": "/executions",
  456. "responseCode": 200
  457. },
  458. "input": {
  459. "type": "structure",
  460. "required": [
  461. "taskId"
  462. ],
  463. "members": {
  464. "maxResults": {
  465. "location": "querystring",
  466. "locationName": "maxResults",
  467. "type": "integer"
  468. },
  469. "nextToken": {
  470. "location": "querystring",
  471. "locationName": "nextToken"
  472. },
  473. "state": {
  474. "location": "querystring",
  475. "locationName": "state"
  476. },
  477. "taskId": {
  478. "location": "querystring",
  479. "locationName": "taskId"
  480. }
  481. }
  482. },
  483. "output": {
  484. "type": "structure",
  485. "members": {
  486. "executions": {
  487. "type": "list",
  488. "member": {
  489. "type": "structure",
  490. "members": {
  491. "executionId": {},
  492. "managedDeviceId": {},
  493. "state": {},
  494. "taskId": {}
  495. }
  496. }
  497. },
  498. "nextToken": {}
  499. }
  500. }
  501. },
  502. "ListTagsForResource": {
  503. "http": {
  504. "method": "GET",
  505. "requestUri": "/tags/{resourceArn}",
  506. "responseCode": 200
  507. },
  508. "input": {
  509. "type": "structure",
  510. "required": [
  511. "resourceArn"
  512. ],
  513. "members": {
  514. "resourceArn": {
  515. "location": "uri",
  516. "locationName": "resourceArn"
  517. }
  518. }
  519. },
  520. "output": {
  521. "type": "structure",
  522. "members": {
  523. "tags": {
  524. "shape": "Sb"
  525. }
  526. }
  527. }
  528. },
  529. "ListTasks": {
  530. "http": {
  531. "method": "GET",
  532. "requestUri": "/tasks",
  533. "responseCode": 200
  534. },
  535. "input": {
  536. "type": "structure",
  537. "members": {
  538. "maxResults": {
  539. "location": "querystring",
  540. "locationName": "maxResults",
  541. "type": "integer"
  542. },
  543. "nextToken": {
  544. "location": "querystring",
  545. "locationName": "nextToken"
  546. },
  547. "state": {
  548. "location": "querystring",
  549. "locationName": "state"
  550. }
  551. }
  552. },
  553. "output": {
  554. "type": "structure",
  555. "members": {
  556. "nextToken": {},
  557. "tasks": {
  558. "type": "list",
  559. "member": {
  560. "type": "structure",
  561. "required": [
  562. "taskId"
  563. ],
  564. "members": {
  565. "state": {},
  566. "tags": {
  567. "shape": "Sb"
  568. },
  569. "taskArn": {},
  570. "taskId": {}
  571. }
  572. }
  573. }
  574. }
  575. }
  576. },
  577. "TagResource": {
  578. "http": {
  579. "requestUri": "/tags/{resourceArn}",
  580. "responseCode": 200
  581. },
  582. "input": {
  583. "type": "structure",
  584. "required": [
  585. "resourceArn",
  586. "tags"
  587. ],
  588. "members": {
  589. "resourceArn": {
  590. "location": "uri",
  591. "locationName": "resourceArn"
  592. },
  593. "tags": {
  594. "shape": "Sb"
  595. }
  596. }
  597. }
  598. },
  599. "UntagResource": {
  600. "http": {
  601. "method": "DELETE",
  602. "requestUri": "/tags/{resourceArn}",
  603. "responseCode": 200
  604. },
  605. "input": {
  606. "type": "structure",
  607. "required": [
  608. "resourceArn",
  609. "tagKeys"
  610. ],
  611. "members": {
  612. "resourceArn": {
  613. "location": "uri",
  614. "locationName": "resourceArn"
  615. },
  616. "tagKeys": {
  617. "location": "querystring",
  618. "locationName": "tagKeys",
  619. "type": "list",
  620. "member": {}
  621. }
  622. }
  623. },
  624. "idempotent": true
  625. }
  626. },
  627. "shapes": {
  628. "Sb": {
  629. "type": "map",
  630. "key": {},
  631. "value": {}
  632. },
  633. "Sc": {
  634. "type": "list",
  635. "member": {}
  636. }
  637. }
  638. }