workspaces-thin-client-2023-08-22.min.json 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2023-08-22",
  5. "endpointPrefix": "thinclient",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceFullName": "Amazon WorkSpaces Thin Client",
  9. "serviceId": "WorkSpaces Thin Client",
  10. "signatureVersion": "v4",
  11. "signingName": "thinclient",
  12. "uid": "workspaces-thin-client-2023-08-22"
  13. },
  14. "operations": {
  15. "CreateEnvironment": {
  16. "http": {
  17. "requestUri": "/environments",
  18. "responseCode": 201
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "desktopArn"
  24. ],
  25. "members": {
  26. "name": {
  27. "shape": "S2"
  28. },
  29. "desktopArn": {},
  30. "desktopEndpoint": {
  31. "shape": "S4"
  32. },
  33. "softwareSetUpdateSchedule": {},
  34. "maintenanceWindow": {
  35. "shape": "S6"
  36. },
  37. "softwareSetUpdateMode": {},
  38. "desiredSoftwareSetId": {},
  39. "kmsKeyArn": {},
  40. "clientToken": {
  41. "idempotencyToken": true
  42. },
  43. "tags": {
  44. "shape": "Sh"
  45. }
  46. }
  47. },
  48. "output": {
  49. "type": "structure",
  50. "members": {
  51. "environment": {
  52. "shape": "Sk"
  53. }
  54. }
  55. },
  56. "endpoint": {
  57. "hostPrefix": "api."
  58. }
  59. },
  60. "DeleteDevice": {
  61. "http": {
  62. "method": "DELETE",
  63. "requestUri": "/devices/{id}",
  64. "responseCode": 204
  65. },
  66. "input": {
  67. "type": "structure",
  68. "required": [
  69. "id"
  70. ],
  71. "members": {
  72. "id": {
  73. "location": "uri",
  74. "locationName": "id"
  75. },
  76. "clientToken": {
  77. "idempotencyToken": true,
  78. "location": "querystring",
  79. "locationName": "clientToken"
  80. }
  81. }
  82. },
  83. "output": {
  84. "type": "structure",
  85. "members": {}
  86. },
  87. "endpoint": {
  88. "hostPrefix": "api."
  89. },
  90. "idempotent": true
  91. },
  92. "DeleteEnvironment": {
  93. "http": {
  94. "method": "DELETE",
  95. "requestUri": "/environments/{id}",
  96. "responseCode": 204
  97. },
  98. "input": {
  99. "type": "structure",
  100. "required": [
  101. "id"
  102. ],
  103. "members": {
  104. "id": {
  105. "location": "uri",
  106. "locationName": "id"
  107. },
  108. "clientToken": {
  109. "idempotencyToken": true,
  110. "location": "querystring",
  111. "locationName": "clientToken"
  112. }
  113. }
  114. },
  115. "output": {
  116. "type": "structure",
  117. "members": {}
  118. },
  119. "endpoint": {
  120. "hostPrefix": "api."
  121. },
  122. "idempotent": true
  123. },
  124. "DeregisterDevice": {
  125. "http": {
  126. "requestUri": "/deregister-device/{id}",
  127. "responseCode": 202
  128. },
  129. "input": {
  130. "type": "structure",
  131. "required": [
  132. "id"
  133. ],
  134. "members": {
  135. "id": {
  136. "location": "uri",
  137. "locationName": "id"
  138. },
  139. "targetDeviceStatus": {},
  140. "clientToken": {
  141. "idempotencyToken": true
  142. }
  143. }
  144. },
  145. "output": {
  146. "type": "structure",
  147. "members": {}
  148. },
  149. "endpoint": {
  150. "hostPrefix": "api."
  151. },
  152. "idempotent": true
  153. },
  154. "GetDevice": {
  155. "http": {
  156. "method": "GET",
  157. "requestUri": "/devices/{id}",
  158. "responseCode": 200
  159. },
  160. "input": {
  161. "type": "structure",
  162. "required": [
  163. "id"
  164. ],
  165. "members": {
  166. "id": {
  167. "location": "uri",
  168. "locationName": "id"
  169. }
  170. }
  171. },
  172. "output": {
  173. "type": "structure",
  174. "members": {
  175. "device": {
  176. "type": "structure",
  177. "members": {
  178. "id": {},
  179. "serialNumber": {},
  180. "name": {
  181. "shape": "S10"
  182. },
  183. "model": {},
  184. "environmentId": {},
  185. "status": {},
  186. "currentSoftwareSetId": {},
  187. "currentSoftwareSetVersion": {},
  188. "desiredSoftwareSetId": {},
  189. "pendingSoftwareSetId": {},
  190. "pendingSoftwareSetVersion": {},
  191. "softwareSetUpdateSchedule": {},
  192. "softwareSetComplianceStatus": {},
  193. "softwareSetUpdateStatus": {},
  194. "lastConnectedAt": {
  195. "type": "timestamp"
  196. },
  197. "lastPostureAt": {
  198. "type": "timestamp"
  199. },
  200. "createdAt": {
  201. "type": "timestamp"
  202. },
  203. "updatedAt": {
  204. "type": "timestamp"
  205. },
  206. "arn": {},
  207. "kmsKeyArn": {},
  208. "tags": {
  209. "shape": "Sh"
  210. }
  211. }
  212. }
  213. }
  214. },
  215. "endpoint": {
  216. "hostPrefix": "api."
  217. }
  218. },
  219. "GetEnvironment": {
  220. "http": {
  221. "method": "GET",
  222. "requestUri": "/environments/{id}",
  223. "responseCode": 200
  224. },
  225. "input": {
  226. "type": "structure",
  227. "required": [
  228. "id"
  229. ],
  230. "members": {
  231. "id": {
  232. "location": "uri",
  233. "locationName": "id"
  234. }
  235. }
  236. },
  237. "output": {
  238. "type": "structure",
  239. "members": {
  240. "environment": {
  241. "type": "structure",
  242. "members": {
  243. "id": {},
  244. "name": {
  245. "shape": "S2"
  246. },
  247. "desktopArn": {},
  248. "desktopEndpoint": {
  249. "shape": "S4"
  250. },
  251. "desktopType": {},
  252. "activationCode": {},
  253. "registeredDevicesCount": {
  254. "type": "integer"
  255. },
  256. "softwareSetUpdateSchedule": {},
  257. "maintenanceWindow": {
  258. "shape": "S6"
  259. },
  260. "softwareSetUpdateMode": {},
  261. "desiredSoftwareSetId": {},
  262. "pendingSoftwareSetId": {},
  263. "pendingSoftwareSetVersion": {},
  264. "softwareSetComplianceStatus": {},
  265. "createdAt": {
  266. "type": "timestamp"
  267. },
  268. "updatedAt": {
  269. "type": "timestamp"
  270. },
  271. "arn": {},
  272. "kmsKeyArn": {},
  273. "tags": {
  274. "shape": "Sh"
  275. }
  276. }
  277. }
  278. }
  279. },
  280. "endpoint": {
  281. "hostPrefix": "api."
  282. }
  283. },
  284. "GetSoftwareSet": {
  285. "http": {
  286. "method": "GET",
  287. "requestUri": "/softwaresets/{id}",
  288. "responseCode": 200
  289. },
  290. "input": {
  291. "type": "structure",
  292. "required": [
  293. "id"
  294. ],
  295. "members": {
  296. "id": {
  297. "location": "uri",
  298. "locationName": "id"
  299. }
  300. }
  301. },
  302. "output": {
  303. "type": "structure",
  304. "members": {
  305. "softwareSet": {
  306. "type": "structure",
  307. "members": {
  308. "id": {},
  309. "version": {},
  310. "releasedAt": {
  311. "type": "timestamp"
  312. },
  313. "supportedUntil": {
  314. "type": "timestamp"
  315. },
  316. "validationStatus": {},
  317. "software": {
  318. "type": "list",
  319. "member": {
  320. "type": "structure",
  321. "members": {
  322. "name": {},
  323. "version": {}
  324. }
  325. }
  326. },
  327. "arn": {},
  328. "tags": {
  329. "shape": "Sh"
  330. }
  331. }
  332. }
  333. }
  334. },
  335. "endpoint": {
  336. "hostPrefix": "api."
  337. }
  338. },
  339. "ListDevices": {
  340. "http": {
  341. "method": "GET",
  342. "requestUri": "/devices",
  343. "responseCode": 200
  344. },
  345. "input": {
  346. "type": "structure",
  347. "members": {
  348. "nextToken": {
  349. "location": "querystring",
  350. "locationName": "nextToken"
  351. },
  352. "maxResults": {
  353. "location": "querystring",
  354. "locationName": "maxResults",
  355. "type": "integer"
  356. }
  357. }
  358. },
  359. "output": {
  360. "type": "structure",
  361. "members": {
  362. "devices": {
  363. "type": "list",
  364. "member": {
  365. "shape": "S1k"
  366. }
  367. },
  368. "nextToken": {}
  369. }
  370. },
  371. "endpoint": {
  372. "hostPrefix": "api."
  373. }
  374. },
  375. "ListEnvironments": {
  376. "http": {
  377. "method": "GET",
  378. "requestUri": "/environments",
  379. "responseCode": 200
  380. },
  381. "input": {
  382. "type": "structure",
  383. "members": {
  384. "nextToken": {
  385. "location": "querystring",
  386. "locationName": "nextToken"
  387. },
  388. "maxResults": {
  389. "location": "querystring",
  390. "locationName": "maxResults",
  391. "type": "integer"
  392. }
  393. }
  394. },
  395. "output": {
  396. "type": "structure",
  397. "members": {
  398. "environments": {
  399. "type": "list",
  400. "member": {
  401. "shape": "Sk"
  402. }
  403. },
  404. "nextToken": {}
  405. }
  406. },
  407. "endpoint": {
  408. "hostPrefix": "api."
  409. }
  410. },
  411. "ListSoftwareSets": {
  412. "http": {
  413. "method": "GET",
  414. "requestUri": "/softwaresets",
  415. "responseCode": 200
  416. },
  417. "input": {
  418. "type": "structure",
  419. "members": {
  420. "nextToken": {
  421. "location": "querystring",
  422. "locationName": "nextToken"
  423. },
  424. "maxResults": {
  425. "location": "querystring",
  426. "locationName": "maxResults",
  427. "type": "integer"
  428. }
  429. }
  430. },
  431. "output": {
  432. "type": "structure",
  433. "members": {
  434. "softwareSets": {
  435. "type": "list",
  436. "member": {
  437. "type": "structure",
  438. "members": {
  439. "id": {},
  440. "version": {},
  441. "releasedAt": {
  442. "type": "timestamp"
  443. },
  444. "supportedUntil": {
  445. "type": "timestamp"
  446. },
  447. "validationStatus": {},
  448. "arn": {}
  449. }
  450. }
  451. },
  452. "nextToken": {}
  453. }
  454. },
  455. "endpoint": {
  456. "hostPrefix": "api."
  457. }
  458. },
  459. "ListTagsForResource": {
  460. "http": {
  461. "method": "GET",
  462. "requestUri": "/tags/{resourceArn}",
  463. "responseCode": 200
  464. },
  465. "input": {
  466. "type": "structure",
  467. "required": [
  468. "resourceArn"
  469. ],
  470. "members": {
  471. "resourceArn": {
  472. "location": "uri",
  473. "locationName": "resourceArn"
  474. }
  475. }
  476. },
  477. "output": {
  478. "type": "structure",
  479. "members": {
  480. "tags": {
  481. "shape": "Sh"
  482. }
  483. }
  484. },
  485. "endpoint": {
  486. "hostPrefix": "api."
  487. }
  488. },
  489. "TagResource": {
  490. "http": {
  491. "requestUri": "/tags/{resourceArn}",
  492. "responseCode": 200
  493. },
  494. "input": {
  495. "type": "structure",
  496. "required": [
  497. "resourceArn",
  498. "tags"
  499. ],
  500. "members": {
  501. "resourceArn": {
  502. "location": "uri",
  503. "locationName": "resourceArn"
  504. },
  505. "tags": {
  506. "shape": "Sh"
  507. }
  508. }
  509. },
  510. "output": {
  511. "type": "structure",
  512. "members": {}
  513. },
  514. "endpoint": {
  515. "hostPrefix": "api."
  516. }
  517. },
  518. "UntagResource": {
  519. "http": {
  520. "method": "DELETE",
  521. "requestUri": "/tags/{resourceArn}",
  522. "responseCode": 200
  523. },
  524. "input": {
  525. "type": "structure",
  526. "required": [
  527. "resourceArn",
  528. "tagKeys"
  529. ],
  530. "members": {
  531. "resourceArn": {
  532. "location": "uri",
  533. "locationName": "resourceArn"
  534. },
  535. "tagKeys": {
  536. "location": "querystring",
  537. "locationName": "tagKeys",
  538. "type": "list",
  539. "member": {},
  540. "sensitive": true
  541. }
  542. }
  543. },
  544. "output": {
  545. "type": "structure",
  546. "members": {}
  547. },
  548. "endpoint": {
  549. "hostPrefix": "api."
  550. },
  551. "idempotent": true
  552. },
  553. "UpdateDevice": {
  554. "http": {
  555. "method": "PATCH",
  556. "requestUri": "/devices/{id}",
  557. "responseCode": 200
  558. },
  559. "input": {
  560. "type": "structure",
  561. "required": [
  562. "id"
  563. ],
  564. "members": {
  565. "id": {
  566. "location": "uri",
  567. "locationName": "id"
  568. },
  569. "name": {
  570. "shape": "S10"
  571. },
  572. "desiredSoftwareSetId": {},
  573. "softwareSetUpdateSchedule": {}
  574. }
  575. },
  576. "output": {
  577. "type": "structure",
  578. "members": {
  579. "device": {
  580. "shape": "S1k"
  581. }
  582. }
  583. },
  584. "endpoint": {
  585. "hostPrefix": "api."
  586. },
  587. "idempotent": true
  588. },
  589. "UpdateEnvironment": {
  590. "http": {
  591. "method": "PATCH",
  592. "requestUri": "/environments/{id}",
  593. "responseCode": 200
  594. },
  595. "input": {
  596. "type": "structure",
  597. "required": [
  598. "id"
  599. ],
  600. "members": {
  601. "id": {
  602. "location": "uri",
  603. "locationName": "id"
  604. },
  605. "name": {
  606. "shape": "S2"
  607. },
  608. "desktopArn": {},
  609. "desktopEndpoint": {
  610. "shape": "S4"
  611. },
  612. "softwareSetUpdateSchedule": {},
  613. "maintenanceWindow": {
  614. "shape": "S6"
  615. },
  616. "softwareSetUpdateMode": {},
  617. "desiredSoftwareSetId": {}
  618. }
  619. },
  620. "output": {
  621. "type": "structure",
  622. "members": {
  623. "environment": {
  624. "shape": "Sk"
  625. }
  626. }
  627. },
  628. "endpoint": {
  629. "hostPrefix": "api."
  630. },
  631. "idempotent": true
  632. },
  633. "UpdateSoftwareSet": {
  634. "http": {
  635. "method": "PATCH",
  636. "requestUri": "/softwaresets/{id}",
  637. "responseCode": 204
  638. },
  639. "input": {
  640. "type": "structure",
  641. "required": [
  642. "id",
  643. "validationStatus"
  644. ],
  645. "members": {
  646. "id": {
  647. "location": "uri",
  648. "locationName": "id"
  649. },
  650. "validationStatus": {}
  651. }
  652. },
  653. "output": {
  654. "type": "structure",
  655. "members": {}
  656. },
  657. "endpoint": {
  658. "hostPrefix": "api."
  659. },
  660. "idempotent": true
  661. }
  662. },
  663. "shapes": {
  664. "S2": {
  665. "type": "string",
  666. "sensitive": true
  667. },
  668. "S4": {
  669. "type": "string",
  670. "sensitive": true
  671. },
  672. "S6": {
  673. "type": "structure",
  674. "members": {
  675. "type": {},
  676. "startTimeHour": {
  677. "type": "integer"
  678. },
  679. "startTimeMinute": {
  680. "type": "integer"
  681. },
  682. "endTimeHour": {
  683. "type": "integer"
  684. },
  685. "endTimeMinute": {
  686. "type": "integer"
  687. },
  688. "daysOfTheWeek": {
  689. "type": "list",
  690. "member": {}
  691. },
  692. "applyTimeOf": {}
  693. }
  694. },
  695. "Sh": {
  696. "type": "map",
  697. "key": {},
  698. "value": {},
  699. "sensitive": true
  700. },
  701. "Sk": {
  702. "type": "structure",
  703. "members": {
  704. "id": {},
  705. "name": {
  706. "shape": "S2"
  707. },
  708. "desktopArn": {},
  709. "desktopEndpoint": {
  710. "shape": "S4"
  711. },
  712. "desktopType": {},
  713. "activationCode": {},
  714. "softwareSetUpdateSchedule": {},
  715. "maintenanceWindow": {
  716. "shape": "S6"
  717. },
  718. "softwareSetUpdateMode": {},
  719. "desiredSoftwareSetId": {},
  720. "pendingSoftwareSetId": {},
  721. "createdAt": {
  722. "type": "timestamp"
  723. },
  724. "updatedAt": {
  725. "type": "timestamp"
  726. },
  727. "arn": {}
  728. }
  729. },
  730. "S10": {
  731. "type": "string",
  732. "sensitive": true
  733. },
  734. "S1k": {
  735. "type": "structure",
  736. "members": {
  737. "id": {},
  738. "serialNumber": {},
  739. "name": {
  740. "shape": "S10"
  741. },
  742. "model": {},
  743. "environmentId": {},
  744. "status": {},
  745. "currentSoftwareSetId": {},
  746. "desiredSoftwareSetId": {},
  747. "pendingSoftwareSetId": {},
  748. "softwareSetUpdateSchedule": {},
  749. "lastConnectedAt": {
  750. "type": "timestamp"
  751. },
  752. "lastPostureAt": {
  753. "type": "timestamp"
  754. },
  755. "createdAt": {
  756. "type": "timestamp"
  757. },
  758. "updatedAt": {
  759. "type": "timestamp"
  760. },
  761. "arn": {}
  762. }
  763. }
  764. }
  765. }