UNPKG

18.1 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 "DeleteAlias": {
144 "input": {
145 "type": "structure",
146 "required": [
147 "OrganizationId",
148 "EntityId",
149 "Alias"
150 ],
151 "members": {
152 "OrganizationId": {},
153 "EntityId": {},
154 "Alias": {}
155 }
156 },
157 "output": {
158 "type": "structure",
159 "members": {}
160 },
161 "idempotent": true
162 },
163 "DeleteGroup": {
164 "input": {
165 "type": "structure",
166 "required": [
167 "OrganizationId",
168 "GroupId"
169 ],
170 "members": {
171 "OrganizationId": {},
172 "GroupId": {}
173 }
174 },
175 "output": {
176 "type": "structure",
177 "members": {}
178 },
179 "idempotent": true
180 },
181 "DeleteMailboxPermissions": {
182 "input": {
183 "type": "structure",
184 "required": [
185 "OrganizationId",
186 "EntityId",
187 "GranteeId"
188 ],
189 "members": {
190 "OrganizationId": {},
191 "EntityId": {},
192 "GranteeId": {}
193 }
194 },
195 "output": {
196 "type": "structure",
197 "members": {}
198 },
199 "idempotent": true
200 },
201 "DeleteResource": {
202 "input": {
203 "type": "structure",
204 "required": [
205 "OrganizationId",
206 "ResourceId"
207 ],
208 "members": {
209 "OrganizationId": {},
210 "ResourceId": {}
211 }
212 },
213 "output": {
214 "type": "structure",
215 "members": {}
216 },
217 "idempotent": true
218 },
219 "DeleteUser": {
220 "input": {
221 "type": "structure",
222 "required": [
223 "OrganizationId",
224 "UserId"
225 ],
226 "members": {
227 "OrganizationId": {},
228 "UserId": {}
229 }
230 },
231 "output": {
232 "type": "structure",
233 "members": {}
234 },
235 "idempotent": true
236 },
237 "DeregisterFromWorkMail": {
238 "input": {
239 "type": "structure",
240 "required": [
241 "OrganizationId",
242 "EntityId"
243 ],
244 "members": {
245 "OrganizationId": {},
246 "EntityId": {}
247 }
248 },
249 "output": {
250 "type": "structure",
251 "members": {}
252 },
253 "idempotent": true
254 },
255 "DescribeGroup": {
256 "input": {
257 "type": "structure",
258 "required": [
259 "OrganizationId",
260 "GroupId"
261 ],
262 "members": {
263 "OrganizationId": {},
264 "GroupId": {}
265 }
266 },
267 "output": {
268 "type": "structure",
269 "members": {
270 "GroupId": {},
271 "Name": {},
272 "Email": {},
273 "State": {},
274 "EnabledDate": {
275 "type": "timestamp"
276 },
277 "DisabledDate": {
278 "type": "timestamp"
279 }
280 }
281 },
282 "idempotent": true
283 },
284 "DescribeOrganization": {
285 "input": {
286 "type": "structure",
287 "required": [
288 "OrganizationId"
289 ],
290 "members": {
291 "OrganizationId": {}
292 }
293 },
294 "output": {
295 "type": "structure",
296 "members": {
297 "OrganizationId": {},
298 "Alias": {},
299 "State": {},
300 "DirectoryId": {},
301 "DirectoryType": {},
302 "DefaultMailDomain": {},
303 "CompletedDate": {
304 "type": "timestamp"
305 },
306 "ErrorMessage": {}
307 }
308 },
309 "idempotent": true
310 },
311 "DescribeResource": {
312 "input": {
313 "type": "structure",
314 "required": [
315 "OrganizationId",
316 "ResourceId"
317 ],
318 "members": {
319 "OrganizationId": {},
320 "ResourceId": {}
321 }
322 },
323 "output": {
324 "type": "structure",
325 "members": {
326 "ResourceId": {},
327 "Email": {},
328 "Name": {},
329 "Type": {},
330 "BookingOptions": {
331 "shape": "S18"
332 },
333 "State": {},
334 "EnabledDate": {
335 "type": "timestamp"
336 },
337 "DisabledDate": {
338 "type": "timestamp"
339 }
340 }
341 },
342 "idempotent": true
343 },
344 "DescribeUser": {
345 "input": {
346 "type": "structure",
347 "required": [
348 "OrganizationId",
349 "UserId"
350 ],
351 "members": {
352 "OrganizationId": {},
353 "UserId": {}
354 }
355 },
356 "output": {
357 "type": "structure",
358 "members": {
359 "UserId": {},
360 "Name": {},
361 "Email": {},
362 "DisplayName": {},
363 "State": {},
364 "UserRole": {},
365 "EnabledDate": {
366 "type": "timestamp"
367 },
368 "DisabledDate": {
369 "type": "timestamp"
370 }
371 }
372 },
373 "idempotent": true
374 },
375 "DisassociateDelegateFromResource": {
376 "input": {
377 "type": "structure",
378 "required": [
379 "OrganizationId",
380 "ResourceId",
381 "EntityId"
382 ],
383 "members": {
384 "OrganizationId": {},
385 "ResourceId": {},
386 "EntityId": {}
387 }
388 },
389 "output": {
390 "type": "structure",
391 "members": {}
392 },
393 "idempotent": true
394 },
395 "DisassociateMemberFromGroup": {
396 "input": {
397 "type": "structure",
398 "required": [
399 "OrganizationId",
400 "GroupId",
401 "MemberId"
402 ],
403 "members": {
404 "OrganizationId": {},
405 "GroupId": {},
406 "MemberId": {}
407 }
408 },
409 "output": {
410 "type": "structure",
411 "members": {}
412 },
413 "idempotent": true
414 },
415 "ListAliases": {
416 "input": {
417 "type": "structure",
418 "required": [
419 "OrganizationId",
420 "EntityId"
421 ],
422 "members": {
423 "OrganizationId": {},
424 "EntityId": {},
425 "NextToken": {},
426 "MaxResults": {
427 "type": "integer"
428 }
429 }
430 },
431 "output": {
432 "type": "structure",
433 "members": {
434 "Aliases": {
435 "type": "list",
436 "member": {}
437 },
438 "NextToken": {}
439 }
440 },
441 "idempotent": true
442 },
443 "ListGroupMembers": {
444 "input": {
445 "type": "structure",
446 "required": [
447 "OrganizationId",
448 "GroupId"
449 ],
450 "members": {
451 "OrganizationId": {},
452 "GroupId": {},
453 "NextToken": {},
454 "MaxResults": {
455 "type": "integer"
456 }
457 }
458 },
459 "output": {
460 "type": "structure",
461 "members": {
462 "Members": {
463 "type": "list",
464 "member": {
465 "type": "structure",
466 "members": {
467 "Id": {},
468 "Name": {},
469 "Type": {},
470 "State": {},
471 "EnabledDate": {
472 "type": "timestamp"
473 },
474 "DisabledDate": {
475 "type": "timestamp"
476 }
477 }
478 }
479 },
480 "NextToken": {}
481 }
482 },
483 "idempotent": true
484 },
485 "ListGroups": {
486 "input": {
487 "type": "structure",
488 "required": [
489 "OrganizationId"
490 ],
491 "members": {
492 "OrganizationId": {},
493 "NextToken": {},
494 "MaxResults": {
495 "type": "integer"
496 }
497 }
498 },
499 "output": {
500 "type": "structure",
501 "members": {
502 "Groups": {
503 "type": "list",
504 "member": {
505 "type": "structure",
506 "members": {
507 "Id": {},
508 "Email": {},
509 "Name": {},
510 "State": {},
511 "EnabledDate": {
512 "type": "timestamp"
513 },
514 "DisabledDate": {
515 "type": "timestamp"
516 }
517 }
518 }
519 },
520 "NextToken": {}
521 }
522 },
523 "idempotent": true
524 },
525 "ListMailboxPermissions": {
526 "input": {
527 "type": "structure",
528 "required": [
529 "OrganizationId",
530 "EntityId"
531 ],
532 "members": {
533 "OrganizationId": {},
534 "EntityId": {},
535 "NextToken": {},
536 "MaxResults": {
537 "type": "integer"
538 }
539 }
540 },
541 "output": {
542 "type": "structure",
543 "members": {
544 "Permissions": {
545 "type": "list",
546 "member": {
547 "type": "structure",
548 "required": [
549 "GranteeId",
550 "GranteeType",
551 "PermissionValues"
552 ],
553 "members": {
554 "GranteeId": {},
555 "GranteeType": {},
556 "PermissionValues": {
557 "shape": "S1z"
558 }
559 }
560 }
561 },
562 "NextToken": {}
563 }
564 },
565 "idempotent": true
566 },
567 "ListOrganizations": {
568 "input": {
569 "type": "structure",
570 "members": {
571 "NextToken": {},
572 "MaxResults": {
573 "type": "integer"
574 }
575 }
576 },
577 "output": {
578 "type": "structure",
579 "members": {
580 "OrganizationSummaries": {
581 "type": "list",
582 "member": {
583 "type": "structure",
584 "members": {
585 "OrganizationId": {},
586 "Alias": {},
587 "ErrorMessage": {},
588 "State": {}
589 }
590 }
591 },
592 "NextToken": {}
593 }
594 },
595 "idempotent": true
596 },
597 "ListResourceDelegates": {
598 "input": {
599 "type": "structure",
600 "required": [
601 "OrganizationId",
602 "ResourceId"
603 ],
604 "members": {
605 "OrganizationId": {},
606 "ResourceId": {},
607 "NextToken": {},
608 "MaxResults": {
609 "type": "integer"
610 }
611 }
612 },
613 "output": {
614 "type": "structure",
615 "members": {
616 "Delegates": {
617 "type": "list",
618 "member": {
619 "type": "structure",
620 "required": [
621 "Id",
622 "Type"
623 ],
624 "members": {
625 "Id": {},
626 "Type": {}
627 }
628 }
629 },
630 "NextToken": {}
631 }
632 },
633 "idempotent": true
634 },
635 "ListResources": {
636 "input": {
637 "type": "structure",
638 "required": [
639 "OrganizationId"
640 ],
641 "members": {
642 "OrganizationId": {},
643 "NextToken": {},
644 "MaxResults": {
645 "type": "integer"
646 }
647 }
648 },
649 "output": {
650 "type": "structure",
651 "members": {
652 "Resources": {
653 "type": "list",
654 "member": {
655 "type": "structure",
656 "members": {
657 "Id": {},
658 "Email": {},
659 "Name": {},
660 "Type": {},
661 "State": {},
662 "EnabledDate": {
663 "type": "timestamp"
664 },
665 "DisabledDate": {
666 "type": "timestamp"
667 }
668 }
669 }
670 },
671 "NextToken": {}
672 }
673 },
674 "idempotent": true
675 },
676 "ListUsers": {
677 "input": {
678 "type": "structure",
679 "required": [
680 "OrganizationId"
681 ],
682 "members": {
683 "OrganizationId": {},
684 "NextToken": {},
685 "MaxResults": {
686 "type": "integer"
687 }
688 }
689 },
690 "output": {
691 "type": "structure",
692 "members": {
693 "Users": {
694 "type": "list",
695 "member": {
696 "type": "structure",
697 "members": {
698 "Id": {},
699 "Email": {},
700 "Name": {},
701 "DisplayName": {},
702 "State": {},
703 "UserRole": {},
704 "EnabledDate": {
705 "type": "timestamp"
706 },
707 "DisabledDate": {
708 "type": "timestamp"
709 }
710 }
711 }
712 },
713 "NextToken": {}
714 }
715 },
716 "idempotent": true
717 },
718 "PutMailboxPermissions": {
719 "input": {
720 "type": "structure",
721 "required": [
722 "OrganizationId",
723 "EntityId",
724 "GranteeId",
725 "PermissionValues"
726 ],
727 "members": {
728 "OrganizationId": {},
729 "EntityId": {},
730 "GranteeId": {},
731 "PermissionValues": {
732 "shape": "S1z"
733 }
734 }
735 },
736 "output": {
737 "type": "structure",
738 "members": {}
739 },
740 "idempotent": true
741 },
742 "RegisterToWorkMail": {
743 "input": {
744 "type": "structure",
745 "required": [
746 "OrganizationId",
747 "EntityId",
748 "Email"
749 ],
750 "members": {
751 "OrganizationId": {},
752 "EntityId": {},
753 "Email": {}
754 }
755 },
756 "output": {
757 "type": "structure",
758 "members": {}
759 },
760 "idempotent": true
761 },
762 "ResetPassword": {
763 "input": {
764 "type": "structure",
765 "required": [
766 "OrganizationId",
767 "UserId",
768 "Password"
769 ],
770 "members": {
771 "OrganizationId": {},
772 "UserId": {},
773 "Password": {
774 "shape": "Sl"
775 }
776 }
777 },
778 "output": {
779 "type": "structure",
780 "members": {}
781 },
782 "idempotent": true
783 },
784 "UpdatePrimaryEmailAddress": {
785 "input": {
786 "type": "structure",
787 "required": [
788 "OrganizationId",
789 "EntityId",
790 "Email"
791 ],
792 "members": {
793 "OrganizationId": {},
794 "EntityId": {},
795 "Email": {}
796 }
797 },
798 "output": {
799 "type": "structure",
800 "members": {}
801 },
802 "idempotent": true
803 },
804 "UpdateResource": {
805 "input": {
806 "type": "structure",
807 "required": [
808 "OrganizationId",
809 "ResourceId"
810 ],
811 "members": {
812 "OrganizationId": {},
813 "ResourceId": {},
814 "Name": {},
815 "BookingOptions": {
816 "shape": "S18"
817 }
818 }
819 },
820 "output": {
821 "type": "structure",
822 "members": {}
823 },
824 "idempotent": true
825 }
826 },
827 "shapes": {
828 "Sl": {
829 "type": "string",
830 "sensitive": true
831 },
832 "S18": {
833 "type": "structure",
834 "members": {
835 "AutoAcceptRequests": {
836 "type": "boolean"
837 },
838 "AutoDeclineRecurringRequests": {
839 "type": "boolean"
840 },
841 "AutoDeclineConflictingRequests": {
842 "type": "boolean"
843 }
844 }
845 },
846 "S1z": {
847 "type": "list",
848 "member": {}
849 }
850 }
851}
\No newline at end of file