workdocs-2016-05-01.min.json 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2016-05-01",
  5. "endpointPrefix": "workdocs",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceFullName": "Amazon WorkDocs",
  9. "serviceId": "WorkDocs",
  10. "signatureVersion": "v4",
  11. "uid": "workdocs-2016-05-01"
  12. },
  13. "operations": {
  14. "AbortDocumentVersionUpload": {
  15. "http": {
  16. "method": "DELETE",
  17. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
  18. "responseCode": 204
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "DocumentId",
  24. "VersionId"
  25. ],
  26. "members": {
  27. "AuthenticationToken": {
  28. "shape": "S2",
  29. "location": "header",
  30. "locationName": "Authentication"
  31. },
  32. "DocumentId": {
  33. "location": "uri",
  34. "locationName": "DocumentId"
  35. },
  36. "VersionId": {
  37. "location": "uri",
  38. "locationName": "VersionId"
  39. }
  40. }
  41. }
  42. },
  43. "ActivateUser": {
  44. "http": {
  45. "requestUri": "/api/v1/users/{UserId}/activation",
  46. "responseCode": 200
  47. },
  48. "input": {
  49. "type": "structure",
  50. "required": [
  51. "UserId"
  52. ],
  53. "members": {
  54. "UserId": {
  55. "location": "uri",
  56. "locationName": "UserId"
  57. },
  58. "AuthenticationToken": {
  59. "shape": "S2",
  60. "location": "header",
  61. "locationName": "Authentication"
  62. }
  63. }
  64. },
  65. "output": {
  66. "type": "structure",
  67. "members": {
  68. "User": {
  69. "shape": "S8"
  70. }
  71. }
  72. }
  73. },
  74. "AddResourcePermissions": {
  75. "http": {
  76. "requestUri": "/api/v1/resources/{ResourceId}/permissions",
  77. "responseCode": 201
  78. },
  79. "input": {
  80. "type": "structure",
  81. "required": [
  82. "ResourceId",
  83. "Principals"
  84. ],
  85. "members": {
  86. "AuthenticationToken": {
  87. "shape": "S2",
  88. "location": "header",
  89. "locationName": "Authentication"
  90. },
  91. "ResourceId": {
  92. "location": "uri",
  93. "locationName": "ResourceId"
  94. },
  95. "Principals": {
  96. "type": "list",
  97. "member": {
  98. "type": "structure",
  99. "required": [
  100. "Id",
  101. "Type",
  102. "Role"
  103. ],
  104. "members": {
  105. "Id": {},
  106. "Type": {},
  107. "Role": {}
  108. }
  109. }
  110. },
  111. "NotificationOptions": {
  112. "type": "structure",
  113. "members": {
  114. "SendEmail": {
  115. "type": "boolean"
  116. },
  117. "EmailMessage": {
  118. "shape": "St"
  119. }
  120. }
  121. }
  122. }
  123. },
  124. "output": {
  125. "type": "structure",
  126. "members": {
  127. "ShareResults": {
  128. "type": "list",
  129. "member": {
  130. "type": "structure",
  131. "members": {
  132. "PrincipalId": {},
  133. "InviteePrincipalId": {},
  134. "Role": {},
  135. "Status": {},
  136. "ShareId": {},
  137. "StatusMessage": {
  138. "shape": "St"
  139. }
  140. }
  141. }
  142. }
  143. }
  144. }
  145. },
  146. "CreateComment": {
  147. "http": {
  148. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment",
  149. "responseCode": 201
  150. },
  151. "input": {
  152. "type": "structure",
  153. "required": [
  154. "DocumentId",
  155. "VersionId",
  156. "Text"
  157. ],
  158. "members": {
  159. "AuthenticationToken": {
  160. "shape": "S2",
  161. "location": "header",
  162. "locationName": "Authentication"
  163. },
  164. "DocumentId": {
  165. "location": "uri",
  166. "locationName": "DocumentId"
  167. },
  168. "VersionId": {
  169. "location": "uri",
  170. "locationName": "VersionId"
  171. },
  172. "ParentId": {},
  173. "ThreadId": {},
  174. "Text": {
  175. "shape": "S10"
  176. },
  177. "Visibility": {},
  178. "NotifyCollaborators": {
  179. "type": "boolean"
  180. }
  181. }
  182. },
  183. "output": {
  184. "type": "structure",
  185. "members": {
  186. "Comment": {
  187. "shape": "S13"
  188. }
  189. }
  190. }
  191. },
  192. "CreateCustomMetadata": {
  193. "http": {
  194. "method": "PUT",
  195. "requestUri": "/api/v1/resources/{ResourceId}/customMetadata",
  196. "responseCode": 200
  197. },
  198. "input": {
  199. "type": "structure",
  200. "required": [
  201. "ResourceId",
  202. "CustomMetadata"
  203. ],
  204. "members": {
  205. "AuthenticationToken": {
  206. "shape": "S2",
  207. "location": "header",
  208. "locationName": "Authentication"
  209. },
  210. "ResourceId": {
  211. "location": "uri",
  212. "locationName": "ResourceId"
  213. },
  214. "VersionId": {
  215. "location": "querystring",
  216. "locationName": "versionid"
  217. },
  218. "CustomMetadata": {
  219. "shape": "S16"
  220. }
  221. }
  222. },
  223. "output": {
  224. "type": "structure",
  225. "members": {}
  226. }
  227. },
  228. "CreateFolder": {
  229. "http": {
  230. "requestUri": "/api/v1/folders",
  231. "responseCode": 201
  232. },
  233. "input": {
  234. "type": "structure",
  235. "required": [
  236. "ParentFolderId"
  237. ],
  238. "members": {
  239. "AuthenticationToken": {
  240. "shape": "S2",
  241. "location": "header",
  242. "locationName": "Authentication"
  243. },
  244. "Name": {
  245. "shape": "S1b"
  246. },
  247. "ParentFolderId": {}
  248. }
  249. },
  250. "output": {
  251. "type": "structure",
  252. "members": {
  253. "Metadata": {
  254. "shape": "S1d"
  255. }
  256. }
  257. }
  258. },
  259. "CreateLabels": {
  260. "http": {
  261. "method": "PUT",
  262. "requestUri": "/api/v1/resources/{ResourceId}/labels",
  263. "responseCode": 200
  264. },
  265. "input": {
  266. "type": "structure",
  267. "required": [
  268. "ResourceId",
  269. "Labels"
  270. ],
  271. "members": {
  272. "ResourceId": {
  273. "location": "uri",
  274. "locationName": "ResourceId"
  275. },
  276. "Labels": {
  277. "shape": "S1g"
  278. },
  279. "AuthenticationToken": {
  280. "shape": "S2",
  281. "location": "header",
  282. "locationName": "Authentication"
  283. }
  284. }
  285. },
  286. "output": {
  287. "type": "structure",
  288. "members": {}
  289. }
  290. },
  291. "CreateNotificationSubscription": {
  292. "http": {
  293. "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
  294. "responseCode": 200
  295. },
  296. "input": {
  297. "type": "structure",
  298. "required": [
  299. "OrganizationId",
  300. "Endpoint",
  301. "Protocol",
  302. "SubscriptionType"
  303. ],
  304. "members": {
  305. "OrganizationId": {
  306. "location": "uri",
  307. "locationName": "OrganizationId"
  308. },
  309. "Endpoint": {},
  310. "Protocol": {},
  311. "SubscriptionType": {}
  312. }
  313. },
  314. "output": {
  315. "type": "structure",
  316. "members": {
  317. "Subscription": {
  318. "shape": "S1p"
  319. }
  320. }
  321. }
  322. },
  323. "CreateUser": {
  324. "http": {
  325. "requestUri": "/api/v1/users",
  326. "responseCode": 201
  327. },
  328. "input": {
  329. "type": "structure",
  330. "required": [
  331. "Username",
  332. "GivenName",
  333. "Surname",
  334. "Password"
  335. ],
  336. "members": {
  337. "OrganizationId": {},
  338. "Username": {
  339. "shape": "S9"
  340. },
  341. "EmailAddress": {
  342. "shape": "Sa"
  343. },
  344. "GivenName": {
  345. "shape": "Sb"
  346. },
  347. "Surname": {
  348. "shape": "Sb"
  349. },
  350. "Password": {
  351. "type": "string",
  352. "sensitive": true
  353. },
  354. "TimeZoneId": {},
  355. "StorageRule": {
  356. "shape": "Sj"
  357. },
  358. "AuthenticationToken": {
  359. "shape": "S2",
  360. "location": "header",
  361. "locationName": "Authentication"
  362. }
  363. }
  364. },
  365. "output": {
  366. "type": "structure",
  367. "members": {
  368. "User": {
  369. "shape": "S8"
  370. }
  371. }
  372. }
  373. },
  374. "DeactivateUser": {
  375. "http": {
  376. "method": "DELETE",
  377. "requestUri": "/api/v1/users/{UserId}/activation",
  378. "responseCode": 204
  379. },
  380. "input": {
  381. "type": "structure",
  382. "required": [
  383. "UserId"
  384. ],
  385. "members": {
  386. "UserId": {
  387. "location": "uri",
  388. "locationName": "UserId"
  389. },
  390. "AuthenticationToken": {
  391. "shape": "S2",
  392. "location": "header",
  393. "locationName": "Authentication"
  394. }
  395. }
  396. }
  397. },
  398. "DeleteComment": {
  399. "http": {
  400. "method": "DELETE",
  401. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}",
  402. "responseCode": 204
  403. },
  404. "input": {
  405. "type": "structure",
  406. "required": [
  407. "DocumentId",
  408. "VersionId",
  409. "CommentId"
  410. ],
  411. "members": {
  412. "AuthenticationToken": {
  413. "shape": "S2",
  414. "location": "header",
  415. "locationName": "Authentication"
  416. },
  417. "DocumentId": {
  418. "location": "uri",
  419. "locationName": "DocumentId"
  420. },
  421. "VersionId": {
  422. "location": "uri",
  423. "locationName": "VersionId"
  424. },
  425. "CommentId": {
  426. "location": "uri",
  427. "locationName": "CommentId"
  428. }
  429. }
  430. }
  431. },
  432. "DeleteCustomMetadata": {
  433. "http": {
  434. "method": "DELETE",
  435. "requestUri": "/api/v1/resources/{ResourceId}/customMetadata",
  436. "responseCode": 200
  437. },
  438. "input": {
  439. "type": "structure",
  440. "required": [
  441. "ResourceId"
  442. ],
  443. "members": {
  444. "AuthenticationToken": {
  445. "shape": "S2",
  446. "location": "header",
  447. "locationName": "Authentication"
  448. },
  449. "ResourceId": {
  450. "location": "uri",
  451. "locationName": "ResourceId"
  452. },
  453. "VersionId": {
  454. "location": "querystring",
  455. "locationName": "versionId"
  456. },
  457. "Keys": {
  458. "location": "querystring",
  459. "locationName": "keys",
  460. "type": "list",
  461. "member": {}
  462. },
  463. "DeleteAll": {
  464. "location": "querystring",
  465. "locationName": "deleteAll",
  466. "type": "boolean"
  467. }
  468. }
  469. },
  470. "output": {
  471. "type": "structure",
  472. "members": {}
  473. }
  474. },
  475. "DeleteDocument": {
  476. "http": {
  477. "method": "DELETE",
  478. "requestUri": "/api/v1/documents/{DocumentId}",
  479. "responseCode": 204
  480. },
  481. "input": {
  482. "type": "structure",
  483. "required": [
  484. "DocumentId"
  485. ],
  486. "members": {
  487. "AuthenticationToken": {
  488. "shape": "S2",
  489. "location": "header",
  490. "locationName": "Authentication"
  491. },
  492. "DocumentId": {
  493. "location": "uri",
  494. "locationName": "DocumentId"
  495. }
  496. }
  497. }
  498. },
  499. "DeleteDocumentVersion": {
  500. "http": {
  501. "method": "DELETE",
  502. "requestUri": "/api/v1/documentVersions/{DocumentId}/versions/{VersionId}",
  503. "responseCode": 204
  504. },
  505. "input": {
  506. "type": "structure",
  507. "required": [
  508. "DocumentId",
  509. "VersionId",
  510. "DeletePriorVersions"
  511. ],
  512. "members": {
  513. "AuthenticationToken": {
  514. "shape": "S2",
  515. "location": "header",
  516. "locationName": "Authentication"
  517. },
  518. "DocumentId": {
  519. "location": "uri",
  520. "locationName": "DocumentId"
  521. },
  522. "VersionId": {
  523. "location": "uri",
  524. "locationName": "VersionId"
  525. },
  526. "DeletePriorVersions": {
  527. "location": "querystring",
  528. "locationName": "deletePriorVersions",
  529. "type": "boolean"
  530. }
  531. }
  532. }
  533. },
  534. "DeleteFolder": {
  535. "http": {
  536. "method": "DELETE",
  537. "requestUri": "/api/v1/folders/{FolderId}",
  538. "responseCode": 204
  539. },
  540. "input": {
  541. "type": "structure",
  542. "required": [
  543. "FolderId"
  544. ],
  545. "members": {
  546. "AuthenticationToken": {
  547. "shape": "S2",
  548. "location": "header",
  549. "locationName": "Authentication"
  550. },
  551. "FolderId": {
  552. "location": "uri",
  553. "locationName": "FolderId"
  554. }
  555. }
  556. }
  557. },
  558. "DeleteFolderContents": {
  559. "http": {
  560. "method": "DELETE",
  561. "requestUri": "/api/v1/folders/{FolderId}/contents",
  562. "responseCode": 204
  563. },
  564. "input": {
  565. "type": "structure",
  566. "required": [
  567. "FolderId"
  568. ],
  569. "members": {
  570. "AuthenticationToken": {
  571. "shape": "S2",
  572. "location": "header",
  573. "locationName": "Authentication"
  574. },
  575. "FolderId": {
  576. "location": "uri",
  577. "locationName": "FolderId"
  578. }
  579. }
  580. }
  581. },
  582. "DeleteLabels": {
  583. "http": {
  584. "method": "DELETE",
  585. "requestUri": "/api/v1/resources/{ResourceId}/labels",
  586. "responseCode": 200
  587. },
  588. "input": {
  589. "type": "structure",
  590. "required": [
  591. "ResourceId"
  592. ],
  593. "members": {
  594. "ResourceId": {
  595. "location": "uri",
  596. "locationName": "ResourceId"
  597. },
  598. "AuthenticationToken": {
  599. "shape": "S2",
  600. "location": "header",
  601. "locationName": "Authentication"
  602. },
  603. "Labels": {
  604. "shape": "S1g",
  605. "location": "querystring",
  606. "locationName": "labels"
  607. },
  608. "DeleteAll": {
  609. "location": "querystring",
  610. "locationName": "deleteAll",
  611. "type": "boolean"
  612. }
  613. }
  614. },
  615. "output": {
  616. "type": "structure",
  617. "members": {}
  618. }
  619. },
  620. "DeleteNotificationSubscription": {
  621. "http": {
  622. "method": "DELETE",
  623. "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}",
  624. "responseCode": 200
  625. },
  626. "input": {
  627. "type": "structure",
  628. "required": [
  629. "SubscriptionId",
  630. "OrganizationId"
  631. ],
  632. "members": {
  633. "SubscriptionId": {
  634. "location": "uri",
  635. "locationName": "SubscriptionId"
  636. },
  637. "OrganizationId": {
  638. "location": "uri",
  639. "locationName": "OrganizationId"
  640. }
  641. }
  642. }
  643. },
  644. "DeleteUser": {
  645. "http": {
  646. "method": "DELETE",
  647. "requestUri": "/api/v1/users/{UserId}",
  648. "responseCode": 204
  649. },
  650. "input": {
  651. "type": "structure",
  652. "required": [
  653. "UserId"
  654. ],
  655. "members": {
  656. "AuthenticationToken": {
  657. "shape": "S2",
  658. "location": "header",
  659. "locationName": "Authentication"
  660. },
  661. "UserId": {
  662. "location": "uri",
  663. "locationName": "UserId"
  664. }
  665. }
  666. }
  667. },
  668. "DescribeActivities": {
  669. "http": {
  670. "method": "GET",
  671. "requestUri": "/api/v1/activities",
  672. "responseCode": 200
  673. },
  674. "input": {
  675. "type": "structure",
  676. "members": {
  677. "AuthenticationToken": {
  678. "shape": "S2",
  679. "location": "header",
  680. "locationName": "Authentication"
  681. },
  682. "StartTime": {
  683. "location": "querystring",
  684. "locationName": "startTime",
  685. "type": "timestamp"
  686. },
  687. "EndTime": {
  688. "location": "querystring",
  689. "locationName": "endTime",
  690. "type": "timestamp"
  691. },
  692. "OrganizationId": {
  693. "location": "querystring",
  694. "locationName": "organizationId"
  695. },
  696. "ActivityTypes": {
  697. "location": "querystring",
  698. "locationName": "activityTypes"
  699. },
  700. "ResourceId": {
  701. "location": "querystring",
  702. "locationName": "resourceId"
  703. },
  704. "UserId": {
  705. "location": "querystring",
  706. "locationName": "userId"
  707. },
  708. "IncludeIndirectActivities": {
  709. "location": "querystring",
  710. "locationName": "includeIndirectActivities",
  711. "type": "boolean"
  712. },
  713. "Limit": {
  714. "location": "querystring",
  715. "locationName": "limit",
  716. "type": "integer"
  717. },
  718. "Marker": {
  719. "location": "querystring",
  720. "locationName": "marker"
  721. }
  722. }
  723. },
  724. "output": {
  725. "type": "structure",
  726. "members": {
  727. "UserActivities": {
  728. "type": "list",
  729. "member": {
  730. "type": "structure",
  731. "members": {
  732. "Type": {},
  733. "TimeStamp": {
  734. "type": "timestamp"
  735. },
  736. "IsIndirectActivity": {
  737. "type": "boolean"
  738. },
  739. "OrganizationId": {},
  740. "Initiator": {
  741. "shape": "S2e"
  742. },
  743. "Participants": {
  744. "type": "structure",
  745. "members": {
  746. "Users": {
  747. "type": "list",
  748. "member": {
  749. "shape": "S2e"
  750. }
  751. },
  752. "Groups": {
  753. "shape": "S2h"
  754. }
  755. }
  756. },
  757. "ResourceMetadata": {
  758. "shape": "S2k"
  759. },
  760. "OriginalParent": {
  761. "shape": "S2k"
  762. },
  763. "CommentMetadata": {
  764. "shape": "S2m"
  765. }
  766. }
  767. }
  768. },
  769. "Marker": {}
  770. }
  771. }
  772. },
  773. "DescribeComments": {
  774. "http": {
  775. "method": "GET",
  776. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",
  777. "responseCode": 200
  778. },
  779. "input": {
  780. "type": "structure",
  781. "required": [
  782. "DocumentId",
  783. "VersionId"
  784. ],
  785. "members": {
  786. "AuthenticationToken": {
  787. "shape": "S2",
  788. "location": "header",
  789. "locationName": "Authentication"
  790. },
  791. "DocumentId": {
  792. "location": "uri",
  793. "locationName": "DocumentId"
  794. },
  795. "VersionId": {
  796. "location": "uri",
  797. "locationName": "VersionId"
  798. },
  799. "Limit": {
  800. "location": "querystring",
  801. "locationName": "limit",
  802. "type": "integer"
  803. },
  804. "Marker": {
  805. "location": "querystring",
  806. "locationName": "marker"
  807. }
  808. }
  809. },
  810. "output": {
  811. "type": "structure",
  812. "members": {
  813. "Comments": {
  814. "type": "list",
  815. "member": {
  816. "shape": "S13"
  817. }
  818. },
  819. "Marker": {}
  820. }
  821. }
  822. },
  823. "DescribeDocumentVersions": {
  824. "http": {
  825. "method": "GET",
  826. "requestUri": "/api/v1/documents/{DocumentId}/versions",
  827. "responseCode": 200
  828. },
  829. "input": {
  830. "type": "structure",
  831. "required": [
  832. "DocumentId"
  833. ],
  834. "members": {
  835. "AuthenticationToken": {
  836. "shape": "S2",
  837. "location": "header",
  838. "locationName": "Authentication"
  839. },
  840. "DocumentId": {
  841. "location": "uri",
  842. "locationName": "DocumentId"
  843. },
  844. "Marker": {
  845. "location": "querystring",
  846. "locationName": "marker"
  847. },
  848. "Limit": {
  849. "location": "querystring",
  850. "locationName": "limit",
  851. "type": "integer"
  852. },
  853. "Include": {
  854. "location": "querystring",
  855. "locationName": "include"
  856. },
  857. "Fields": {
  858. "location": "querystring",
  859. "locationName": "fields"
  860. }
  861. }
  862. },
  863. "output": {
  864. "type": "structure",
  865. "members": {
  866. "DocumentVersions": {
  867. "type": "list",
  868. "member": {
  869. "shape": "S2w"
  870. }
  871. },
  872. "Marker": {}
  873. }
  874. }
  875. },
  876. "DescribeFolderContents": {
  877. "http": {
  878. "method": "GET",
  879. "requestUri": "/api/v1/folders/{FolderId}/contents",
  880. "responseCode": 200
  881. },
  882. "input": {
  883. "type": "structure",
  884. "required": [
  885. "FolderId"
  886. ],
  887. "members": {
  888. "AuthenticationToken": {
  889. "shape": "S2",
  890. "location": "header",
  891. "locationName": "Authentication"
  892. },
  893. "FolderId": {
  894. "location": "uri",
  895. "locationName": "FolderId"
  896. },
  897. "Sort": {
  898. "location": "querystring",
  899. "locationName": "sort"
  900. },
  901. "Order": {
  902. "location": "querystring",
  903. "locationName": "order"
  904. },
  905. "Limit": {
  906. "location": "querystring",
  907. "locationName": "limit",
  908. "type": "integer"
  909. },
  910. "Marker": {
  911. "location": "querystring",
  912. "locationName": "marker"
  913. },
  914. "Type": {
  915. "location": "querystring",
  916. "locationName": "type"
  917. },
  918. "Include": {
  919. "location": "querystring",
  920. "locationName": "include"
  921. }
  922. }
  923. },
  924. "output": {
  925. "type": "structure",
  926. "members": {
  927. "Folders": {
  928. "shape": "S39"
  929. },
  930. "Documents": {
  931. "shape": "S3a"
  932. },
  933. "Marker": {}
  934. }
  935. }
  936. },
  937. "DescribeGroups": {
  938. "http": {
  939. "method": "GET",
  940. "requestUri": "/api/v1/groups",
  941. "responseCode": 200
  942. },
  943. "input": {
  944. "type": "structure",
  945. "required": [
  946. "SearchQuery"
  947. ],
  948. "members": {
  949. "AuthenticationToken": {
  950. "shape": "S2",
  951. "location": "header",
  952. "locationName": "Authentication"
  953. },
  954. "SearchQuery": {
  955. "shape": "S3d",
  956. "location": "querystring",
  957. "locationName": "searchQuery"
  958. },
  959. "OrganizationId": {
  960. "location": "querystring",
  961. "locationName": "organizationId"
  962. },
  963. "Marker": {
  964. "location": "querystring",
  965. "locationName": "marker"
  966. },
  967. "Limit": {
  968. "location": "querystring",
  969. "locationName": "limit",
  970. "type": "integer"
  971. }
  972. }
  973. },
  974. "output": {
  975. "type": "structure",
  976. "members": {
  977. "Groups": {
  978. "shape": "S2h"
  979. },
  980. "Marker": {}
  981. }
  982. }
  983. },
  984. "DescribeNotificationSubscriptions": {
  985. "http": {
  986. "method": "GET",
  987. "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
  988. "responseCode": 200
  989. },
  990. "input": {
  991. "type": "structure",
  992. "required": [
  993. "OrganizationId"
  994. ],
  995. "members": {
  996. "OrganizationId": {
  997. "location": "uri",
  998. "locationName": "OrganizationId"
  999. },
  1000. "Marker": {
  1001. "location": "querystring",
  1002. "locationName": "marker"
  1003. },
  1004. "Limit": {
  1005. "location": "querystring",
  1006. "locationName": "limit",
  1007. "type": "integer"
  1008. }
  1009. }
  1010. },
  1011. "output": {
  1012. "type": "structure",
  1013. "members": {
  1014. "Subscriptions": {
  1015. "type": "list",
  1016. "member": {
  1017. "shape": "S1p"
  1018. }
  1019. },
  1020. "Marker": {}
  1021. }
  1022. }
  1023. },
  1024. "DescribeResourcePermissions": {
  1025. "http": {
  1026. "method": "GET",
  1027. "requestUri": "/api/v1/resources/{ResourceId}/permissions",
  1028. "responseCode": 200
  1029. },
  1030. "input": {
  1031. "type": "structure",
  1032. "required": [
  1033. "ResourceId"
  1034. ],
  1035. "members": {
  1036. "AuthenticationToken": {
  1037. "shape": "S2",
  1038. "location": "header",
  1039. "locationName": "Authentication"
  1040. },
  1041. "ResourceId": {
  1042. "location": "uri",
  1043. "locationName": "ResourceId"
  1044. },
  1045. "PrincipalId": {
  1046. "location": "querystring",
  1047. "locationName": "principalId"
  1048. },
  1049. "Limit": {
  1050. "location": "querystring",
  1051. "locationName": "limit",
  1052. "type": "integer"
  1053. },
  1054. "Marker": {
  1055. "location": "querystring",
  1056. "locationName": "marker"
  1057. }
  1058. }
  1059. },
  1060. "output": {
  1061. "type": "structure",
  1062. "members": {
  1063. "Principals": {
  1064. "type": "list",
  1065. "member": {
  1066. "type": "structure",
  1067. "members": {
  1068. "Id": {},
  1069. "Type": {},
  1070. "Roles": {
  1071. "type": "list",
  1072. "member": {
  1073. "type": "structure",
  1074. "members": {
  1075. "Role": {},
  1076. "Type": {}
  1077. }
  1078. }
  1079. }
  1080. }
  1081. }
  1082. },
  1083. "Marker": {}
  1084. }
  1085. }
  1086. },
  1087. "DescribeRootFolders": {
  1088. "http": {
  1089. "method": "GET",
  1090. "requestUri": "/api/v1/me/root",
  1091. "responseCode": 200
  1092. },
  1093. "input": {
  1094. "type": "structure",
  1095. "required": [
  1096. "AuthenticationToken"
  1097. ],
  1098. "members": {
  1099. "AuthenticationToken": {
  1100. "shape": "S2",
  1101. "location": "header",
  1102. "locationName": "Authentication"
  1103. },
  1104. "Limit": {
  1105. "location": "querystring",
  1106. "locationName": "limit",
  1107. "type": "integer"
  1108. },
  1109. "Marker": {
  1110. "location": "querystring",
  1111. "locationName": "marker"
  1112. }
  1113. }
  1114. },
  1115. "output": {
  1116. "type": "structure",
  1117. "members": {
  1118. "Folders": {
  1119. "shape": "S39"
  1120. },
  1121. "Marker": {}
  1122. }
  1123. }
  1124. },
  1125. "DescribeUsers": {
  1126. "http": {
  1127. "method": "GET",
  1128. "requestUri": "/api/v1/users",
  1129. "responseCode": 200
  1130. },
  1131. "input": {
  1132. "type": "structure",
  1133. "members": {
  1134. "AuthenticationToken": {
  1135. "shape": "S2",
  1136. "location": "header",
  1137. "locationName": "Authentication"
  1138. },
  1139. "OrganizationId": {
  1140. "location": "querystring",
  1141. "locationName": "organizationId"
  1142. },
  1143. "UserIds": {
  1144. "location": "querystring",
  1145. "locationName": "userIds"
  1146. },
  1147. "Query": {
  1148. "shape": "S3d",
  1149. "location": "querystring",
  1150. "locationName": "query"
  1151. },
  1152. "Include": {
  1153. "location": "querystring",
  1154. "locationName": "include"
  1155. },
  1156. "Order": {
  1157. "location": "querystring",
  1158. "locationName": "order"
  1159. },
  1160. "Sort": {
  1161. "location": "querystring",
  1162. "locationName": "sort"
  1163. },
  1164. "Marker": {
  1165. "location": "querystring",
  1166. "locationName": "marker"
  1167. },
  1168. "Limit": {
  1169. "location": "querystring",
  1170. "locationName": "limit",
  1171. "type": "integer"
  1172. },
  1173. "Fields": {
  1174. "location": "querystring",
  1175. "locationName": "fields"
  1176. }
  1177. }
  1178. },
  1179. "output": {
  1180. "type": "structure",
  1181. "members": {
  1182. "Users": {
  1183. "type": "list",
  1184. "member": {
  1185. "shape": "S8"
  1186. }
  1187. },
  1188. "TotalNumberOfUsers": {
  1189. "deprecated": true,
  1190. "type": "long"
  1191. },
  1192. "Marker": {}
  1193. }
  1194. }
  1195. },
  1196. "GetCurrentUser": {
  1197. "http": {
  1198. "method": "GET",
  1199. "requestUri": "/api/v1/me",
  1200. "responseCode": 200
  1201. },
  1202. "input": {
  1203. "type": "structure",
  1204. "required": [
  1205. "AuthenticationToken"
  1206. ],
  1207. "members": {
  1208. "AuthenticationToken": {
  1209. "shape": "S2",
  1210. "location": "header",
  1211. "locationName": "Authentication"
  1212. }
  1213. }
  1214. },
  1215. "output": {
  1216. "type": "structure",
  1217. "members": {
  1218. "User": {
  1219. "shape": "S8"
  1220. }
  1221. }
  1222. }
  1223. },
  1224. "GetDocument": {
  1225. "http": {
  1226. "method": "GET",
  1227. "requestUri": "/api/v1/documents/{DocumentId}",
  1228. "responseCode": 200
  1229. },
  1230. "input": {
  1231. "type": "structure",
  1232. "required": [
  1233. "DocumentId"
  1234. ],
  1235. "members": {
  1236. "AuthenticationToken": {
  1237. "shape": "S2",
  1238. "location": "header",
  1239. "locationName": "Authentication"
  1240. },
  1241. "DocumentId": {
  1242. "location": "uri",
  1243. "locationName": "DocumentId"
  1244. },
  1245. "IncludeCustomMetadata": {
  1246. "location": "querystring",
  1247. "locationName": "includeCustomMetadata",
  1248. "type": "boolean"
  1249. }
  1250. }
  1251. },
  1252. "output": {
  1253. "type": "structure",
  1254. "members": {
  1255. "Metadata": {
  1256. "shape": "S3b"
  1257. },
  1258. "CustomMetadata": {
  1259. "shape": "S16"
  1260. }
  1261. }
  1262. }
  1263. },
  1264. "GetDocumentPath": {
  1265. "http": {
  1266. "method": "GET",
  1267. "requestUri": "/api/v1/documents/{DocumentId}/path",
  1268. "responseCode": 200
  1269. },
  1270. "input": {
  1271. "type": "structure",
  1272. "required": [
  1273. "DocumentId"
  1274. ],
  1275. "members": {
  1276. "AuthenticationToken": {
  1277. "shape": "S2",
  1278. "location": "header",
  1279. "locationName": "Authentication"
  1280. },
  1281. "DocumentId": {
  1282. "location": "uri",
  1283. "locationName": "DocumentId"
  1284. },
  1285. "Limit": {
  1286. "location": "querystring",
  1287. "locationName": "limit",
  1288. "type": "integer"
  1289. },
  1290. "Fields": {
  1291. "location": "querystring",
  1292. "locationName": "fields"
  1293. },
  1294. "Marker": {
  1295. "location": "querystring",
  1296. "locationName": "marker"
  1297. }
  1298. }
  1299. },
  1300. "output": {
  1301. "type": "structure",
  1302. "members": {
  1303. "Path": {
  1304. "shape": "S44"
  1305. }
  1306. }
  1307. }
  1308. },
  1309. "GetDocumentVersion": {
  1310. "http": {
  1311. "method": "GET",
  1312. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
  1313. "responseCode": 200
  1314. },
  1315. "input": {
  1316. "type": "structure",
  1317. "required": [
  1318. "DocumentId",
  1319. "VersionId"
  1320. ],
  1321. "members": {
  1322. "AuthenticationToken": {
  1323. "shape": "S2",
  1324. "location": "header",
  1325. "locationName": "Authentication"
  1326. },
  1327. "DocumentId": {
  1328. "location": "uri",
  1329. "locationName": "DocumentId"
  1330. },
  1331. "VersionId": {
  1332. "location": "uri",
  1333. "locationName": "VersionId"
  1334. },
  1335. "Fields": {
  1336. "location": "querystring",
  1337. "locationName": "fields"
  1338. },
  1339. "IncludeCustomMetadata": {
  1340. "location": "querystring",
  1341. "locationName": "includeCustomMetadata",
  1342. "type": "boolean"
  1343. }
  1344. }
  1345. },
  1346. "output": {
  1347. "type": "structure",
  1348. "members": {
  1349. "Metadata": {
  1350. "shape": "S2w"
  1351. },
  1352. "CustomMetadata": {
  1353. "shape": "S16"
  1354. }
  1355. }
  1356. }
  1357. },
  1358. "GetFolder": {
  1359. "http": {
  1360. "method": "GET",
  1361. "requestUri": "/api/v1/folders/{FolderId}",
  1362. "responseCode": 200
  1363. },
  1364. "input": {
  1365. "type": "structure",
  1366. "required": [
  1367. "FolderId"
  1368. ],
  1369. "members": {
  1370. "AuthenticationToken": {
  1371. "shape": "S2",
  1372. "location": "header",
  1373. "locationName": "Authentication"
  1374. },
  1375. "FolderId": {
  1376. "location": "uri",
  1377. "locationName": "FolderId"
  1378. },
  1379. "IncludeCustomMetadata": {
  1380. "location": "querystring",
  1381. "locationName": "includeCustomMetadata",
  1382. "type": "boolean"
  1383. }
  1384. }
  1385. },
  1386. "output": {
  1387. "type": "structure",
  1388. "members": {
  1389. "Metadata": {
  1390. "shape": "S1d"
  1391. },
  1392. "CustomMetadata": {
  1393. "shape": "S16"
  1394. }
  1395. }
  1396. }
  1397. },
  1398. "GetFolderPath": {
  1399. "http": {
  1400. "method": "GET",
  1401. "requestUri": "/api/v1/folders/{FolderId}/path",
  1402. "responseCode": 200
  1403. },
  1404. "input": {
  1405. "type": "structure",
  1406. "required": [
  1407. "FolderId"
  1408. ],
  1409. "members": {
  1410. "AuthenticationToken": {
  1411. "shape": "S2",
  1412. "location": "header",
  1413. "locationName": "Authentication"
  1414. },
  1415. "FolderId": {
  1416. "location": "uri",
  1417. "locationName": "FolderId"
  1418. },
  1419. "Limit": {
  1420. "location": "querystring",
  1421. "locationName": "limit",
  1422. "type": "integer"
  1423. },
  1424. "Fields": {
  1425. "location": "querystring",
  1426. "locationName": "fields"
  1427. },
  1428. "Marker": {
  1429. "location": "querystring",
  1430. "locationName": "marker"
  1431. }
  1432. }
  1433. },
  1434. "output": {
  1435. "type": "structure",
  1436. "members": {
  1437. "Path": {
  1438. "shape": "S44"
  1439. }
  1440. }
  1441. }
  1442. },
  1443. "GetResources": {
  1444. "http": {
  1445. "method": "GET",
  1446. "requestUri": "/api/v1/resources",
  1447. "responseCode": 200
  1448. },
  1449. "input": {
  1450. "type": "structure",
  1451. "members": {
  1452. "AuthenticationToken": {
  1453. "shape": "S2",
  1454. "location": "header",
  1455. "locationName": "Authentication"
  1456. },
  1457. "UserId": {
  1458. "location": "querystring",
  1459. "locationName": "userId"
  1460. },
  1461. "CollectionType": {
  1462. "location": "querystring",
  1463. "locationName": "collectionType"
  1464. },
  1465. "Limit": {
  1466. "location": "querystring",
  1467. "locationName": "limit",
  1468. "type": "integer"
  1469. },
  1470. "Marker": {
  1471. "location": "querystring",
  1472. "locationName": "marker"
  1473. }
  1474. }
  1475. },
  1476. "output": {
  1477. "type": "structure",
  1478. "members": {
  1479. "Folders": {
  1480. "shape": "S39"
  1481. },
  1482. "Documents": {
  1483. "shape": "S3a"
  1484. },
  1485. "Marker": {}
  1486. }
  1487. }
  1488. },
  1489. "InitiateDocumentVersionUpload": {
  1490. "http": {
  1491. "requestUri": "/api/v1/documents",
  1492. "responseCode": 201
  1493. },
  1494. "input": {
  1495. "type": "structure",
  1496. "members": {
  1497. "AuthenticationToken": {
  1498. "shape": "S2",
  1499. "location": "header",
  1500. "locationName": "Authentication"
  1501. },
  1502. "Id": {},
  1503. "Name": {
  1504. "shape": "S1b"
  1505. },
  1506. "ContentCreatedTimestamp": {
  1507. "type": "timestamp"
  1508. },
  1509. "ContentModifiedTimestamp": {
  1510. "type": "timestamp"
  1511. },
  1512. "ContentType": {},
  1513. "DocumentSizeInBytes": {
  1514. "type": "long"
  1515. },
  1516. "ParentFolderId": {}
  1517. }
  1518. },
  1519. "output": {
  1520. "type": "structure",
  1521. "members": {
  1522. "Metadata": {
  1523. "shape": "S3b"
  1524. },
  1525. "UploadMetadata": {
  1526. "type": "structure",
  1527. "members": {
  1528. "UploadUrl": {
  1529. "shape": "S31"
  1530. },
  1531. "SignedHeaders": {
  1532. "type": "map",
  1533. "key": {},
  1534. "value": {}
  1535. }
  1536. }
  1537. }
  1538. }
  1539. }
  1540. },
  1541. "RemoveAllResourcePermissions": {
  1542. "http": {
  1543. "method": "DELETE",
  1544. "requestUri": "/api/v1/resources/{ResourceId}/permissions",
  1545. "responseCode": 204
  1546. },
  1547. "input": {
  1548. "type": "structure",
  1549. "required": [
  1550. "ResourceId"
  1551. ],
  1552. "members": {
  1553. "AuthenticationToken": {
  1554. "shape": "S2",
  1555. "location": "header",
  1556. "locationName": "Authentication"
  1557. },
  1558. "ResourceId": {
  1559. "location": "uri",
  1560. "locationName": "ResourceId"
  1561. }
  1562. }
  1563. }
  1564. },
  1565. "RemoveResourcePermission": {
  1566. "http": {
  1567. "method": "DELETE",
  1568. "requestUri": "/api/v1/resources/{ResourceId}/permissions/{PrincipalId}",
  1569. "responseCode": 204
  1570. },
  1571. "input": {
  1572. "type": "structure",
  1573. "required": [
  1574. "ResourceId",
  1575. "PrincipalId"
  1576. ],
  1577. "members": {
  1578. "AuthenticationToken": {
  1579. "shape": "S2",
  1580. "location": "header",
  1581. "locationName": "Authentication"
  1582. },
  1583. "ResourceId": {
  1584. "location": "uri",
  1585. "locationName": "ResourceId"
  1586. },
  1587. "PrincipalId": {
  1588. "location": "uri",
  1589. "locationName": "PrincipalId"
  1590. },
  1591. "PrincipalType": {
  1592. "location": "querystring",
  1593. "locationName": "type"
  1594. }
  1595. }
  1596. }
  1597. },
  1598. "RestoreDocumentVersions": {
  1599. "http": {
  1600. "requestUri": "/api/v1/documentVersions/restore/{DocumentId}",
  1601. "responseCode": 204
  1602. },
  1603. "input": {
  1604. "type": "structure",
  1605. "required": [
  1606. "DocumentId"
  1607. ],
  1608. "members": {
  1609. "AuthenticationToken": {
  1610. "shape": "S2",
  1611. "location": "header",
  1612. "locationName": "Authentication"
  1613. },
  1614. "DocumentId": {
  1615. "location": "uri",
  1616. "locationName": "DocumentId"
  1617. }
  1618. }
  1619. }
  1620. },
  1621. "SearchResources": {
  1622. "http": {
  1623. "requestUri": "/api/v1/search",
  1624. "responseCode": 200
  1625. },
  1626. "input": {
  1627. "type": "structure",
  1628. "members": {
  1629. "AuthenticationToken": {
  1630. "shape": "S2",
  1631. "location": "header",
  1632. "locationName": "Authentication"
  1633. },
  1634. "QueryText": {
  1635. "shape": "S3d"
  1636. },
  1637. "QueryScopes": {
  1638. "type": "list",
  1639. "member": {}
  1640. },
  1641. "OrganizationId": {},
  1642. "AdditionalResponseFields": {
  1643. "type": "list",
  1644. "member": {}
  1645. },
  1646. "Filters": {
  1647. "type": "structure",
  1648. "members": {
  1649. "TextLocales": {
  1650. "type": "list",
  1651. "member": {}
  1652. },
  1653. "ContentCategories": {
  1654. "type": "list",
  1655. "member": {}
  1656. },
  1657. "ResourceTypes": {
  1658. "type": "list",
  1659. "member": {}
  1660. },
  1661. "Labels": {
  1662. "type": "list",
  1663. "member": {}
  1664. },
  1665. "Principals": {
  1666. "type": "list",
  1667. "member": {
  1668. "type": "structure",
  1669. "required": [
  1670. "Id"
  1671. ],
  1672. "members": {
  1673. "Id": {},
  1674. "Roles": {
  1675. "type": "list",
  1676. "member": {}
  1677. }
  1678. }
  1679. }
  1680. },
  1681. "AncestorIds": {
  1682. "type": "list",
  1683. "member": {}
  1684. },
  1685. "SearchCollectionTypes": {
  1686. "type": "list",
  1687. "member": {}
  1688. },
  1689. "SizeRange": {
  1690. "type": "structure",
  1691. "members": {
  1692. "StartValue": {
  1693. "type": "long"
  1694. },
  1695. "EndValue": {
  1696. "type": "long"
  1697. }
  1698. }
  1699. },
  1700. "CreatedRange": {
  1701. "shape": "S5d"
  1702. },
  1703. "ModifiedRange": {
  1704. "shape": "S5d"
  1705. }
  1706. }
  1707. },
  1708. "OrderBy": {
  1709. "type": "list",
  1710. "member": {
  1711. "type": "structure",
  1712. "members": {
  1713. "Field": {},
  1714. "Order": {}
  1715. }
  1716. }
  1717. },
  1718. "Limit": {
  1719. "type": "integer"
  1720. },
  1721. "Marker": {}
  1722. }
  1723. },
  1724. "output": {
  1725. "type": "structure",
  1726. "members": {
  1727. "Items": {
  1728. "type": "list",
  1729. "member": {
  1730. "type": "structure",
  1731. "members": {
  1732. "ResourceType": {},
  1733. "WebUrl": {
  1734. "type": "string",
  1735. "sensitive": true
  1736. },
  1737. "DocumentMetadata": {
  1738. "shape": "S3b"
  1739. },
  1740. "FolderMetadata": {
  1741. "shape": "S1d"
  1742. },
  1743. "CommentMetadata": {
  1744. "shape": "S2m"
  1745. },
  1746. "DocumentVersionMetadata": {
  1747. "shape": "S2w"
  1748. }
  1749. }
  1750. }
  1751. },
  1752. "Marker": {}
  1753. }
  1754. }
  1755. },
  1756. "UpdateDocument": {
  1757. "http": {
  1758. "method": "PATCH",
  1759. "requestUri": "/api/v1/documents/{DocumentId}",
  1760. "responseCode": 200
  1761. },
  1762. "input": {
  1763. "type": "structure",
  1764. "required": [
  1765. "DocumentId"
  1766. ],
  1767. "members": {
  1768. "AuthenticationToken": {
  1769. "shape": "S2",
  1770. "location": "header",
  1771. "locationName": "Authentication"
  1772. },
  1773. "DocumentId": {
  1774. "location": "uri",
  1775. "locationName": "DocumentId"
  1776. },
  1777. "Name": {
  1778. "shape": "S1b"
  1779. },
  1780. "ParentFolderId": {},
  1781. "ResourceState": {}
  1782. }
  1783. }
  1784. },
  1785. "UpdateDocumentVersion": {
  1786. "http": {
  1787. "method": "PATCH",
  1788. "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
  1789. "responseCode": 200
  1790. },
  1791. "input": {
  1792. "type": "structure",
  1793. "required": [
  1794. "DocumentId",
  1795. "VersionId"
  1796. ],
  1797. "members": {
  1798. "AuthenticationToken": {
  1799. "shape": "S2",
  1800. "location": "header",
  1801. "locationName": "Authentication"
  1802. },
  1803. "DocumentId": {
  1804. "location": "uri",
  1805. "locationName": "DocumentId"
  1806. },
  1807. "VersionId": {
  1808. "location": "uri",
  1809. "locationName": "VersionId"
  1810. },
  1811. "VersionStatus": {}
  1812. }
  1813. }
  1814. },
  1815. "UpdateFolder": {
  1816. "http": {
  1817. "method": "PATCH",
  1818. "requestUri": "/api/v1/folders/{FolderId}",
  1819. "responseCode": 200
  1820. },
  1821. "input": {
  1822. "type": "structure",
  1823. "required": [
  1824. "FolderId"
  1825. ],
  1826. "members": {
  1827. "AuthenticationToken": {
  1828. "shape": "S2",
  1829. "location": "header",
  1830. "locationName": "Authentication"
  1831. },
  1832. "FolderId": {
  1833. "location": "uri",
  1834. "locationName": "FolderId"
  1835. },
  1836. "Name": {
  1837. "shape": "S1b"
  1838. },
  1839. "ParentFolderId": {},
  1840. "ResourceState": {}
  1841. }
  1842. }
  1843. },
  1844. "UpdateUser": {
  1845. "http": {
  1846. "method": "PATCH",
  1847. "requestUri": "/api/v1/users/{UserId}",
  1848. "responseCode": 200
  1849. },
  1850. "input": {
  1851. "type": "structure",
  1852. "required": [
  1853. "UserId"
  1854. ],
  1855. "members": {
  1856. "AuthenticationToken": {
  1857. "shape": "S2",
  1858. "location": "header",
  1859. "locationName": "Authentication"
  1860. },
  1861. "UserId": {
  1862. "location": "uri",
  1863. "locationName": "UserId"
  1864. },
  1865. "GivenName": {
  1866. "shape": "Sb"
  1867. },
  1868. "Surname": {
  1869. "shape": "Sb"
  1870. },
  1871. "Type": {},
  1872. "StorageRule": {
  1873. "shape": "Sj"
  1874. },
  1875. "TimeZoneId": {},
  1876. "Locale": {},
  1877. "GrantPoweruserPrivileges": {}
  1878. }
  1879. },
  1880. "output": {
  1881. "type": "structure",
  1882. "members": {
  1883. "User": {
  1884. "shape": "S8"
  1885. }
  1886. }
  1887. }
  1888. }
  1889. },
  1890. "shapes": {
  1891. "S2": {
  1892. "type": "string",
  1893. "sensitive": true
  1894. },
  1895. "S8": {
  1896. "type": "structure",
  1897. "members": {
  1898. "Id": {},
  1899. "Username": {
  1900. "shape": "S9"
  1901. },
  1902. "EmailAddress": {
  1903. "shape": "Sa"
  1904. },
  1905. "GivenName": {
  1906. "shape": "Sb"
  1907. },
  1908. "Surname": {
  1909. "shape": "Sb"
  1910. },
  1911. "OrganizationId": {},
  1912. "RootFolderId": {},
  1913. "RecycleBinFolderId": {},
  1914. "Status": {},
  1915. "Type": {},
  1916. "CreatedTimestamp": {
  1917. "type": "timestamp"
  1918. },
  1919. "ModifiedTimestamp": {
  1920. "type": "timestamp"
  1921. },
  1922. "TimeZoneId": {},
  1923. "Locale": {},
  1924. "Storage": {
  1925. "type": "structure",
  1926. "members": {
  1927. "StorageUtilizedInBytes": {
  1928. "type": "long"
  1929. },
  1930. "StorageRule": {
  1931. "shape": "Sj"
  1932. }
  1933. }
  1934. }
  1935. }
  1936. },
  1937. "S9": {
  1938. "type": "string",
  1939. "sensitive": true
  1940. },
  1941. "Sa": {
  1942. "type": "string",
  1943. "sensitive": true
  1944. },
  1945. "Sb": {
  1946. "type": "string",
  1947. "sensitive": true
  1948. },
  1949. "Sj": {
  1950. "type": "structure",
  1951. "members": {
  1952. "StorageAllocatedInBytes": {
  1953. "type": "long"
  1954. },
  1955. "StorageType": {}
  1956. }
  1957. },
  1958. "St": {
  1959. "type": "string",
  1960. "sensitive": true
  1961. },
  1962. "S10": {
  1963. "type": "string",
  1964. "sensitive": true
  1965. },
  1966. "S13": {
  1967. "type": "structure",
  1968. "required": [
  1969. "CommentId"
  1970. ],
  1971. "members": {
  1972. "CommentId": {},
  1973. "ParentId": {},
  1974. "ThreadId": {},
  1975. "Text": {
  1976. "shape": "S10"
  1977. },
  1978. "Contributor": {
  1979. "shape": "S8"
  1980. },
  1981. "CreatedTimestamp": {
  1982. "type": "timestamp"
  1983. },
  1984. "Status": {},
  1985. "Visibility": {},
  1986. "RecipientId": {}
  1987. }
  1988. },
  1989. "S16": {
  1990. "type": "map",
  1991. "key": {},
  1992. "value": {}
  1993. },
  1994. "S1b": {
  1995. "type": "string",
  1996. "sensitive": true
  1997. },
  1998. "S1d": {
  1999. "type": "structure",
  2000. "members": {
  2001. "Id": {},
  2002. "Name": {
  2003. "shape": "S1b"
  2004. },
  2005. "CreatorId": {},
  2006. "ParentFolderId": {},
  2007. "CreatedTimestamp": {
  2008. "type": "timestamp"
  2009. },
  2010. "ModifiedTimestamp": {
  2011. "type": "timestamp"
  2012. },
  2013. "ResourceState": {},
  2014. "Signature": {},
  2015. "Labels": {
  2016. "shape": "S1g"
  2017. },
  2018. "Size": {
  2019. "type": "long"
  2020. },
  2021. "LatestVersionSize": {
  2022. "type": "long"
  2023. }
  2024. }
  2025. },
  2026. "S1g": {
  2027. "type": "list",
  2028. "member": {}
  2029. },
  2030. "S1p": {
  2031. "type": "structure",
  2032. "members": {
  2033. "SubscriptionId": {},
  2034. "EndPoint": {},
  2035. "Protocol": {}
  2036. }
  2037. },
  2038. "S2e": {
  2039. "type": "structure",
  2040. "members": {
  2041. "Id": {},
  2042. "Username": {
  2043. "shape": "S9"
  2044. },
  2045. "GivenName": {
  2046. "shape": "Sb"
  2047. },
  2048. "Surname": {
  2049. "shape": "Sb"
  2050. },
  2051. "EmailAddress": {
  2052. "shape": "Sa"
  2053. }
  2054. }
  2055. },
  2056. "S2h": {
  2057. "type": "list",
  2058. "member": {
  2059. "type": "structure",
  2060. "members": {
  2061. "Id": {},
  2062. "Name": {}
  2063. }
  2064. }
  2065. },
  2066. "S2k": {
  2067. "type": "structure",
  2068. "members": {
  2069. "Type": {},
  2070. "Name": {
  2071. "shape": "S1b"
  2072. },
  2073. "OriginalName": {
  2074. "shape": "S1b"
  2075. },
  2076. "Id": {},
  2077. "VersionId": {},
  2078. "Owner": {
  2079. "shape": "S2e"
  2080. },
  2081. "ParentId": {}
  2082. }
  2083. },
  2084. "S2m": {
  2085. "type": "structure",
  2086. "members": {
  2087. "CommentId": {},
  2088. "Contributor": {
  2089. "shape": "S8"
  2090. },
  2091. "CreatedTimestamp": {
  2092. "type": "timestamp"
  2093. },
  2094. "CommentStatus": {},
  2095. "RecipientId": {},
  2096. "ContributorId": {}
  2097. }
  2098. },
  2099. "S2w": {
  2100. "type": "structure",
  2101. "members": {
  2102. "Id": {},
  2103. "Name": {
  2104. "shape": "S1b"
  2105. },
  2106. "ContentType": {},
  2107. "Size": {
  2108. "type": "long"
  2109. },
  2110. "Signature": {},
  2111. "Status": {},
  2112. "CreatedTimestamp": {
  2113. "type": "timestamp"
  2114. },
  2115. "ModifiedTimestamp": {
  2116. "type": "timestamp"
  2117. },
  2118. "ContentCreatedTimestamp": {
  2119. "type": "timestamp"
  2120. },
  2121. "ContentModifiedTimestamp": {
  2122. "type": "timestamp"
  2123. },
  2124. "CreatorId": {},
  2125. "Thumbnail": {
  2126. "type": "map",
  2127. "key": {},
  2128. "value": {
  2129. "shape": "S31"
  2130. }
  2131. },
  2132. "Source": {
  2133. "type": "map",
  2134. "key": {},
  2135. "value": {
  2136. "shape": "S31"
  2137. }
  2138. }
  2139. }
  2140. },
  2141. "S31": {
  2142. "type": "string",
  2143. "sensitive": true
  2144. },
  2145. "S39": {
  2146. "type": "list",
  2147. "member": {
  2148. "shape": "S1d"
  2149. }
  2150. },
  2151. "S3a": {
  2152. "type": "list",
  2153. "member": {
  2154. "shape": "S3b"
  2155. }
  2156. },
  2157. "S3b": {
  2158. "type": "structure",
  2159. "members": {
  2160. "Id": {},
  2161. "CreatorId": {},
  2162. "ParentFolderId": {},
  2163. "CreatedTimestamp": {
  2164. "type": "timestamp"
  2165. },
  2166. "ModifiedTimestamp": {
  2167. "type": "timestamp"
  2168. },
  2169. "LatestVersionMetadata": {
  2170. "shape": "S2w"
  2171. },
  2172. "ResourceState": {},
  2173. "Labels": {
  2174. "shape": "S1g"
  2175. }
  2176. }
  2177. },
  2178. "S3d": {
  2179. "type": "string",
  2180. "sensitive": true
  2181. },
  2182. "S44": {
  2183. "type": "structure",
  2184. "members": {
  2185. "Components": {
  2186. "type": "list",
  2187. "member": {
  2188. "type": "structure",
  2189. "members": {
  2190. "Id": {},
  2191. "Name": {
  2192. "shape": "S1b"
  2193. }
  2194. }
  2195. }
  2196. }
  2197. }
  2198. },
  2199. "S5d": {
  2200. "type": "structure",
  2201. "members": {
  2202. "StartValue": {
  2203. "type": "timestamp"
  2204. },
  2205. "EndValue": {
  2206. "type": "timestamp"
  2207. }
  2208. }
  2209. }
  2210. }
  2211. }