-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
service-2.json
3387 lines (3387 loc) · 112 KB
/
service-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-10-01",
"endpointPrefix":"workmail",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon WorkMail",
"serviceId":"WorkMail",
"signatureVersion":"v4",
"targetPrefix":"WorkMailService",
"uid":"workmail-2017-10-01"
},
"operations":{
"AssociateDelegateToResource":{
"name":"AssociateDelegateToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateDelegateToResourceRequest"},
"output":{"shape":"AssociateDelegateToResourceResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Adds a member (user or group) to the resource's set of delegates.</p>",
"idempotent":true
},
"AssociateMemberToGroup":{
"name":"AssociateMemberToGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateMemberToGroupRequest"},
"output":{"shape":"AssociateMemberToGroupResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Adds a member (user or group) to the group's set.</p>",
"idempotent":true
},
"CancelMailboxExportJob":{
"name":"CancelMailboxExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelMailboxExportJobRequest"},
"output":{"shape":"CancelMailboxExportJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Cancels a mailbox export job.</p> <note> <p>If the mailbox export job is near completion, it might not be possible to cancel it.</p> </note>",
"idempotent":true
},
"CreateAlias":{
"name":"CreateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAliasRequest"},
"output":{"shape":"CreateAliasResponse"},
"errors":[
{"shape":"EmailAddressInUseException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"MailDomainNotFoundException"},
{"shape":"MailDomainStateException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds an alias to the set of a given member (user or group) of Amazon WorkMail.</p>",
"idempotent":true
},
"CreateGroup":{
"name":"CreateGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateGroupRequest"},
"output":{"shape":"CreateGroupResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"NameAvailabilityException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"ReservedNameException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Creates a group that can be used in Amazon WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>",
"idempotent":true
},
"CreateOrganization":{
"name":"CreateOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateOrganizationRequest"},
"output":{"shape":"CreateOrganizationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DirectoryInUseException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"LimitExceededException"},
{"shape":"NameAvailabilityException"}
],
"documentation":"<p>Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html\">Adding an organization</a> in the <i>Amazon WorkMail Administrator Guide</i>.</p> <p>You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html\">Adding a domain</a> and <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html\">Choosing the default domain</a> in the <i>Amazon WorkMail Administrator Guide</i>.</p> <p>Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.</p>",
"idempotent":true
},
"CreateResource":{
"name":"CreateResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateResourceRequest"},
"output":{"shape":"CreateResourceResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"NameAvailabilityException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"ReservedNameException"}
],
"documentation":"<p>Creates a new Amazon WorkMail resource. </p>",
"idempotent":true
},
"CreateUser":{
"name":"CreateUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateUserRequest"},
"output":{"shape":"CreateUserResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidPasswordException"},
{"shape":"NameAvailabilityException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"ReservedNameException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Creates a user who can be used in Amazon WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>",
"idempotent":true
},
"DeleteAccessControlRule":{
"name":"DeleteAccessControlRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAccessControlRuleRequest"},
"output":{"shape":"DeleteAccessControlRuleResponse"},
"errors":[
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Deletes an access control rule for the specified WorkMail organization.</p>"
},
"DeleteAlias":{
"name":"DeleteAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAliasRequest"},
"output":{"shape":"DeleteAliasResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Remove one or more specified aliases from a set of aliases for a given user.</p>",
"idempotent":true
},
"DeleteGroup":{
"name":"DeleteGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteGroupRequest"},
"output":{"shape":"DeleteGroupResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Deletes a group from Amazon WorkMail.</p>",
"idempotent":true
},
"DeleteMailboxPermissions":{
"name":"DeleteMailboxPermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteMailboxPermissionsRequest"},
"output":{"shape":"DeleteMailboxPermissionsResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Deletes permissions granted to a member (user or group).</p>",
"idempotent":true
},
"DeleteOrganization":{
"name":"DeleteOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteOrganizationRequest"},
"output":{"shape":"DeleteOrganizationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html\">Removing an organization</a> in the <i>Amazon WorkMail Administrator Guide</i>.</p>",
"idempotent":true
},
"DeleteResource":{
"name":"DeleteResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResourceRequest"},
"output":{"shape":"DeleteResourceResponse"},
"errors":[
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Deletes the specified resource. </p>",
"idempotent":true
},
"DeleteRetentionPolicy":{
"name":"DeleteRetentionPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRetentionPolicyRequest"},
"output":{"shape":"DeleteRetentionPolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Deletes the specified retention policy from the specified organization.</p>",
"idempotent":true
},
"DeleteUser":{
"name":"DeleteUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserRequest"},
"output":{"shape":"DeleteUserResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be <code>DISABLED</code>. Use the <a>DescribeUser</a> action to confirm the user state.</p> <p>Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.</p>",
"idempotent":true
},
"DeregisterFromWorkMail":{
"name":"DeregisterFromWorkMail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterFromWorkMailRequest"},
"output":{"shape":"DeregisterFromWorkMailResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is <i>Disable</i>.</p>",
"idempotent":true
},
"DescribeGroup":{
"name":"DescribeGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeGroupRequest"},
"output":{"shape":"DescribeGroupResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns the data available for the group.</p>",
"idempotent":true
},
"DescribeMailboxExportJob":{
"name":"DescribeMailboxExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeMailboxExportJobRequest"},
"output":{"shape":"DescribeMailboxExportJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Describes the current status of a mailbox export job.</p>",
"idempotent":true
},
"DescribeOrganization":{
"name":"DescribeOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeOrganizationRequest"},
"output":{"shape":"DescribeOrganizationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"}
],
"documentation":"<p>Provides more information regarding a given organization based on its identifier.</p>",
"idempotent":true
},
"DescribeResource":{
"name":"DescribeResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeResourceRequest"},
"output":{"shape":"DescribeResourceResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns the data available for the resource.</p>",
"idempotent":true
},
"DescribeUser":{
"name":"DescribeUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeUserRequest"},
"output":{"shape":"DescribeUserResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Provides information regarding the user.</p>",
"idempotent":true
},
"DisassociateDelegateFromResource":{
"name":"DisassociateDelegateFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateDelegateFromResourceRequest"},
"output":{"shape":"DisassociateDelegateFromResourceResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Removes a member from the resource's set of delegates.</p>",
"idempotent":true
},
"DisassociateMemberFromGroup":{
"name":"DisassociateMemberFromGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateMemberFromGroupRequest"},
"output":{"shape":"DisassociateMemberFromGroupResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Removes a member from a group.</p>",
"idempotent":true
},
"GetAccessControlEffect":{
"name":"GetAccessControlEffect",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAccessControlEffectRequest"},
"output":{"shape":"GetAccessControlEffectResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID. </p>"
},
"GetDefaultRetentionPolicy":{
"name":"GetDefaultRetentionPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDefaultRetentionPolicyRequest"},
"output":{"shape":"GetDefaultRetentionPolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Gets the default retention policy details for the specified organization.</p>",
"idempotent":true
},
"GetMailboxDetails":{
"name":"GetMailboxDetails",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetMailboxDetailsRequest"},
"output":{"shape":"GetMailboxDetailsResponse"},
"errors":[
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Requests a user's mailbox details for a specified organization and user.</p>",
"idempotent":true
},
"ListAccessControlRules":{
"name":"ListAccessControlRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAccessControlRulesRequest"},
"output":{"shape":"ListAccessControlRulesResponse"},
"errors":[
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Lists the access control rules for the specified organization.</p>"
},
"ListAliases":{
"name":"ListAliases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAliasesRequest"},
"output":{"shape":"ListAliasesResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Creates a paginated call to list the aliases associated with a given entity.</p>",
"idempotent":true
},
"ListGroupMembers":{
"name":"ListGroupMembers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListGroupMembersRequest"},
"output":{"shape":"ListGroupMembersResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns an overview of the members of a group. Users and groups can be members of a group.</p>",
"idempotent":true
},
"ListGroups":{
"name":"ListGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListGroupsRequest"},
"output":{"shape":"ListGroupsResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns summaries of the organization's groups.</p>",
"idempotent":true
},
"ListMailboxExportJobs":{
"name":"ListMailboxExportJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListMailboxExportJobsRequest"},
"output":{"shape":"ListMailboxExportJobsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Lists the mailbox export jobs started for the specified organization within the last seven days.</p>",
"idempotent":true
},
"ListMailboxPermissions":{
"name":"ListMailboxPermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListMailboxPermissionsRequest"},
"output":{"shape":"ListMailboxPermissionsResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Lists the mailbox permissions associated with a user, group, or resource mailbox.</p>",
"idempotent":true
},
"ListOrganizations":{
"name":"ListOrganizations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListOrganizationsRequest"},
"output":{"shape":"ListOrganizationsResponse"},
"errors":[
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Returns summaries of the customer's organizations.</p>",
"idempotent":true
},
"ListResourceDelegates":{
"name":"ListResourceDelegates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResourceDelegatesRequest"},
"output":{"shape":"ListResourceDelegatesResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.</p>",
"idempotent":true
},
"ListResources":{
"name":"ListResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResourcesRequest"},
"output":{"shape":"ListResourcesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns summaries of the organization's resources.</p>",
"idempotent":true
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags applied to an Amazon WorkMail organization resource.</p>"
},
"ListUsers":{
"name":"ListUsers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListUsersRequest"},
"output":{"shape":"ListUsersResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Returns summaries of the organization's users.</p>",
"idempotent":true
},
"PutAccessControlRule":{
"name":"PutAccessControlRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutAccessControlRuleRequest"},
"output":{"shape":"PutAccessControlRuleResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"EntityNotFoundException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.</p>"
},
"PutMailboxPermissions":{
"name":"PutMailboxPermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutMailboxPermissionsRequest"},
"output":{"shape":"PutMailboxPermissionsResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.</p>",
"idempotent":true
},
"PutRetentionPolicy":{
"name":"PutRetentionPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutRetentionPolicyRequest"},
"output":{"shape":"PutRetentionPolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Puts a retention policy to the specified organization.</p>",
"idempotent":true
},
"RegisterToWorkMail":{
"name":"RegisterToWorkMail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterToWorkMailRequest"},
"output":{"shape":"RegisterToWorkMailResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EmailAddressInUseException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"EntityAlreadyRegisteredException"},
{"shape":"InvalidParameterException"},
{"shape":"MailDomainNotFoundException"},
{"shape":"MailDomainStateException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see <a href=\"https://aws.amazon.com/workmail/pricing\">Pricing</a>. The equivalent console functionality for this operation is <i>Enable</i>. </p> <p>Users can either be created by calling the <a>CreateUser</a> API operation or they can be synchronized from your directory. For more information, see <a>DeregisterFromWorkMail</a>.</p>",
"idempotent":true
},
"ResetPassword":{
"name":"ResetPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetPasswordRequest"},
"output":{"shape":"ResetPasswordResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidPasswordException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Allows the administrator to reset the password for a user.</p>",
"idempotent":true
},
"StartMailboxExportJob":{
"name":"StartMailboxExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartMailboxExportJobRequest"},
"output":{"shape":"StartMailboxExportJobResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href=\"https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html\">Exporting mailbox content</a> in the <i>Amazon WorkMail Administrator Guide</i>.</p>",
"idempotent":true
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyTagsException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Applies the specified tags to the specified Amazon WorkMail organization resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Untags the specified tags from the specified Amazon WorkMail organization resource.</p>"
},
"UpdateMailboxQuota":{
"name":"UpdateMailboxQuota",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateMailboxQuotaRequest"},
"output":{"shape":"UpdateMailboxQuotaResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"}
],
"documentation":"<p>Updates a user's current mailbox quota for a specified organization and user.</p>",
"idempotent":true
},
"UpdatePrimaryEmailAddress":{
"name":"UpdatePrimaryEmailAddress",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdatePrimaryEmailAddressRequest"},
"output":{"shape":"UpdatePrimaryEmailAddressResponse"},
"errors":[
{"shape":"DirectoryServiceAuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EmailAddressInUseException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidParameterException"},
{"shape":"MailDomainNotFoundException"},
{"shape":"MailDomainStateException"},
{"shape":"InvalidParameterException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.</p>",
"idempotent":true
},
"UpdateResource":{
"name":"UpdateResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResourceRequest"},
"output":{"shape":"UpdateResourceResponse"},
"errors":[
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityNotFoundException"},
{"shape":"EntityStateException"},
{"shape":"InvalidConfigurationException"},
{"shape":"EmailAddressInUseException"},
{"shape":"MailDomainNotFoundException"},
{"shape":"MailDomainStateException"},
{"shape":"NameAvailabilityException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Updates data for the resource. To have the latest information, it must be preceded by a <a>DescribeResource</a> call. The dataset in the request should be the one expected when performing another <code>DescribeResource</code> call.</p>",
"idempotent":true
}
},
"shapes":{
"AccessControlRule":{
"type":"structure",
"members":{
"Name":{
"shape":"AccessControlRuleName",
"documentation":"<p>The rule name.</p>"
},
"Effect":{
"shape":"AccessControlRuleEffect",
"documentation":"<p>The rule effect.</p>"
},
"Description":{
"shape":"AccessControlRuleDescription",
"documentation":"<p>The rule description.</p>"
},
"IpRanges":{
"shape":"IpRangeList",
"documentation":"<p>IPv4 CIDR ranges to include in the rule.</p>"
},
"NotIpRanges":{
"shape":"IpRangeList",
"documentation":"<p>IPv4 CIDR ranges to exclude from the rule.</p>"
},
"Actions":{
"shape":"ActionsList",
"documentation":"<p>Access protocol actions to include in the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
},
"NotActions":{
"shape":"ActionsList",
"documentation":"<p>Access protocol actions to exclude from the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
},
"UserIds":{
"shape":"UserIdList",
"documentation":"<p>User IDs to include in the rule.</p>"
},
"NotUserIds":{
"shape":"UserIdList",
"documentation":"<p>User IDs to exclude from the rule.</p>"
},
"DateCreated":{
"shape":"Timestamp",
"documentation":"<p>The date that the rule was created.</p>"
},
"DateModified":{
"shape":"Timestamp",
"documentation":"<p>The date that the rule was modified.</p>"
}
},
"documentation":"<p>A rule that controls access to an Amazon WorkMail organization.</p>"
},
"AccessControlRuleAction":{
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z]+"
},
"AccessControlRuleDescription":{
"type":"string",
"max":255,
"min":0,
"pattern":"[\\u0020-\\u00FF]+"
},
"AccessControlRuleEffect":{
"type":"string",
"enum":[
"ALLOW",
"DENY"
]
},
"AccessControlRuleName":{
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"AccessControlRuleNameList":{
"type":"list",
"member":{"shape":"AccessControlRuleName"},
"max":10,
"min":0
},
"AccessControlRulesList":{
"type":"list",
"member":{"shape":"AccessControlRule"},
"max":10,
"min":0
},
"ActionsList":{
"type":"list",
"member":{"shape":"AccessControlRuleAction"},
"max":10,
"min":0
},
"Aliases":{
"type":"list",
"member":{"shape":"EmailAddress"}
},
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"AssociateDelegateToResourceRequest":{
"type":"structure",
"required":[
"OrganizationId",
"ResourceId",
"EntityId"
],
"members":{