UNPKG

46.3 kBJSONView Raw
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 "ParentFolderId": {}
246 }
247 },
248 "output": {
249 "type": "structure",
250 "members": {
251 "Metadata": {
252 "shape": "S1d"
253 }
254 }
255 }
256 },
257 "CreateLabels": {
258 "http": {
259 "method": "PUT",
260 "requestUri": "/api/v1/resources/{ResourceId}/labels",
261 "responseCode": 200
262 },
263 "input": {
264 "type": "structure",
265 "required": [
266 "ResourceId",
267 "Labels"
268 ],
269 "members": {
270 "ResourceId": {
271 "location": "uri",
272 "locationName": "ResourceId"
273 },
274 "Labels": {
275 "shape": "S1g"
276 },
277 "AuthenticationToken": {
278 "shape": "S2",
279 "location": "header",
280 "locationName": "Authentication"
281 }
282 }
283 },
284 "output": {
285 "type": "structure",
286 "members": {}
287 }
288 },
289 "CreateNotificationSubscription": {
290 "http": {
291 "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
292 "responseCode": 200
293 },
294 "input": {
295 "type": "structure",
296 "required": [
297 "OrganizationId",
298 "Endpoint",
299 "Protocol",
300 "SubscriptionType"
301 ],
302 "members": {
303 "OrganizationId": {
304 "location": "uri",
305 "locationName": "OrganizationId"
306 },
307 "Endpoint": {},
308 "Protocol": {},
309 "SubscriptionType": {}
310 }
311 },
312 "output": {
313 "type": "structure",
314 "members": {
315 "Subscription": {
316 "shape": "S1p"
317 }
318 }
319 }
320 },
321 "CreateUser": {
322 "http": {
323 "requestUri": "/api/v1/users",
324 "responseCode": 201
325 },
326 "input": {
327 "type": "structure",
328 "required": [
329 "Username",
330 "GivenName",
331 "Surname",
332 "Password"
333 ],
334 "members": {
335 "OrganizationId": {},
336 "Username": {},
337 "EmailAddress": {},
338 "GivenName": {},
339 "Surname": {},
340 "Password": {
341 "type": "string",
342 "sensitive": true
343 },
344 "TimeZoneId": {},
345 "StorageRule": {
346 "shape": "Sj"
347 },
348 "AuthenticationToken": {
349 "shape": "S2",
350 "location": "header",
351 "locationName": "Authentication"
352 }
353 }
354 },
355 "output": {
356 "type": "structure",
357 "members": {
358 "User": {
359 "shape": "S8"
360 }
361 }
362 }
363 },
364 "DeactivateUser": {
365 "http": {
366 "method": "DELETE",
367 "requestUri": "/api/v1/users/{UserId}/activation",
368 "responseCode": 204
369 },
370 "input": {
371 "type": "structure",
372 "required": [
373 "UserId"
374 ],
375 "members": {
376 "UserId": {
377 "location": "uri",
378 "locationName": "UserId"
379 },
380 "AuthenticationToken": {
381 "shape": "S2",
382 "location": "header",
383 "locationName": "Authentication"
384 }
385 }
386 }
387 },
388 "DeleteComment": {
389 "http": {
390 "method": "DELETE",
391 "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}",
392 "responseCode": 204
393 },
394 "input": {
395 "type": "structure",
396 "required": [
397 "DocumentId",
398 "VersionId",
399 "CommentId"
400 ],
401 "members": {
402 "AuthenticationToken": {
403 "shape": "S2",
404 "location": "header",
405 "locationName": "Authentication"
406 },
407 "DocumentId": {
408 "location": "uri",
409 "locationName": "DocumentId"
410 },
411 "VersionId": {
412 "location": "uri",
413 "locationName": "VersionId"
414 },
415 "CommentId": {
416 "location": "uri",
417 "locationName": "CommentId"
418 }
419 }
420 }
421 },
422 "DeleteCustomMetadata": {
423 "http": {
424 "method": "DELETE",
425 "requestUri": "/api/v1/resources/{ResourceId}/customMetadata",
426 "responseCode": 200
427 },
428 "input": {
429 "type": "structure",
430 "required": [
431 "ResourceId"
432 ],
433 "members": {
434 "AuthenticationToken": {
435 "shape": "S2",
436 "location": "header",
437 "locationName": "Authentication"
438 },
439 "ResourceId": {
440 "location": "uri",
441 "locationName": "ResourceId"
442 },
443 "VersionId": {
444 "location": "querystring",
445 "locationName": "versionId"
446 },
447 "Keys": {
448 "location": "querystring",
449 "locationName": "keys",
450 "type": "list",
451 "member": {}
452 },
453 "DeleteAll": {
454 "location": "querystring",
455 "locationName": "deleteAll",
456 "type": "boolean"
457 }
458 }
459 },
460 "output": {
461 "type": "structure",
462 "members": {}
463 }
464 },
465 "DeleteDocument": {
466 "http": {
467 "method": "DELETE",
468 "requestUri": "/api/v1/documents/{DocumentId}",
469 "responseCode": 204
470 },
471 "input": {
472 "type": "structure",
473 "required": [
474 "DocumentId"
475 ],
476 "members": {
477 "AuthenticationToken": {
478 "shape": "S2",
479 "location": "header",
480 "locationName": "Authentication"
481 },
482 "DocumentId": {
483 "location": "uri",
484 "locationName": "DocumentId"
485 }
486 }
487 }
488 },
489 "DeleteFolder": {
490 "http": {
491 "method": "DELETE",
492 "requestUri": "/api/v1/folders/{FolderId}",
493 "responseCode": 204
494 },
495 "input": {
496 "type": "structure",
497 "required": [
498 "FolderId"
499 ],
500 "members": {
501 "AuthenticationToken": {
502 "shape": "S2",
503 "location": "header",
504 "locationName": "Authentication"
505 },
506 "FolderId": {
507 "location": "uri",
508 "locationName": "FolderId"
509 }
510 }
511 }
512 },
513 "DeleteFolderContents": {
514 "http": {
515 "method": "DELETE",
516 "requestUri": "/api/v1/folders/{FolderId}/contents",
517 "responseCode": 204
518 },
519 "input": {
520 "type": "structure",
521 "required": [
522 "FolderId"
523 ],
524 "members": {
525 "AuthenticationToken": {
526 "shape": "S2",
527 "location": "header",
528 "locationName": "Authentication"
529 },
530 "FolderId": {
531 "location": "uri",
532 "locationName": "FolderId"
533 }
534 }
535 }
536 },
537 "DeleteLabels": {
538 "http": {
539 "method": "DELETE",
540 "requestUri": "/api/v1/resources/{ResourceId}/labels",
541 "responseCode": 200
542 },
543 "input": {
544 "type": "structure",
545 "required": [
546 "ResourceId"
547 ],
548 "members": {
549 "ResourceId": {
550 "location": "uri",
551 "locationName": "ResourceId"
552 },
553 "AuthenticationToken": {
554 "shape": "S2",
555 "location": "header",
556 "locationName": "Authentication"
557 },
558 "Labels": {
559 "shape": "S1g",
560 "location": "querystring",
561 "locationName": "labels"
562 },
563 "DeleteAll": {
564 "location": "querystring",
565 "locationName": "deleteAll",
566 "type": "boolean"
567 }
568 }
569 },
570 "output": {
571 "type": "structure",
572 "members": {}
573 }
574 },
575 "DeleteNotificationSubscription": {
576 "http": {
577 "method": "DELETE",
578 "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}",
579 "responseCode": 200
580 },
581 "input": {
582 "type": "structure",
583 "required": [
584 "SubscriptionId",
585 "OrganizationId"
586 ],
587 "members": {
588 "SubscriptionId": {
589 "location": "uri",
590 "locationName": "SubscriptionId"
591 },
592 "OrganizationId": {
593 "location": "uri",
594 "locationName": "OrganizationId"
595 }
596 }
597 }
598 },
599 "DeleteUser": {
600 "http": {
601 "method": "DELETE",
602 "requestUri": "/api/v1/users/{UserId}",
603 "responseCode": 204
604 },
605 "input": {
606 "type": "structure",
607 "required": [
608 "UserId"
609 ],
610 "members": {
611 "AuthenticationToken": {
612 "shape": "S2",
613 "location": "header",
614 "locationName": "Authentication"
615 },
616 "UserId": {
617 "location": "uri",
618 "locationName": "UserId"
619 }
620 }
621 }
622 },
623 "DescribeActivities": {
624 "http": {
625 "method": "GET",
626 "requestUri": "/api/v1/activities",
627 "responseCode": 200
628 },
629 "input": {
630 "type": "structure",
631 "members": {
632 "AuthenticationToken": {
633 "shape": "S2",
634 "location": "header",
635 "locationName": "Authentication"
636 },
637 "StartTime": {
638 "location": "querystring",
639 "locationName": "startTime",
640 "type": "timestamp"
641 },
642 "EndTime": {
643 "location": "querystring",
644 "locationName": "endTime",
645 "type": "timestamp"
646 },
647 "OrganizationId": {
648 "location": "querystring",
649 "locationName": "organizationId"
650 },
651 "ActivityTypes": {
652 "location": "querystring",
653 "locationName": "activityTypes"
654 },
655 "ResourceId": {
656 "location": "querystring",
657 "locationName": "resourceId"
658 },
659 "UserId": {
660 "location": "querystring",
661 "locationName": "userId"
662 },
663 "IncludeIndirectActivities": {
664 "location": "querystring",
665 "locationName": "includeIndirectActivities",
666 "type": "boolean"
667 },
668 "Limit": {
669 "location": "querystring",
670 "locationName": "limit",
671 "type": "integer"
672 },
673 "Marker": {
674 "location": "querystring",
675 "locationName": "marker"
676 }
677 }
678 },
679 "output": {
680 "type": "structure",
681 "members": {
682 "UserActivities": {
683 "type": "list",
684 "member": {
685 "type": "structure",
686 "members": {
687 "Type": {},
688 "TimeStamp": {
689 "type": "timestamp"
690 },
691 "IsIndirectActivity": {
692 "type": "boolean"
693 },
694 "OrganizationId": {},
695 "Initiator": {
696 "shape": "S2d"
697 },
698 "Participants": {
699 "type": "structure",
700 "members": {
701 "Users": {
702 "type": "list",
703 "member": {
704 "shape": "S2d"
705 }
706 },
707 "Groups": {
708 "shape": "S2g"
709 }
710 }
711 },
712 "ResourceMetadata": {
713 "shape": "S2j"
714 },
715 "OriginalParent": {
716 "shape": "S2j"
717 },
718 "CommentMetadata": {
719 "type": "structure",
720 "members": {
721 "CommentId": {},
722 "Contributor": {
723 "shape": "S8"
724 },
725 "CreatedTimestamp": {
726 "type": "timestamp"
727 },
728 "CommentStatus": {},
729 "RecipientId": {}
730 }
731 }
732 }
733 }
734 },
735 "Marker": {}
736 }
737 }
738 },
739 "DescribeComments": {
740 "http": {
741 "method": "GET",
742 "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}/comments",
743 "responseCode": 200
744 },
745 "input": {
746 "type": "structure",
747 "required": [
748 "DocumentId",
749 "VersionId"
750 ],
751 "members": {
752 "AuthenticationToken": {
753 "shape": "S2",
754 "location": "header",
755 "locationName": "Authentication"
756 },
757 "DocumentId": {
758 "location": "uri",
759 "locationName": "DocumentId"
760 },
761 "VersionId": {
762 "location": "uri",
763 "locationName": "VersionId"
764 },
765 "Limit": {
766 "location": "querystring",
767 "locationName": "limit",
768 "type": "integer"
769 },
770 "Marker": {
771 "location": "querystring",
772 "locationName": "marker"
773 }
774 }
775 },
776 "output": {
777 "type": "structure",
778 "members": {
779 "Comments": {
780 "type": "list",
781 "member": {
782 "shape": "S13"
783 }
784 },
785 "Marker": {}
786 }
787 }
788 },
789 "DescribeDocumentVersions": {
790 "http": {
791 "method": "GET",
792 "requestUri": "/api/v1/documents/{DocumentId}/versions",
793 "responseCode": 200
794 },
795 "input": {
796 "type": "structure",
797 "required": [
798 "DocumentId"
799 ],
800 "members": {
801 "AuthenticationToken": {
802 "shape": "S2",
803 "location": "header",
804 "locationName": "Authentication"
805 },
806 "DocumentId": {
807 "location": "uri",
808 "locationName": "DocumentId"
809 },
810 "Marker": {
811 "location": "querystring",
812 "locationName": "marker"
813 },
814 "Limit": {
815 "location": "querystring",
816 "locationName": "limit",
817 "type": "integer"
818 },
819 "Include": {
820 "location": "querystring",
821 "locationName": "include"
822 },
823 "Fields": {
824 "location": "querystring",
825 "locationName": "fields"
826 }
827 }
828 },
829 "output": {
830 "type": "structure",
831 "members": {
832 "DocumentVersions": {
833 "type": "list",
834 "member": {
835 "shape": "S2u"
836 }
837 },
838 "Marker": {}
839 }
840 }
841 },
842 "DescribeFolderContents": {
843 "http": {
844 "method": "GET",
845 "requestUri": "/api/v1/folders/{FolderId}/contents",
846 "responseCode": 200
847 },
848 "input": {
849 "type": "structure",
850 "required": [
851 "FolderId"
852 ],
853 "members": {
854 "AuthenticationToken": {
855 "shape": "S2",
856 "location": "header",
857 "locationName": "Authentication"
858 },
859 "FolderId": {
860 "location": "uri",
861 "locationName": "FolderId"
862 },
863 "Sort": {
864 "location": "querystring",
865 "locationName": "sort"
866 },
867 "Order": {
868 "location": "querystring",
869 "locationName": "order"
870 },
871 "Limit": {
872 "location": "querystring",
873 "locationName": "limit",
874 "type": "integer"
875 },
876 "Marker": {
877 "location": "querystring",
878 "locationName": "marker"
879 },
880 "Type": {
881 "location": "querystring",
882 "locationName": "type"
883 },
884 "Include": {
885 "location": "querystring",
886 "locationName": "include"
887 }
888 }
889 },
890 "output": {
891 "type": "structure",
892 "members": {
893 "Folders": {
894 "shape": "S37"
895 },
896 "Documents": {
897 "shape": "S38"
898 },
899 "Marker": {}
900 }
901 }
902 },
903 "DescribeGroups": {
904 "http": {
905 "method": "GET",
906 "requestUri": "/api/v1/groups",
907 "responseCode": 200
908 },
909 "input": {
910 "type": "structure",
911 "required": [
912 "SearchQuery"
913 ],
914 "members": {
915 "AuthenticationToken": {
916 "shape": "S2",
917 "location": "header",
918 "locationName": "Authentication"
919 },
920 "SearchQuery": {
921 "shape": "S3b",
922 "location": "querystring",
923 "locationName": "searchQuery"
924 },
925 "OrganizationId": {
926 "location": "querystring",
927 "locationName": "organizationId"
928 },
929 "Marker": {
930 "location": "querystring",
931 "locationName": "marker"
932 },
933 "Limit": {
934 "location": "querystring",
935 "locationName": "limit",
936 "type": "integer"
937 }
938 }
939 },
940 "output": {
941 "type": "structure",
942 "members": {
943 "Groups": {
944 "shape": "S2g"
945 },
946 "Marker": {}
947 }
948 }
949 },
950 "DescribeNotificationSubscriptions": {
951 "http": {
952 "method": "GET",
953 "requestUri": "/api/v1/organizations/{OrganizationId}/subscriptions",
954 "responseCode": 200
955 },
956 "input": {
957 "type": "structure",
958 "required": [
959 "OrganizationId"
960 ],
961 "members": {
962 "OrganizationId": {
963 "location": "uri",
964 "locationName": "OrganizationId"
965 },
966 "Marker": {
967 "location": "querystring",
968 "locationName": "marker"
969 },
970 "Limit": {
971 "location": "querystring",
972 "locationName": "limit",
973 "type": "integer"
974 }
975 }
976 },
977 "output": {
978 "type": "structure",
979 "members": {
980 "Subscriptions": {
981 "type": "list",
982 "member": {
983 "shape": "S1p"
984 }
985 },
986 "Marker": {}
987 }
988 }
989 },
990 "DescribeResourcePermissions": {
991 "http": {
992 "method": "GET",
993 "requestUri": "/api/v1/resources/{ResourceId}/permissions",
994 "responseCode": 200
995 },
996 "input": {
997 "type": "structure",
998 "required": [
999 "ResourceId"
1000 ],
1001 "members": {
1002 "AuthenticationToken": {
1003 "shape": "S2",
1004 "location": "header",
1005 "locationName": "Authentication"
1006 },
1007 "ResourceId": {
1008 "location": "uri",
1009 "locationName": "ResourceId"
1010 },
1011 "PrincipalId": {
1012 "location": "querystring",
1013 "locationName": "principalId"
1014 },
1015 "Limit": {
1016 "location": "querystring",
1017 "locationName": "limit",
1018 "type": "integer"
1019 },
1020 "Marker": {
1021 "location": "querystring",
1022 "locationName": "marker"
1023 }
1024 }
1025 },
1026 "output": {
1027 "type": "structure",
1028 "members": {
1029 "Principals": {
1030 "type": "list",
1031 "member": {
1032 "type": "structure",
1033 "members": {
1034 "Id": {},
1035 "Type": {},
1036 "Roles": {
1037 "type": "list",
1038 "member": {
1039 "type": "structure",
1040 "members": {
1041 "Role": {},
1042 "Type": {}
1043 }
1044 }
1045 }
1046 }
1047 }
1048 },
1049 "Marker": {}
1050 }
1051 }
1052 },
1053 "DescribeRootFolders": {
1054 "http": {
1055 "method": "GET",
1056 "requestUri": "/api/v1/me/root",
1057 "responseCode": 200
1058 },
1059 "input": {
1060 "type": "structure",
1061 "required": [
1062 "AuthenticationToken"
1063 ],
1064 "members": {
1065 "AuthenticationToken": {
1066 "shape": "S2",
1067 "location": "header",
1068 "locationName": "Authentication"
1069 },
1070 "Limit": {
1071 "location": "querystring",
1072 "locationName": "limit",
1073 "type": "integer"
1074 },
1075 "Marker": {
1076 "location": "querystring",
1077 "locationName": "marker"
1078 }
1079 }
1080 },
1081 "output": {
1082 "type": "structure",
1083 "members": {
1084 "Folders": {
1085 "shape": "S37"
1086 },
1087 "Marker": {}
1088 }
1089 }
1090 },
1091 "DescribeUsers": {
1092 "http": {
1093 "method": "GET",
1094 "requestUri": "/api/v1/users",
1095 "responseCode": 200
1096 },
1097 "input": {
1098 "type": "structure",
1099 "members": {
1100 "AuthenticationToken": {
1101 "shape": "S2",
1102 "location": "header",
1103 "locationName": "Authentication"
1104 },
1105 "OrganizationId": {
1106 "location": "querystring",
1107 "locationName": "organizationId"
1108 },
1109 "UserIds": {
1110 "location": "querystring",
1111 "locationName": "userIds"
1112 },
1113 "Query": {
1114 "shape": "S3b",
1115 "location": "querystring",
1116 "locationName": "query"
1117 },
1118 "Include": {
1119 "location": "querystring",
1120 "locationName": "include"
1121 },
1122 "Order": {
1123 "location": "querystring",
1124 "locationName": "order"
1125 },
1126 "Sort": {
1127 "location": "querystring",
1128 "locationName": "sort"
1129 },
1130 "Marker": {
1131 "location": "querystring",
1132 "locationName": "marker"
1133 },
1134 "Limit": {
1135 "location": "querystring",
1136 "locationName": "limit",
1137 "type": "integer"
1138 },
1139 "Fields": {
1140 "location": "querystring",
1141 "locationName": "fields"
1142 }
1143 }
1144 },
1145 "output": {
1146 "type": "structure",
1147 "members": {
1148 "Users": {
1149 "type": "list",
1150 "member": {
1151 "shape": "S8"
1152 }
1153 },
1154 "TotalNumberOfUsers": {
1155 "deprecated": true,
1156 "type": "long"
1157 },
1158 "Marker": {}
1159 }
1160 }
1161 },
1162 "GetCurrentUser": {
1163 "http": {
1164 "method": "GET",
1165 "requestUri": "/api/v1/me",
1166 "responseCode": 200
1167 },
1168 "input": {
1169 "type": "structure",
1170 "required": [
1171 "AuthenticationToken"
1172 ],
1173 "members": {
1174 "AuthenticationToken": {
1175 "shape": "S2",
1176 "location": "header",
1177 "locationName": "Authentication"
1178 }
1179 }
1180 },
1181 "output": {
1182 "type": "structure",
1183 "members": {
1184 "User": {
1185 "shape": "S8"
1186 }
1187 }
1188 }
1189 },
1190 "GetDocument": {
1191 "http": {
1192 "method": "GET",
1193 "requestUri": "/api/v1/documents/{DocumentId}",
1194 "responseCode": 200
1195 },
1196 "input": {
1197 "type": "structure",
1198 "required": [
1199 "DocumentId"
1200 ],
1201 "members": {
1202 "AuthenticationToken": {
1203 "shape": "S2",
1204 "location": "header",
1205 "locationName": "Authentication"
1206 },
1207 "DocumentId": {
1208 "location": "uri",
1209 "locationName": "DocumentId"
1210 },
1211 "IncludeCustomMetadata": {
1212 "location": "querystring",
1213 "locationName": "includeCustomMetadata",
1214 "type": "boolean"
1215 }
1216 }
1217 },
1218 "output": {
1219 "type": "structure",
1220 "members": {
1221 "Metadata": {
1222 "shape": "S39"
1223 },
1224 "CustomMetadata": {
1225 "shape": "S16"
1226 }
1227 }
1228 }
1229 },
1230 "GetDocumentPath": {
1231 "http": {
1232 "method": "GET",
1233 "requestUri": "/api/v1/documents/{DocumentId}/path",
1234 "responseCode": 200
1235 },
1236 "input": {
1237 "type": "structure",
1238 "required": [
1239 "DocumentId"
1240 ],
1241 "members": {
1242 "AuthenticationToken": {
1243 "shape": "S2",
1244 "location": "header",
1245 "locationName": "Authentication"
1246 },
1247 "DocumentId": {
1248 "location": "uri",
1249 "locationName": "DocumentId"
1250 },
1251 "Limit": {
1252 "location": "querystring",
1253 "locationName": "limit",
1254 "type": "integer"
1255 },
1256 "Fields": {
1257 "location": "querystring",
1258 "locationName": "fields"
1259 },
1260 "Marker": {
1261 "location": "querystring",
1262 "locationName": "marker"
1263 }
1264 }
1265 },
1266 "output": {
1267 "type": "structure",
1268 "members": {
1269 "Path": {
1270 "shape": "S42"
1271 }
1272 }
1273 }
1274 },
1275 "GetDocumentVersion": {
1276 "http": {
1277 "method": "GET",
1278 "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
1279 "responseCode": 200
1280 },
1281 "input": {
1282 "type": "structure",
1283 "required": [
1284 "DocumentId",
1285 "VersionId"
1286 ],
1287 "members": {
1288 "AuthenticationToken": {
1289 "shape": "S2",
1290 "location": "header",
1291 "locationName": "Authentication"
1292 },
1293 "DocumentId": {
1294 "location": "uri",
1295 "locationName": "DocumentId"
1296 },
1297 "VersionId": {
1298 "location": "uri",
1299 "locationName": "VersionId"
1300 },
1301 "Fields": {
1302 "location": "querystring",
1303 "locationName": "fields"
1304 },
1305 "IncludeCustomMetadata": {
1306 "location": "querystring",
1307 "locationName": "includeCustomMetadata",
1308 "type": "boolean"
1309 }
1310 }
1311 },
1312 "output": {
1313 "type": "structure",
1314 "members": {
1315 "Metadata": {
1316 "shape": "S2u"
1317 },
1318 "CustomMetadata": {
1319 "shape": "S16"
1320 }
1321 }
1322 }
1323 },
1324 "GetFolder": {
1325 "http": {
1326 "method": "GET",
1327 "requestUri": "/api/v1/folders/{FolderId}",
1328 "responseCode": 200
1329 },
1330 "input": {
1331 "type": "structure",
1332 "required": [
1333 "FolderId"
1334 ],
1335 "members": {
1336 "AuthenticationToken": {
1337 "shape": "S2",
1338 "location": "header",
1339 "locationName": "Authentication"
1340 },
1341 "FolderId": {
1342 "location": "uri",
1343 "locationName": "FolderId"
1344 },
1345 "IncludeCustomMetadata": {
1346 "location": "querystring",
1347 "locationName": "includeCustomMetadata",
1348 "type": "boolean"
1349 }
1350 }
1351 },
1352 "output": {
1353 "type": "structure",
1354 "members": {
1355 "Metadata": {
1356 "shape": "S1d"
1357 },
1358 "CustomMetadata": {
1359 "shape": "S16"
1360 }
1361 }
1362 }
1363 },
1364 "GetFolderPath": {
1365 "http": {
1366 "method": "GET",
1367 "requestUri": "/api/v1/folders/{FolderId}/path",
1368 "responseCode": 200
1369 },
1370 "input": {
1371 "type": "structure",
1372 "required": [
1373 "FolderId"
1374 ],
1375 "members": {
1376 "AuthenticationToken": {
1377 "shape": "S2",
1378 "location": "header",
1379 "locationName": "Authentication"
1380 },
1381 "FolderId": {
1382 "location": "uri",
1383 "locationName": "FolderId"
1384 },
1385 "Limit": {
1386 "location": "querystring",
1387 "locationName": "limit",
1388 "type": "integer"
1389 },
1390 "Fields": {
1391 "location": "querystring",
1392 "locationName": "fields"
1393 },
1394 "Marker": {
1395 "location": "querystring",
1396 "locationName": "marker"
1397 }
1398 }
1399 },
1400 "output": {
1401 "type": "structure",
1402 "members": {
1403 "Path": {
1404 "shape": "S42"
1405 }
1406 }
1407 }
1408 },
1409 "GetResources": {
1410 "http": {
1411 "method": "GET",
1412 "requestUri": "/api/v1/resources",
1413 "responseCode": 200
1414 },
1415 "input": {
1416 "type": "structure",
1417 "members": {
1418 "AuthenticationToken": {
1419 "shape": "S2",
1420 "location": "header",
1421 "locationName": "Authentication"
1422 },
1423 "UserId": {
1424 "location": "querystring",
1425 "locationName": "userId"
1426 },
1427 "CollectionType": {
1428 "location": "querystring",
1429 "locationName": "collectionType"
1430 },
1431 "Limit": {
1432 "location": "querystring",
1433 "locationName": "limit",
1434 "type": "integer"
1435 },
1436 "Marker": {
1437 "location": "querystring",
1438 "locationName": "marker"
1439 }
1440 }
1441 },
1442 "output": {
1443 "type": "structure",
1444 "members": {
1445 "Folders": {
1446 "shape": "S37"
1447 },
1448 "Documents": {
1449 "shape": "S38"
1450 },
1451 "Marker": {}
1452 }
1453 }
1454 },
1455 "InitiateDocumentVersionUpload": {
1456 "http": {
1457 "requestUri": "/api/v1/documents",
1458 "responseCode": 201
1459 },
1460 "input": {
1461 "type": "structure",
1462 "required": [
1463 "ParentFolderId"
1464 ],
1465 "members": {
1466 "AuthenticationToken": {
1467 "shape": "S2",
1468 "location": "header",
1469 "locationName": "Authentication"
1470 },
1471 "Id": {},
1472 "Name": {},
1473 "ContentCreatedTimestamp": {
1474 "type": "timestamp"
1475 },
1476 "ContentModifiedTimestamp": {
1477 "type": "timestamp"
1478 },
1479 "ContentType": {},
1480 "DocumentSizeInBytes": {
1481 "type": "long"
1482 },
1483 "ParentFolderId": {}
1484 }
1485 },
1486 "output": {
1487 "type": "structure",
1488 "members": {
1489 "Metadata": {
1490 "shape": "S39"
1491 },
1492 "UploadMetadata": {
1493 "type": "structure",
1494 "members": {
1495 "UploadUrl": {
1496 "shape": "S2z"
1497 },
1498 "SignedHeaders": {
1499 "type": "map",
1500 "key": {},
1501 "value": {}
1502 }
1503 }
1504 }
1505 }
1506 }
1507 },
1508 "RemoveAllResourcePermissions": {
1509 "http": {
1510 "method": "DELETE",
1511 "requestUri": "/api/v1/resources/{ResourceId}/permissions",
1512 "responseCode": 204
1513 },
1514 "input": {
1515 "type": "structure",
1516 "required": [
1517 "ResourceId"
1518 ],
1519 "members": {
1520 "AuthenticationToken": {
1521 "shape": "S2",
1522 "location": "header",
1523 "locationName": "Authentication"
1524 },
1525 "ResourceId": {
1526 "location": "uri",
1527 "locationName": "ResourceId"
1528 }
1529 }
1530 }
1531 },
1532 "RemoveResourcePermission": {
1533 "http": {
1534 "method": "DELETE",
1535 "requestUri": "/api/v1/resources/{ResourceId}/permissions/{PrincipalId}",
1536 "responseCode": 204
1537 },
1538 "input": {
1539 "type": "structure",
1540 "required": [
1541 "ResourceId",
1542 "PrincipalId"
1543 ],
1544 "members": {
1545 "AuthenticationToken": {
1546 "shape": "S2",
1547 "location": "header",
1548 "locationName": "Authentication"
1549 },
1550 "ResourceId": {
1551 "location": "uri",
1552 "locationName": "ResourceId"
1553 },
1554 "PrincipalId": {
1555 "location": "uri",
1556 "locationName": "PrincipalId"
1557 },
1558 "PrincipalType": {
1559 "location": "querystring",
1560 "locationName": "type"
1561 }
1562 }
1563 }
1564 },
1565 "UpdateDocument": {
1566 "http": {
1567 "method": "PATCH",
1568 "requestUri": "/api/v1/documents/{DocumentId}",
1569 "responseCode": 200
1570 },
1571 "input": {
1572 "type": "structure",
1573 "required": [
1574 "DocumentId"
1575 ],
1576 "members": {
1577 "AuthenticationToken": {
1578 "shape": "S2",
1579 "location": "header",
1580 "locationName": "Authentication"
1581 },
1582 "DocumentId": {
1583 "location": "uri",
1584 "locationName": "DocumentId"
1585 },
1586 "Name": {},
1587 "ParentFolderId": {},
1588 "ResourceState": {}
1589 }
1590 }
1591 },
1592 "UpdateDocumentVersion": {
1593 "http": {
1594 "method": "PATCH",
1595 "requestUri": "/api/v1/documents/{DocumentId}/versions/{VersionId}",
1596 "responseCode": 200
1597 },
1598 "input": {
1599 "type": "structure",
1600 "required": [
1601 "DocumentId",
1602 "VersionId"
1603 ],
1604 "members": {
1605 "AuthenticationToken": {
1606 "shape": "S2",
1607 "location": "header",
1608 "locationName": "Authentication"
1609 },
1610 "DocumentId": {
1611 "location": "uri",
1612 "locationName": "DocumentId"
1613 },
1614 "VersionId": {
1615 "location": "uri",
1616 "locationName": "VersionId"
1617 },
1618 "VersionStatus": {}
1619 }
1620 }
1621 },
1622 "UpdateFolder": {
1623 "http": {
1624 "method": "PATCH",
1625 "requestUri": "/api/v1/folders/{FolderId}",
1626 "responseCode": 200
1627 },
1628 "input": {
1629 "type": "structure",
1630 "required": [
1631 "FolderId"
1632 ],
1633 "members": {
1634 "AuthenticationToken": {
1635 "shape": "S2",
1636 "location": "header",
1637 "locationName": "Authentication"
1638 },
1639 "FolderId": {
1640 "location": "uri",
1641 "locationName": "FolderId"
1642 },
1643 "Name": {},
1644 "ParentFolderId": {},
1645 "ResourceState": {}
1646 }
1647 }
1648 },
1649 "UpdateUser": {
1650 "http": {
1651 "method": "PATCH",
1652 "requestUri": "/api/v1/users/{UserId}",
1653 "responseCode": 200
1654 },
1655 "input": {
1656 "type": "structure",
1657 "required": [
1658 "UserId"
1659 ],
1660 "members": {
1661 "AuthenticationToken": {
1662 "shape": "S2",
1663 "location": "header",
1664 "locationName": "Authentication"
1665 },
1666 "UserId": {
1667 "location": "uri",
1668 "locationName": "UserId"
1669 },
1670 "GivenName": {},
1671 "Surname": {},
1672 "Type": {},
1673 "StorageRule": {
1674 "shape": "Sj"
1675 },
1676 "TimeZoneId": {},
1677 "Locale": {},
1678 "GrantPoweruserPrivileges": {}
1679 }
1680 },
1681 "output": {
1682 "type": "structure",
1683 "members": {
1684 "User": {
1685 "shape": "S8"
1686 }
1687 }
1688 }
1689 }
1690 },
1691 "shapes": {
1692 "S2": {
1693 "type": "string",
1694 "sensitive": true
1695 },
1696 "S8": {
1697 "type": "structure",
1698 "members": {
1699 "Id": {},
1700 "Username": {},
1701 "EmailAddress": {},
1702 "GivenName": {},
1703 "Surname": {},
1704 "OrganizationId": {},
1705 "RootFolderId": {},
1706 "RecycleBinFolderId": {},
1707 "Status": {},
1708 "Type": {},
1709 "CreatedTimestamp": {
1710 "type": "timestamp"
1711 },
1712 "ModifiedTimestamp": {
1713 "type": "timestamp"
1714 },
1715 "TimeZoneId": {},
1716 "Locale": {},
1717 "Storage": {
1718 "type": "structure",
1719 "members": {
1720 "StorageUtilizedInBytes": {
1721 "type": "long"
1722 },
1723 "StorageRule": {
1724 "shape": "Sj"
1725 }
1726 }
1727 }
1728 }
1729 },
1730 "Sj": {
1731 "type": "structure",
1732 "members": {
1733 "StorageAllocatedInBytes": {
1734 "type": "long"
1735 },
1736 "StorageType": {}
1737 }
1738 },
1739 "St": {
1740 "type": "string",
1741 "sensitive": true
1742 },
1743 "S10": {
1744 "type": "string",
1745 "sensitive": true
1746 },
1747 "S13": {
1748 "type": "structure",
1749 "required": [
1750 "CommentId"
1751 ],
1752 "members": {
1753 "CommentId": {},
1754 "ParentId": {},
1755 "ThreadId": {},
1756 "Text": {
1757 "shape": "S10"
1758 },
1759 "Contributor": {
1760 "shape": "S8"
1761 },
1762 "CreatedTimestamp": {
1763 "type": "timestamp"
1764 },
1765 "Status": {},
1766 "Visibility": {},
1767 "RecipientId": {}
1768 }
1769 },
1770 "S16": {
1771 "type": "map",
1772 "key": {},
1773 "value": {}
1774 },
1775 "S1d": {
1776 "type": "structure",
1777 "members": {
1778 "Id": {},
1779 "Name": {},
1780 "CreatorId": {},
1781 "ParentFolderId": {},
1782 "CreatedTimestamp": {
1783 "type": "timestamp"
1784 },
1785 "ModifiedTimestamp": {
1786 "type": "timestamp"
1787 },
1788 "ResourceState": {},
1789 "Signature": {},
1790 "Labels": {
1791 "shape": "S1g"
1792 },
1793 "Size": {
1794 "type": "long"
1795 },
1796 "LatestVersionSize": {
1797 "type": "long"
1798 }
1799 }
1800 },
1801 "S1g": {
1802 "type": "list",
1803 "member": {}
1804 },
1805 "S1p": {
1806 "type": "structure",
1807 "members": {
1808 "SubscriptionId": {},
1809 "EndPoint": {},
1810 "Protocol": {}
1811 }
1812 },
1813 "S2d": {
1814 "type": "structure",
1815 "members": {
1816 "Id": {},
1817 "Username": {},
1818 "GivenName": {},
1819 "Surname": {},
1820 "EmailAddress": {}
1821 }
1822 },
1823 "S2g": {
1824 "type": "list",
1825 "member": {
1826 "type": "structure",
1827 "members": {
1828 "Id": {},
1829 "Name": {}
1830 }
1831 }
1832 },
1833 "S2j": {
1834 "type": "structure",
1835 "members": {
1836 "Type": {},
1837 "Name": {},
1838 "OriginalName": {},
1839 "Id": {},
1840 "VersionId": {},
1841 "Owner": {
1842 "shape": "S2d"
1843 },
1844 "ParentId": {}
1845 }
1846 },
1847 "S2u": {
1848 "type": "structure",
1849 "members": {
1850 "Id": {},
1851 "Name": {},
1852 "ContentType": {},
1853 "Size": {
1854 "type": "long"
1855 },
1856 "Signature": {},
1857 "Status": {},
1858 "CreatedTimestamp": {
1859 "type": "timestamp"
1860 },
1861 "ModifiedTimestamp": {
1862 "type": "timestamp"
1863 },
1864 "ContentCreatedTimestamp": {
1865 "type": "timestamp"
1866 },
1867 "ContentModifiedTimestamp": {
1868 "type": "timestamp"
1869 },
1870 "CreatorId": {},
1871 "Thumbnail": {
1872 "type": "map",
1873 "key": {},
1874 "value": {
1875 "shape": "S2z"
1876 }
1877 },
1878 "Source": {
1879 "type": "map",
1880 "key": {},
1881 "value": {
1882 "shape": "S2z"
1883 }
1884 }
1885 }
1886 },
1887 "S2z": {
1888 "type": "string",
1889 "sensitive": true
1890 },
1891 "S37": {
1892 "type": "list",
1893 "member": {
1894 "shape": "S1d"
1895 }
1896 },
1897 "S38": {
1898 "type": "list",
1899 "member": {
1900 "shape": "S39"
1901 }
1902 },
1903 "S39": {
1904 "type": "structure",
1905 "members": {
1906 "Id": {},
1907 "CreatorId": {},
1908 "ParentFolderId": {},
1909 "CreatedTimestamp": {
1910 "type": "timestamp"
1911 },
1912 "ModifiedTimestamp": {
1913 "type": "timestamp"
1914 },
1915 "LatestVersionMetadata": {
1916 "shape": "S2u"
1917 },
1918 "ResourceState": {},
1919 "Labels": {
1920 "shape": "S1g"
1921 }
1922 }
1923 },
1924 "S3b": {
1925 "type": "string",
1926 "sensitive": true
1927 },
1928 "S42": {
1929 "type": "structure",
1930 "members": {
1931 "Components": {
1932 "type": "list",
1933 "member": {
1934 "type": "structure",
1935 "members": {
1936 "Id": {},
1937 "Name": {}
1938 }
1939 }
1940 }
1941 }
1942 }
1943 }
1944}
\No newline at end of file