UNPKG

23.5 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2017-10-01",
5 "endpointPrefix": "workmail",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceFullName": "Amazon WorkMail",
9 "serviceId": "WorkMail",
10 "signatureVersion": "v4",
11 "targetPrefix": "WorkMailService",
12 "uid": "workmail-2017-10-01"
13 },
14 "operations": {
15 "AssociateDelegateToResource": {
16 "input": {
17 "type": "structure",
18 "required": [
19 "OrganizationId",
20 "ResourceId",
21 "EntityId"
22 ],
23 "members": {
24 "OrganizationId": {},
25 "ResourceId": {},
26 "EntityId": {}
27 }
28 },
29 "output": {
30 "type": "structure",
31 "members": {}
32 },
33 "idempotent": true
34 },
35 "AssociateMemberToGroup": {
36 "input": {
37 "type": "structure",
38 "required": [
39 "OrganizationId",
40 "GroupId",
41 "MemberId"
42 ],
43 "members": {
44 "OrganizationId": {},
45 "GroupId": {},
46 "MemberId": {}
47 }
48 },
49 "output": {
50 "type": "structure",
51 "members": {}
52 },
53 "idempotent": true
54 },
55 "CreateAlias": {
56 "input": {
57 "type": "structure",
58 "required": [
59 "OrganizationId",
60 "EntityId",
61 "Alias"
62 ],
63 "members": {
64 "OrganizationId": {},
65 "EntityId": {},
66 "Alias": {}
67 }
68 },
69 "output": {
70 "type": "structure",
71 "members": {}
72 },
73 "idempotent": true
74 },
75 "CreateGroup": {
76 "input": {
77 "type": "structure",
78 "required": [
79 "OrganizationId",
80 "Name"
81 ],
82 "members": {
83 "OrganizationId": {},
84 "Name": {}
85 }
86 },
87 "output": {
88 "type": "structure",
89 "members": {
90 "GroupId": {}
91 }
92 },
93 "idempotent": true
94 },
95 "CreateResource": {
96 "input": {
97 "type": "structure",
98 "required": [
99 "OrganizationId",
100 "Name",
101 "Type"
102 ],
103 "members": {
104 "OrganizationId": {},
105 "Name": {},
106 "Type": {}
107 }
108 },
109 "output": {
110 "type": "structure",
111 "members": {
112 "ResourceId": {}
113 }
114 },
115 "idempotent": true
116 },
117 "CreateUser": {
118 "input": {
119 "type": "structure",
120 "required": [
121 "OrganizationId",
122 "Name",
123 "DisplayName",
124 "Password"
125 ],
126 "members": {
127 "OrganizationId": {},
128 "Name": {},
129 "DisplayName": {},
130 "Password": {
131 "shape": "Sl"
132 }
133 }
134 },
135 "output": {
136 "type": "structure",
137 "members": {
138 "UserId": {}
139 }
140 },
141 "idempotent": true
142 },
143 "DeleteAccessControlRule": {
144 "input": {
145 "type": "structure",
146 "required": [
147 "Name"
148 ],
149 "members": {
150 "OrganizationId": {},
151 "Name": {}
152 }
153 },
154 "output": {
155 "type": "structure",
156 "members": {}
157 }
158 },
159 "DeleteAlias": {
160 "input": {
161 "type": "structure",
162 "required": [
163 "OrganizationId",
164 "EntityId",
165 "Alias"
166 ],
167 "members": {
168 "OrganizationId": {},
169 "EntityId": {},
170 "Alias": {}
171 }
172 },
173 "output": {
174 "type": "structure",
175 "members": {}
176 },
177 "idempotent": true
178 },
179 "DeleteGroup": {
180 "input": {
181 "type": "structure",
182 "required": [
183 "OrganizationId",
184 "GroupId"
185 ],
186 "members": {
187 "OrganizationId": {},
188 "GroupId": {}
189 }
190 },
191 "output": {
192 "type": "structure",
193 "members": {}
194 },
195 "idempotent": true
196 },
197 "DeleteMailboxPermissions": {
198 "input": {
199 "type": "structure",
200 "required": [
201 "OrganizationId",
202 "EntityId",
203 "GranteeId"
204 ],
205 "members": {
206 "OrganizationId": {},
207 "EntityId": {},
208 "GranteeId": {}
209 }
210 },
211 "output": {
212 "type": "structure",
213 "members": {}
214 },
215 "idempotent": true
216 },
217 "DeleteResource": {
218 "input": {
219 "type": "structure",
220 "required": [
221 "OrganizationId",
222 "ResourceId"
223 ],
224 "members": {
225 "OrganizationId": {},
226 "ResourceId": {}
227 }
228 },
229 "output": {
230 "type": "structure",
231 "members": {}
232 },
233 "idempotent": true
234 },
235 "DeleteUser": {
236 "input": {
237 "type": "structure",
238 "required": [
239 "OrganizationId",
240 "UserId"
241 ],
242 "members": {
243 "OrganizationId": {},
244 "UserId": {}
245 }
246 },
247 "output": {
248 "type": "structure",
249 "members": {}
250 },
251 "idempotent": true
252 },
253 "DeregisterFromWorkMail": {
254 "input": {
255 "type": "structure",
256 "required": [
257 "OrganizationId",
258 "EntityId"
259 ],
260 "members": {
261 "OrganizationId": {},
262 "EntityId": {}
263 }
264 },
265 "output": {
266 "type": "structure",
267 "members": {}
268 },
269 "idempotent": true
270 },
271 "DescribeGroup": {
272 "input": {
273 "type": "structure",
274 "required": [
275 "OrganizationId",
276 "GroupId"
277 ],
278 "members": {
279 "OrganizationId": {},
280 "GroupId": {}
281 }
282 },
283 "output": {
284 "type": "structure",
285 "members": {
286 "GroupId": {},
287 "Name": {},
288 "Email": {},
289 "State": {},
290 "EnabledDate": {
291 "type": "timestamp"
292 },
293 "DisabledDate": {
294 "type": "timestamp"
295 }
296 }
297 },
298 "idempotent": true
299 },
300 "DescribeOrganization": {
301 "input": {
302 "type": "structure",
303 "required": [
304 "OrganizationId"
305 ],
306 "members": {
307 "OrganizationId": {}
308 }
309 },
310 "output": {
311 "type": "structure",
312 "members": {
313 "OrganizationId": {},
314 "Alias": {},
315 "State": {},
316 "DirectoryId": {},
317 "DirectoryType": {},
318 "DefaultMailDomain": {},
319 "CompletedDate": {
320 "type": "timestamp"
321 },
322 "ErrorMessage": {},
323 "ARN": {}
324 }
325 },
326 "idempotent": true
327 },
328 "DescribeResource": {
329 "input": {
330 "type": "structure",
331 "required": [
332 "OrganizationId",
333 "ResourceId"
334 ],
335 "members": {
336 "OrganizationId": {},
337 "ResourceId": {}
338 }
339 },
340 "output": {
341 "type": "structure",
342 "members": {
343 "ResourceId": {},
344 "Email": {},
345 "Name": {},
346 "Type": {},
347 "BookingOptions": {
348 "shape": "S1c"
349 },
350 "State": {},
351 "EnabledDate": {
352 "type": "timestamp"
353 },
354 "DisabledDate": {
355 "type": "timestamp"
356 }
357 }
358 },
359 "idempotent": true
360 },
361 "DescribeUser": {
362 "input": {
363 "type": "structure",
364 "required": [
365 "OrganizationId",
366 "UserId"
367 ],
368 "members": {
369 "OrganizationId": {},
370 "UserId": {}
371 }
372 },
373 "output": {
374 "type": "structure",
375 "members": {
376 "UserId": {},
377 "Name": {},
378 "Email": {},
379 "DisplayName": {},
380 "State": {},
381 "UserRole": {},
382 "EnabledDate": {
383 "type": "timestamp"
384 },
385 "DisabledDate": {
386 "type": "timestamp"
387 }
388 }
389 },
390 "idempotent": true
391 },
392 "DisassociateDelegateFromResource": {
393 "input": {
394 "type": "structure",
395 "required": [
396 "OrganizationId",
397 "ResourceId",
398 "EntityId"
399 ],
400 "members": {
401 "OrganizationId": {},
402 "ResourceId": {},
403 "EntityId": {}
404 }
405 },
406 "output": {
407 "type": "structure",
408 "members": {}
409 },
410 "idempotent": true
411 },
412 "DisassociateMemberFromGroup": {
413 "input": {
414 "type": "structure",
415 "required": [
416 "OrganizationId",
417 "GroupId",
418 "MemberId"
419 ],
420 "members": {
421 "OrganizationId": {},
422 "GroupId": {},
423 "MemberId": {}
424 }
425 },
426 "output": {
427 "type": "structure",
428 "members": {}
429 },
430 "idempotent": true
431 },
432 "GetAccessControlEffect": {
433 "input": {
434 "type": "structure",
435 "required": [
436 "OrganizationId",
437 "IpAddress",
438 "Action",
439 "UserId"
440 ],
441 "members": {
442 "OrganizationId": {},
443 "IpAddress": {},
444 "Action": {},
445 "UserId": {}
446 }
447 },
448 "output": {
449 "type": "structure",
450 "members": {
451 "Effect": {},
452 "MatchedRules": {
453 "type": "list",
454 "member": {}
455 }
456 }
457 }
458 },
459 "GetMailboxDetails": {
460 "input": {
461 "type": "structure",
462 "required": [
463 "OrganizationId",
464 "UserId"
465 ],
466 "members": {
467 "OrganizationId": {},
468 "UserId": {}
469 }
470 },
471 "output": {
472 "type": "structure",
473 "members": {
474 "MailboxQuota": {
475 "type": "integer"
476 },
477 "MailboxSize": {
478 "type": "double"
479 }
480 }
481 },
482 "idempotent": true
483 },
484 "ListAccessControlRules": {
485 "input": {
486 "type": "structure",
487 "required": [
488 "OrganizationId"
489 ],
490 "members": {
491 "OrganizationId": {}
492 }
493 },
494 "output": {
495 "type": "structure",
496 "members": {
497 "Rules": {
498 "type": "list",
499 "member": {
500 "type": "structure",
501 "members": {
502 "Name": {},
503 "Effect": {},
504 "Description": {},
505 "IpRanges": {
506 "shape": "S20"
507 },
508 "NotIpRanges": {
509 "shape": "S20"
510 },
511 "Actions": {
512 "shape": "S22"
513 },
514 "NotActions": {
515 "shape": "S22"
516 },
517 "UserIds": {
518 "shape": "S23"
519 },
520 "NotUserIds": {
521 "shape": "S23"
522 },
523 "DateCreated": {
524 "type": "timestamp"
525 },
526 "DateModified": {
527 "type": "timestamp"
528 }
529 }
530 }
531 }
532 }
533 }
534 },
535 "ListAliases": {
536 "input": {
537 "type": "structure",
538 "required": [
539 "OrganizationId",
540 "EntityId"
541 ],
542 "members": {
543 "OrganizationId": {},
544 "EntityId": {},
545 "NextToken": {},
546 "MaxResults": {
547 "type": "integer"
548 }
549 }
550 },
551 "output": {
552 "type": "structure",
553 "members": {
554 "Aliases": {
555 "type": "list",
556 "member": {}
557 },
558 "NextToken": {}
559 }
560 },
561 "idempotent": true
562 },
563 "ListGroupMembers": {
564 "input": {
565 "type": "structure",
566 "required": [
567 "OrganizationId",
568 "GroupId"
569 ],
570 "members": {
571 "OrganizationId": {},
572 "GroupId": {},
573 "NextToken": {},
574 "MaxResults": {
575 "type": "integer"
576 }
577 }
578 },
579 "output": {
580 "type": "structure",
581 "members": {
582 "Members": {
583 "type": "list",
584 "member": {
585 "type": "structure",
586 "members": {
587 "Id": {},
588 "Name": {},
589 "Type": {},
590 "State": {},
591 "EnabledDate": {
592 "type": "timestamp"
593 },
594 "DisabledDate": {
595 "type": "timestamp"
596 }
597 }
598 }
599 },
600 "NextToken": {}
601 }
602 },
603 "idempotent": true
604 },
605 "ListGroups": {
606 "input": {
607 "type": "structure",
608 "required": [
609 "OrganizationId"
610 ],
611 "members": {
612 "OrganizationId": {},
613 "NextToken": {},
614 "MaxResults": {
615 "type": "integer"
616 }
617 }
618 },
619 "output": {
620 "type": "structure",
621 "members": {
622 "Groups": {
623 "type": "list",
624 "member": {
625 "type": "structure",
626 "members": {
627 "Id": {},
628 "Email": {},
629 "Name": {},
630 "State": {},
631 "EnabledDate": {
632 "type": "timestamp"
633 },
634 "DisabledDate": {
635 "type": "timestamp"
636 }
637 }
638 }
639 },
640 "NextToken": {}
641 }
642 },
643 "idempotent": true
644 },
645 "ListMailboxPermissions": {
646 "input": {
647 "type": "structure",
648 "required": [
649 "OrganizationId",
650 "EntityId"
651 ],
652 "members": {
653 "OrganizationId": {},
654 "EntityId": {},
655 "NextToken": {},
656 "MaxResults": {
657 "type": "integer"
658 }
659 }
660 },
661 "output": {
662 "type": "structure",
663 "members": {
664 "Permissions": {
665 "type": "list",
666 "member": {
667 "type": "structure",
668 "required": [
669 "GranteeId",
670 "GranteeType",
671 "PermissionValues"
672 ],
673 "members": {
674 "GranteeId": {},
675 "GranteeType": {},
676 "PermissionValues": {
677 "shape": "S2m"
678 }
679 }
680 }
681 },
682 "NextToken": {}
683 }
684 },
685 "idempotent": true
686 },
687 "ListOrganizations": {
688 "input": {
689 "type": "structure",
690 "members": {
691 "NextToken": {},
692 "MaxResults": {
693 "type": "integer"
694 }
695 }
696 },
697 "output": {
698 "type": "structure",
699 "members": {
700 "OrganizationSummaries": {
701 "type": "list",
702 "member": {
703 "type": "structure",
704 "members": {
705 "OrganizationId": {},
706 "Alias": {},
707 "ErrorMessage": {},
708 "State": {}
709 }
710 }
711 },
712 "NextToken": {}
713 }
714 },
715 "idempotent": true
716 },
717 "ListResourceDelegates": {
718 "input": {
719 "type": "structure",
720 "required": [
721 "OrganizationId",
722 "ResourceId"
723 ],
724 "members": {
725 "OrganizationId": {},
726 "ResourceId": {},
727 "NextToken": {},
728 "MaxResults": {
729 "type": "integer"
730 }
731 }
732 },
733 "output": {
734 "type": "structure",
735 "members": {
736 "Delegates": {
737 "type": "list",
738 "member": {
739 "type": "structure",
740 "required": [
741 "Id",
742 "Type"
743 ],
744 "members": {
745 "Id": {},
746 "Type": {}
747 }
748 }
749 },
750 "NextToken": {}
751 }
752 },
753 "idempotent": true
754 },
755 "ListResources": {
756 "input": {
757 "type": "structure",
758 "required": [
759 "OrganizationId"
760 ],
761 "members": {
762 "OrganizationId": {},
763 "NextToken": {},
764 "MaxResults": {
765 "type": "integer"
766 }
767 }
768 },
769 "output": {
770 "type": "structure",
771 "members": {
772 "Resources": {
773 "type": "list",
774 "member": {
775 "type": "structure",
776 "members": {
777 "Id": {},
778 "Email": {},
779 "Name": {},
780 "Type": {},
781 "State": {},
782 "EnabledDate": {
783 "type": "timestamp"
784 },
785 "DisabledDate": {
786 "type": "timestamp"
787 }
788 }
789 }
790 },
791 "NextToken": {}
792 }
793 },
794 "idempotent": true
795 },
796 "ListTagsForResource": {
797 "input": {
798 "type": "structure",
799 "required": [
800 "ResourceARN"
801 ],
802 "members": {
803 "ResourceARN": {}
804 }
805 },
806 "output": {
807 "type": "structure",
808 "members": {
809 "Tags": {
810 "shape": "S32"
811 }
812 }
813 }
814 },
815 "ListUsers": {
816 "input": {
817 "type": "structure",
818 "required": [
819 "OrganizationId"
820 ],
821 "members": {
822 "OrganizationId": {},
823 "NextToken": {},
824 "MaxResults": {
825 "type": "integer"
826 }
827 }
828 },
829 "output": {
830 "type": "structure",
831 "members": {
832 "Users": {
833 "type": "list",
834 "member": {
835 "type": "structure",
836 "members": {
837 "Id": {},
838 "Email": {},
839 "Name": {},
840 "DisplayName": {},
841 "State": {},
842 "UserRole": {},
843 "EnabledDate": {
844 "type": "timestamp"
845 },
846 "DisabledDate": {
847 "type": "timestamp"
848 }
849 }
850 }
851 },
852 "NextToken": {}
853 }
854 },
855 "idempotent": true
856 },
857 "PutAccessControlRule": {
858 "input": {
859 "type": "structure",
860 "required": [
861 "Name",
862 "Effect",
863 "Description",
864 "OrganizationId"
865 ],
866 "members": {
867 "Name": {},
868 "Effect": {},
869 "Description": {},
870 "IpRanges": {
871 "shape": "S20"
872 },
873 "NotIpRanges": {
874 "shape": "S20"
875 },
876 "Actions": {
877 "shape": "S22"
878 },
879 "NotActions": {
880 "shape": "S22"
881 },
882 "UserIds": {
883 "shape": "S23"
884 },
885 "NotUserIds": {
886 "shape": "S23"
887 },
888 "OrganizationId": {}
889 }
890 },
891 "output": {
892 "type": "structure",
893 "members": {}
894 }
895 },
896 "PutMailboxPermissions": {
897 "input": {
898 "type": "structure",
899 "required": [
900 "OrganizationId",
901 "EntityId",
902 "GranteeId",
903 "PermissionValues"
904 ],
905 "members": {
906 "OrganizationId": {},
907 "EntityId": {},
908 "GranteeId": {},
909 "PermissionValues": {
910 "shape": "S2m"
911 }
912 }
913 },
914 "output": {
915 "type": "structure",
916 "members": {}
917 },
918 "idempotent": true
919 },
920 "RegisterToWorkMail": {
921 "input": {
922 "type": "structure",
923 "required": [
924 "OrganizationId",
925 "EntityId",
926 "Email"
927 ],
928 "members": {
929 "OrganizationId": {},
930 "EntityId": {},
931 "Email": {}
932 }
933 },
934 "output": {
935 "type": "structure",
936 "members": {}
937 },
938 "idempotent": true
939 },
940 "ResetPassword": {
941 "input": {
942 "type": "structure",
943 "required": [
944 "OrganizationId",
945 "UserId",
946 "Password"
947 ],
948 "members": {
949 "OrganizationId": {},
950 "UserId": {},
951 "Password": {
952 "shape": "Sl"
953 }
954 }
955 },
956 "output": {
957 "type": "structure",
958 "members": {}
959 },
960 "idempotent": true
961 },
962 "TagResource": {
963 "input": {
964 "type": "structure",
965 "required": [
966 "ResourceARN",
967 "Tags"
968 ],
969 "members": {
970 "ResourceARN": {},
971 "Tags": {
972 "shape": "S32"
973 }
974 }
975 },
976 "output": {
977 "type": "structure",
978 "members": {}
979 }
980 },
981 "UntagResource": {
982 "input": {
983 "type": "structure",
984 "required": [
985 "ResourceARN",
986 "TagKeys"
987 ],
988 "members": {
989 "ResourceARN": {},
990 "TagKeys": {
991 "type": "list",
992 "member": {}
993 }
994 }
995 },
996 "output": {
997 "type": "structure",
998 "members": {}
999 }
1000 },
1001 "UpdateMailboxQuota": {
1002 "input": {
1003 "type": "structure",
1004 "required": [
1005 "OrganizationId",
1006 "UserId",
1007 "MailboxQuota"
1008 ],
1009 "members": {
1010 "OrganizationId": {},
1011 "UserId": {},
1012 "MailboxQuota": {
1013 "type": "integer"
1014 }
1015 }
1016 },
1017 "output": {
1018 "type": "structure",
1019 "members": {}
1020 },
1021 "idempotent": true
1022 },
1023 "UpdatePrimaryEmailAddress": {
1024 "input": {
1025 "type": "structure",
1026 "required": [
1027 "OrganizationId",
1028 "EntityId",
1029 "Email"
1030 ],
1031 "members": {
1032 "OrganizationId": {},
1033 "EntityId": {},
1034 "Email": {}
1035 }
1036 },
1037 "output": {
1038 "type": "structure",
1039 "members": {}
1040 },
1041 "idempotent": true
1042 },
1043 "UpdateResource": {
1044 "input": {
1045 "type": "structure",
1046 "required": [
1047 "OrganizationId",
1048 "ResourceId"
1049 ],
1050 "members": {
1051 "OrganizationId": {},
1052 "ResourceId": {},
1053 "Name": {},
1054 "BookingOptions": {
1055 "shape": "S1c"
1056 }
1057 }
1058 },
1059 "output": {
1060 "type": "structure",
1061 "members": {}
1062 },
1063 "idempotent": true
1064 }
1065 },
1066 "shapes": {
1067 "Sl": {
1068 "type": "string",
1069 "sensitive": true
1070 },
1071 "S1c": {
1072 "type": "structure",
1073 "members": {
1074 "AutoAcceptRequests": {
1075 "type": "boolean"
1076 },
1077 "AutoDeclineRecurringRequests": {
1078 "type": "boolean"
1079 },
1080 "AutoDeclineConflictingRequests": {
1081 "type": "boolean"
1082 }
1083 }
1084 },
1085 "S20": {
1086 "type": "list",
1087 "member": {}
1088 },
1089 "S22": {
1090 "type": "list",
1091 "member": {}
1092 },
1093 "S23": {
1094 "type": "list",
1095 "member": {}
1096 },
1097 "S2m": {
1098 "type": "list",
1099 "member": {}
1100 },
1101 "S32": {
1102 "type": "list",
1103 "member": {
1104 "type": "structure",
1105 "required": [
1106 "Key",
1107 "Value"
1108 ],
1109 "members": {
1110 "Key": {},
1111 "Value": {}
1112 }
1113 }
1114 }
1115 }
1116}
\No newline at end of file