workmail.d.ts
69.8 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class WorkMail extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: WorkMail.Types.ClientConfiguration)
config: Config & WorkMail.Types.ClientConfiguration;
/**
* Adds a member (user or group) to the resource's set of delegates.
*/
associateDelegateToResource(params: WorkMail.Types.AssociateDelegateToResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.AssociateDelegateToResourceResponse) => void): Request<WorkMail.Types.AssociateDelegateToResourceResponse, AWSError>;
/**
* Adds a member (user or group) to the resource's set of delegates.
*/
associateDelegateToResource(callback?: (err: AWSError, data: WorkMail.Types.AssociateDelegateToResourceResponse) => void): Request<WorkMail.Types.AssociateDelegateToResourceResponse, AWSError>;
/**
* Adds a member (user or group) to the group's set.
*/
associateMemberToGroup(params: WorkMail.Types.AssociateMemberToGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.AssociateMemberToGroupResponse) => void): Request<WorkMail.Types.AssociateMemberToGroupResponse, AWSError>;
/**
* Adds a member (user or group) to the group's set.
*/
associateMemberToGroup(callback?: (err: AWSError, data: WorkMail.Types.AssociateMemberToGroupResponse) => void): Request<WorkMail.Types.AssociateMemberToGroupResponse, AWSError>;
/**
* Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.
*/
cancelMailboxExportJob(params: WorkMail.Types.CancelMailboxExportJobRequest, callback?: (err: AWSError, data: WorkMail.Types.CancelMailboxExportJobResponse) => void): Request<WorkMail.Types.CancelMailboxExportJobResponse, AWSError>;
/**
* Cancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.
*/
cancelMailboxExportJob(callback?: (err: AWSError, data: WorkMail.Types.CancelMailboxExportJobResponse) => void): Request<WorkMail.Types.CancelMailboxExportJobResponse, AWSError>;
/**
* Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
*/
createAlias(params: WorkMail.Types.CreateAliasRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateAliasResponse) => void): Request<WorkMail.Types.CreateAliasResponse, AWSError>;
/**
* Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
*/
createAlias(callback?: (err: AWSError, data: WorkMail.Types.CreateAliasResponse) => void): Request<WorkMail.Types.CreateAliasResponse, AWSError>;
/**
* Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
*/
createGroup(params: WorkMail.Types.CreateGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateGroupResponse) => void): Request<WorkMail.Types.CreateGroupResponse, AWSError>;
/**
* Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
*/
createGroup(callback?: (err: AWSError, data: WorkMail.Types.CreateGroupResponse) => void): Request<WorkMail.Types.CreateGroupResponse, AWSError>;
/**
* Creates a new Amazon WorkMail resource.
*/
createResource(params: WorkMail.Types.CreateResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateResourceResponse) => void): Request<WorkMail.Types.CreateResourceResponse, AWSError>;
/**
* Creates a new Amazon WorkMail resource.
*/
createResource(callback?: (err: AWSError, data: WorkMail.Types.CreateResourceResponse) => void): Request<WorkMail.Types.CreateResourceResponse, AWSError>;
/**
* Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
*/
createUser(params: WorkMail.Types.CreateUserRequest, callback?: (err: AWSError, data: WorkMail.Types.CreateUserResponse) => void): Request<WorkMail.Types.CreateUserResponse, AWSError>;
/**
* Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
*/
createUser(callback?: (err: AWSError, data: WorkMail.Types.CreateUserResponse) => void): Request<WorkMail.Types.CreateUserResponse, AWSError>;
/**
* Deletes an access control rule for the specified WorkMail organization.
*/
deleteAccessControlRule(params: WorkMail.Types.DeleteAccessControlRuleRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteAccessControlRuleResponse) => void): Request<WorkMail.Types.DeleteAccessControlRuleResponse, AWSError>;
/**
* Deletes an access control rule for the specified WorkMail organization.
*/
deleteAccessControlRule(callback?: (err: AWSError, data: WorkMail.Types.DeleteAccessControlRuleResponse) => void): Request<WorkMail.Types.DeleteAccessControlRuleResponse, AWSError>;
/**
* Remove one or more specified aliases from a set of aliases for a given user.
*/
deleteAlias(params: WorkMail.Types.DeleteAliasRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteAliasResponse) => void): Request<WorkMail.Types.DeleteAliasResponse, AWSError>;
/**
* Remove one or more specified aliases from a set of aliases for a given user.
*/
deleteAlias(callback?: (err: AWSError, data: WorkMail.Types.DeleteAliasResponse) => void): Request<WorkMail.Types.DeleteAliasResponse, AWSError>;
/**
* Deletes a group from Amazon WorkMail.
*/
deleteGroup(params: WorkMail.Types.DeleteGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteGroupResponse) => void): Request<WorkMail.Types.DeleteGroupResponse, AWSError>;
/**
* Deletes a group from Amazon WorkMail.
*/
deleteGroup(callback?: (err: AWSError, data: WorkMail.Types.DeleteGroupResponse) => void): Request<WorkMail.Types.DeleteGroupResponse, AWSError>;
/**
* Deletes permissions granted to a member (user or group).
*/
deleteMailboxPermissions(params: WorkMail.Types.DeleteMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteMailboxPermissionsResponse) => void): Request<WorkMail.Types.DeleteMailboxPermissionsResponse, AWSError>;
/**
* Deletes permissions granted to a member (user or group).
*/
deleteMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.DeleteMailboxPermissionsResponse) => void): Request<WorkMail.Types.DeleteMailboxPermissionsResponse, AWSError>;
/**
* Deletes the specified resource.
*/
deleteResource(params: WorkMail.Types.DeleteResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteResourceResponse) => void): Request<WorkMail.Types.DeleteResourceResponse, AWSError>;
/**
* Deletes the specified resource.
*/
deleteResource(callback?: (err: AWSError, data: WorkMail.Types.DeleteResourceResponse) => void): Request<WorkMail.Types.DeleteResourceResponse, AWSError>;
/**
* Deletes the specified retention policy from the specified organization.
*/
deleteRetentionPolicy(params: WorkMail.Types.DeleteRetentionPolicyRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteRetentionPolicyResponse) => void): Request<WorkMail.Types.DeleteRetentionPolicyResponse, AWSError>;
/**
* Deletes the specified retention policy from the specified organization.
*/
deleteRetentionPolicy(callback?: (err: AWSError, data: WorkMail.Types.DeleteRetentionPolicyResponse) => void): Request<WorkMail.Types.DeleteRetentionPolicyResponse, AWSError>;
/**
* Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
*/
deleteUser(params: WorkMail.Types.DeleteUserRequest, callback?: (err: AWSError, data: WorkMail.Types.DeleteUserResponse) => void): Request<WorkMail.Types.DeleteUserResponse, AWSError>;
/**
* Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state. Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
*/
deleteUser(callback?: (err: AWSError, data: WorkMail.Types.DeleteUserResponse) => void): Request<WorkMail.Types.DeleteUserResponse, AWSError>;
/**
* 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 Disable.
*/
deregisterFromWorkMail(params: WorkMail.Types.DeregisterFromWorkMailRequest, callback?: (err: AWSError, data: WorkMail.Types.DeregisterFromWorkMailResponse) => void): Request<WorkMail.Types.DeregisterFromWorkMailResponse, AWSError>;
/**
* 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 Disable.
*/
deregisterFromWorkMail(callback?: (err: AWSError, data: WorkMail.Types.DeregisterFromWorkMailResponse) => void): Request<WorkMail.Types.DeregisterFromWorkMailResponse, AWSError>;
/**
* Returns the data available for the group.
*/
describeGroup(params: WorkMail.Types.DescribeGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeGroupResponse) => void): Request<WorkMail.Types.DescribeGroupResponse, AWSError>;
/**
* Returns the data available for the group.
*/
describeGroup(callback?: (err: AWSError, data: WorkMail.Types.DescribeGroupResponse) => void): Request<WorkMail.Types.DescribeGroupResponse, AWSError>;
/**
* Describes the current status of a mailbox export job.
*/
describeMailboxExportJob(params: WorkMail.Types.DescribeMailboxExportJobRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeMailboxExportJobResponse) => void): Request<WorkMail.Types.DescribeMailboxExportJobResponse, AWSError>;
/**
* Describes the current status of a mailbox export job.
*/
describeMailboxExportJob(callback?: (err: AWSError, data: WorkMail.Types.DescribeMailboxExportJobResponse) => void): Request<WorkMail.Types.DescribeMailboxExportJobResponse, AWSError>;
/**
* Provides more information regarding a given organization based on its identifier.
*/
describeOrganization(params: WorkMail.Types.DescribeOrganizationRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeOrganizationResponse) => void): Request<WorkMail.Types.DescribeOrganizationResponse, AWSError>;
/**
* Provides more information regarding a given organization based on its identifier.
*/
describeOrganization(callback?: (err: AWSError, data: WorkMail.Types.DescribeOrganizationResponse) => void): Request<WorkMail.Types.DescribeOrganizationResponse, AWSError>;
/**
* Returns the data available for the resource.
*/
describeResource(params: WorkMail.Types.DescribeResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeResourceResponse) => void): Request<WorkMail.Types.DescribeResourceResponse, AWSError>;
/**
* Returns the data available for the resource.
*/
describeResource(callback?: (err: AWSError, data: WorkMail.Types.DescribeResourceResponse) => void): Request<WorkMail.Types.DescribeResourceResponse, AWSError>;
/**
* Provides information regarding the user.
*/
describeUser(params: WorkMail.Types.DescribeUserRequest, callback?: (err: AWSError, data: WorkMail.Types.DescribeUserResponse) => void): Request<WorkMail.Types.DescribeUserResponse, AWSError>;
/**
* Provides information regarding the user.
*/
describeUser(callback?: (err: AWSError, data: WorkMail.Types.DescribeUserResponse) => void): Request<WorkMail.Types.DescribeUserResponse, AWSError>;
/**
* Removes a member from the resource's set of delegates.
*/
disassociateDelegateFromResource(params: WorkMail.Types.DisassociateDelegateFromResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.DisassociateDelegateFromResourceResponse) => void): Request<WorkMail.Types.DisassociateDelegateFromResourceResponse, AWSError>;
/**
* Removes a member from the resource's set of delegates.
*/
disassociateDelegateFromResource(callback?: (err: AWSError, data: WorkMail.Types.DisassociateDelegateFromResourceResponse) => void): Request<WorkMail.Types.DisassociateDelegateFromResourceResponse, AWSError>;
/**
* Removes a member from a group.
*/
disassociateMemberFromGroup(params: WorkMail.Types.DisassociateMemberFromGroupRequest, callback?: (err: AWSError, data: WorkMail.Types.DisassociateMemberFromGroupResponse) => void): Request<WorkMail.Types.DisassociateMemberFromGroupResponse, AWSError>;
/**
* Removes a member from a group.
*/
disassociateMemberFromGroup(callback?: (err: AWSError, data: WorkMail.Types.DisassociateMemberFromGroupResponse) => void): Request<WorkMail.Types.DisassociateMemberFromGroupResponse, AWSError>;
/**
* Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
*/
getAccessControlEffect(params: WorkMail.Types.GetAccessControlEffectRequest, callback?: (err: AWSError, data: WorkMail.Types.GetAccessControlEffectResponse) => void): Request<WorkMail.Types.GetAccessControlEffectResponse, AWSError>;
/**
* Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
*/
getAccessControlEffect(callback?: (err: AWSError, data: WorkMail.Types.GetAccessControlEffectResponse) => void): Request<WorkMail.Types.GetAccessControlEffectResponse, AWSError>;
/**
* Gets the default retention policy details for the specified organization.
*/
getDefaultRetentionPolicy(params: WorkMail.Types.GetDefaultRetentionPolicyRequest, callback?: (err: AWSError, data: WorkMail.Types.GetDefaultRetentionPolicyResponse) => void): Request<WorkMail.Types.GetDefaultRetentionPolicyResponse, AWSError>;
/**
* Gets the default retention policy details for the specified organization.
*/
getDefaultRetentionPolicy(callback?: (err: AWSError, data: WorkMail.Types.GetDefaultRetentionPolicyResponse) => void): Request<WorkMail.Types.GetDefaultRetentionPolicyResponse, AWSError>;
/**
* Requests a user's mailbox details for a specified organization and user.
*/
getMailboxDetails(params: WorkMail.Types.GetMailboxDetailsRequest, callback?: (err: AWSError, data: WorkMail.Types.GetMailboxDetailsResponse) => void): Request<WorkMail.Types.GetMailboxDetailsResponse, AWSError>;
/**
* Requests a user's mailbox details for a specified organization and user.
*/
getMailboxDetails(callback?: (err: AWSError, data: WorkMail.Types.GetMailboxDetailsResponse) => void): Request<WorkMail.Types.GetMailboxDetailsResponse, AWSError>;
/**
* Lists the access control rules for the specified organization.
*/
listAccessControlRules(params: WorkMail.Types.ListAccessControlRulesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListAccessControlRulesResponse) => void): Request<WorkMail.Types.ListAccessControlRulesResponse, AWSError>;
/**
* Lists the access control rules for the specified organization.
*/
listAccessControlRules(callback?: (err: AWSError, data: WorkMail.Types.ListAccessControlRulesResponse) => void): Request<WorkMail.Types.ListAccessControlRulesResponse, AWSError>;
/**
* Creates a paginated call to list the aliases associated with a given entity.
*/
listAliases(params: WorkMail.Types.ListAliasesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListAliasesResponse) => void): Request<WorkMail.Types.ListAliasesResponse, AWSError>;
/**
* Creates a paginated call to list the aliases associated with a given entity.
*/
listAliases(callback?: (err: AWSError, data: WorkMail.Types.ListAliasesResponse) => void): Request<WorkMail.Types.ListAliasesResponse, AWSError>;
/**
* Returns an overview of the members of a group. Users and groups can be members of a group.
*/
listGroupMembers(params: WorkMail.Types.ListGroupMembersRequest, callback?: (err: AWSError, data: WorkMail.Types.ListGroupMembersResponse) => void): Request<WorkMail.Types.ListGroupMembersResponse, AWSError>;
/**
* Returns an overview of the members of a group. Users and groups can be members of a group.
*/
listGroupMembers(callback?: (err: AWSError, data: WorkMail.Types.ListGroupMembersResponse) => void): Request<WorkMail.Types.ListGroupMembersResponse, AWSError>;
/**
* Returns summaries of the organization's groups.
*/
listGroups(params: WorkMail.Types.ListGroupsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListGroupsResponse) => void): Request<WorkMail.Types.ListGroupsResponse, AWSError>;
/**
* Returns summaries of the organization's groups.
*/
listGroups(callback?: (err: AWSError, data: WorkMail.Types.ListGroupsResponse) => void): Request<WorkMail.Types.ListGroupsResponse, AWSError>;
/**
* Lists the mailbox export jobs started for the specified organization within the last seven days.
*/
listMailboxExportJobs(params: WorkMail.Types.ListMailboxExportJobsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListMailboxExportJobsResponse) => void): Request<WorkMail.Types.ListMailboxExportJobsResponse, AWSError>;
/**
* Lists the mailbox export jobs started for the specified organization within the last seven days.
*/
listMailboxExportJobs(callback?: (err: AWSError, data: WorkMail.Types.ListMailboxExportJobsResponse) => void): Request<WorkMail.Types.ListMailboxExportJobsResponse, AWSError>;
/**
* Lists the mailbox permissions associated with a user, group, or resource mailbox.
*/
listMailboxPermissions(params: WorkMail.Types.ListMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListMailboxPermissionsResponse) => void): Request<WorkMail.Types.ListMailboxPermissionsResponse, AWSError>;
/**
* Lists the mailbox permissions associated with a user, group, or resource mailbox.
*/
listMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.ListMailboxPermissionsResponse) => void): Request<WorkMail.Types.ListMailboxPermissionsResponse, AWSError>;
/**
* Returns summaries of the customer's organizations.
*/
listOrganizations(params: WorkMail.Types.ListOrganizationsRequest, callback?: (err: AWSError, data: WorkMail.Types.ListOrganizationsResponse) => void): Request<WorkMail.Types.ListOrganizationsResponse, AWSError>;
/**
* Returns summaries of the customer's organizations.
*/
listOrganizations(callback?: (err: AWSError, data: WorkMail.Types.ListOrganizationsResponse) => void): Request<WorkMail.Types.ListOrganizationsResponse, AWSError>;
/**
* Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
*/
listResourceDelegates(params: WorkMail.Types.ListResourceDelegatesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListResourceDelegatesResponse) => void): Request<WorkMail.Types.ListResourceDelegatesResponse, AWSError>;
/**
* Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
*/
listResourceDelegates(callback?: (err: AWSError, data: WorkMail.Types.ListResourceDelegatesResponse) => void): Request<WorkMail.Types.ListResourceDelegatesResponse, AWSError>;
/**
* Returns summaries of the organization's resources.
*/
listResources(params: WorkMail.Types.ListResourcesRequest, callback?: (err: AWSError, data: WorkMail.Types.ListResourcesResponse) => void): Request<WorkMail.Types.ListResourcesResponse, AWSError>;
/**
* Returns summaries of the organization's resources.
*/
listResources(callback?: (err: AWSError, data: WorkMail.Types.ListResourcesResponse) => void): Request<WorkMail.Types.ListResourcesResponse, AWSError>;
/**
* Lists the tags applied to an Amazon WorkMail organization resource.
*/
listTagsForResource(params: WorkMail.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.ListTagsForResourceResponse) => void): Request<WorkMail.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags applied to an Amazon WorkMail organization resource.
*/
listTagsForResource(callback?: (err: AWSError, data: WorkMail.Types.ListTagsForResourceResponse) => void): Request<WorkMail.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns summaries of the organization's users.
*/
listUsers(params: WorkMail.Types.ListUsersRequest, callback?: (err: AWSError, data: WorkMail.Types.ListUsersResponse) => void): Request<WorkMail.Types.ListUsersResponse, AWSError>;
/**
* Returns summaries of the organization's users.
*/
listUsers(callback?: (err: AWSError, data: WorkMail.Types.ListUsersResponse) => void): Request<WorkMail.Types.ListUsersResponse, AWSError>;
/**
* 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.
*/
putAccessControlRule(params: WorkMail.Types.PutAccessControlRuleRequest, callback?: (err: AWSError, data: WorkMail.Types.PutAccessControlRuleResponse) => void): Request<WorkMail.Types.PutAccessControlRuleResponse, AWSError>;
/**
* 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.
*/
putAccessControlRule(callback?: (err: AWSError, data: WorkMail.Types.PutAccessControlRuleResponse) => void): Request<WorkMail.Types.PutAccessControlRuleResponse, AWSError>;
/**
* Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
*/
putMailboxPermissions(params: WorkMail.Types.PutMailboxPermissionsRequest, callback?: (err: AWSError, data: WorkMail.Types.PutMailboxPermissionsResponse) => void): Request<WorkMail.Types.PutMailboxPermissionsResponse, AWSError>;
/**
* Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
*/
putMailboxPermissions(callback?: (err: AWSError, data: WorkMail.Types.PutMailboxPermissionsResponse) => void): Request<WorkMail.Types.PutMailboxPermissionsResponse, AWSError>;
/**
* Puts a retention policy to the specified organization.
*/
putRetentionPolicy(params: WorkMail.Types.PutRetentionPolicyRequest, callback?: (err: AWSError, data: WorkMail.Types.PutRetentionPolicyResponse) => void): Request<WorkMail.Types.PutRetentionPolicyResponse, AWSError>;
/**
* Puts a retention policy to the specified organization.
*/
putRetentionPolicy(callback?: (err: AWSError, data: WorkMail.Types.PutRetentionPolicyResponse) => void): Request<WorkMail.Types.PutRetentionPolicyResponse, AWSError>;
/**
* 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 Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
*/
registerToWorkMail(params: WorkMail.Types.RegisterToWorkMailRequest, callback?: (err: AWSError, data: WorkMail.Types.RegisterToWorkMailResponse) => void): Request<WorkMail.Types.RegisterToWorkMailResponse, AWSError>;
/**
* 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 Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.
*/
registerToWorkMail(callback?: (err: AWSError, data: WorkMail.Types.RegisterToWorkMailResponse) => void): Request<WorkMail.Types.RegisterToWorkMailResponse, AWSError>;
/**
* Allows the administrator to reset the password for a user.
*/
resetPassword(params: WorkMail.Types.ResetPasswordRequest, callback?: (err: AWSError, data: WorkMail.Types.ResetPasswordResponse) => void): Request<WorkMail.Types.ResetPasswordResponse, AWSError>;
/**
* Allows the administrator to reset the password for a user.
*/
resetPassword(callback?: (err: AWSError, data: WorkMail.Types.ResetPasswordResponse) => void): Request<WorkMail.Types.ResetPasswordResponse, AWSError>;
/**
* 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 Exporting mailbox content in the Amazon WorkMail Administrator Guide.
*/
startMailboxExportJob(params: WorkMail.Types.StartMailboxExportJobRequest, callback?: (err: AWSError, data: WorkMail.Types.StartMailboxExportJobResponse) => void): Request<WorkMail.Types.StartMailboxExportJobResponse, AWSError>;
/**
* 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 Exporting mailbox content in the Amazon WorkMail Administrator Guide.
*/
startMailboxExportJob(callback?: (err: AWSError, data: WorkMail.Types.StartMailboxExportJobResponse) => void): Request<WorkMail.Types.StartMailboxExportJobResponse, AWSError>;
/**
* Applies the specified tags to the specified Amazon WorkMail organization resource.
*/
tagResource(params: WorkMail.Types.TagResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.TagResourceResponse) => void): Request<WorkMail.Types.TagResourceResponse, AWSError>;
/**
* Applies the specified tags to the specified Amazon WorkMail organization resource.
*/
tagResource(callback?: (err: AWSError, data: WorkMail.Types.TagResourceResponse) => void): Request<WorkMail.Types.TagResourceResponse, AWSError>;
/**
* Untags the specified tags from the specified Amazon WorkMail organization resource.
*/
untagResource(params: WorkMail.Types.UntagResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.UntagResourceResponse) => void): Request<WorkMail.Types.UntagResourceResponse, AWSError>;
/**
* Untags the specified tags from the specified Amazon WorkMail organization resource.
*/
untagResource(callback?: (err: AWSError, data: WorkMail.Types.UntagResourceResponse) => void): Request<WorkMail.Types.UntagResourceResponse, AWSError>;
/**
* Updates a user's current mailbox quota for a specified organization and user.
*/
updateMailboxQuota(params: WorkMail.Types.UpdateMailboxQuotaRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdateMailboxQuotaResponse) => void): Request<WorkMail.Types.UpdateMailboxQuotaResponse, AWSError>;
/**
* Updates a user's current mailbox quota for a specified organization and user.
*/
updateMailboxQuota(callback?: (err: AWSError, data: WorkMail.Types.UpdateMailboxQuotaResponse) => void): Request<WorkMail.Types.UpdateMailboxQuotaResponse, AWSError>;
/**
* 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.
*/
updatePrimaryEmailAddress(params: WorkMail.Types.UpdatePrimaryEmailAddressRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdatePrimaryEmailAddressResponse) => void): Request<WorkMail.Types.UpdatePrimaryEmailAddressResponse, AWSError>;
/**
* 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.
*/
updatePrimaryEmailAddress(callback?: (err: AWSError, data: WorkMail.Types.UpdatePrimaryEmailAddressResponse) => void): Request<WorkMail.Types.UpdatePrimaryEmailAddressResponse, AWSError>;
/**
* Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
*/
updateResource(params: WorkMail.Types.UpdateResourceRequest, callback?: (err: AWSError, data: WorkMail.Types.UpdateResourceResponse) => void): Request<WorkMail.Types.UpdateResourceResponse, AWSError>;
/**
* Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.
*/
updateResource(callback?: (err: AWSError, data: WorkMail.Types.UpdateResourceResponse) => void): Request<WorkMail.Types.UpdateResourceResponse, AWSError>;
}
declare namespace WorkMail {
export interface AccessControlRule {
/**
* The rule name.
*/
Name?: AccessControlRuleName;
/**
* The rule effect.
*/
Effect?: AccessControlRuleEffect;
/**
* The rule description.
*/
Description?: AccessControlRuleDescription;
/**
* IPv4 CIDR ranges to include in the rule.
*/
IpRanges?: IpRangeList;
/**
* IPv4 CIDR ranges to exclude from the rule.
*/
NotIpRanges?: IpRangeList;
/**
* Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
*/
Actions?: ActionsList;
/**
* Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
*/
NotActions?: ActionsList;
/**
* User IDs to include in the rule.
*/
UserIds?: UserIdList;
/**
* User IDs to exclude from the rule.
*/
NotUserIds?: UserIdList;
/**
* The date that the rule was created.
*/
DateCreated?: Timestamp;
/**
* The date that the rule was modified.
*/
DateModified?: Timestamp;
}
export type AccessControlRuleAction = string;
export type AccessControlRuleDescription = string;
export type AccessControlRuleEffect = "ALLOW"|"DENY"|string;
export type AccessControlRuleName = string;
export type AccessControlRuleNameList = AccessControlRuleName[];
export type AccessControlRulesList = AccessControlRule[];
export type ActionsList = AccessControlRuleAction[];
export type Aliases = EmailAddress[];
export type AmazonResourceName = string;
export interface AssociateDelegateToResourceRequest {
/**
* The organization under which the resource exists.
*/
OrganizationId: OrganizationId;
/**
* The resource for which members (users or groups) are associated.
*/
ResourceId: ResourceId;
/**
* The member (user or group) to associate to the resource.
*/
EntityId: WorkMailIdentifier;
}
export interface AssociateDelegateToResourceResponse {
}
export interface AssociateMemberToGroupRequest {
/**
* The organization under which the group exists.
*/
OrganizationId: OrganizationId;
/**
* The group to which the member (user or group) is associated.
*/
GroupId: WorkMailIdentifier;
/**
* The member (user or group) to associate to the group.
*/
MemberId: WorkMailIdentifier;
}
export interface AssociateMemberToGroupResponse {
}
export interface BookingOptions {
/**
* The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
*/
AutoAcceptRequests?: Boolean;
/**
* The resource's ability to automatically decline any recurring requests.
*/
AutoDeclineRecurringRequests?: Boolean;
/**
* The resource's ability to automatically decline any conflicting requests.
*/
AutoDeclineConflictingRequests?: Boolean;
}
export type Boolean = boolean;
export interface CancelMailboxExportJobRequest {
/**
* The idempotency token for the client request.
*/
ClientToken: IdempotencyClientToken;
/**
* The job ID.
*/
JobId: MailboxExportJobId;
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
}
export interface CancelMailboxExportJobResponse {
}
export interface CreateAliasRequest {
/**
* The organization under which the member (user or group) exists.
*/
OrganizationId: OrganizationId;
/**
* The member (user or group) to which this alias is added.
*/
EntityId: WorkMailIdentifier;
/**
* The alias to add to the member set.
*/
Alias: EmailAddress;
}
export interface CreateAliasResponse {
}
export interface CreateGroupRequest {
/**
* The organization under which the group is to be created.
*/
OrganizationId: OrganizationId;
/**
* The name of the group.
*/
Name: GroupName;
}
export interface CreateGroupResponse {
/**
* The identifier of the group.
*/
GroupId?: WorkMailIdentifier;
}
export interface CreateResourceRequest {
/**
* The identifier associated with the organization for which the resource is created.
*/
OrganizationId: OrganizationId;
/**
* The name of the new resource.
*/
Name: ResourceName;
/**
* The type of the new resource. The available types are equipment and room.
*/
Type: ResourceType;
}
export interface CreateResourceResponse {
/**
* The identifier of the new resource.
*/
ResourceId?: ResourceId;
}
export interface CreateUserRequest {
/**
* The identifier of the organization for which the user is created.
*/
OrganizationId: OrganizationId;
/**
* The name for the new user. Simple AD or AD Connector user names have a maximum length of 20. All others have a maximum length of 64.
*/
Name: UserName;
/**
* The display name for the new user.
*/
DisplayName: String;
/**
* The password for the new user.
*/
Password: Password;
}
export interface CreateUserResponse {
/**
* The identifier for the new user.
*/
UserId?: WorkMailIdentifier;
}
export interface Delegate {
/**
* The identifier for the user or group associated as the resource's delegate.
*/
Id: String;
/**
* The type of the delegate: user or group.
*/
Type: MemberType;
}
export interface DeleteAccessControlRuleRequest {
/**
* The identifier for the organization.
*/
OrganizationId: OrganizationId;
/**
* The name of the access control rule.
*/
Name: AccessControlRuleName;
}
export interface DeleteAccessControlRuleResponse {
}
export interface DeleteAliasRequest {
/**
* The identifier for the organization under which the user exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the member (user or group) from which to have the aliases removed.
*/
EntityId: WorkMailIdentifier;
/**
* The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
*/
Alias: EmailAddress;
}
export interface DeleteAliasResponse {
}
export interface DeleteGroupRequest {
/**
* The organization that contains the group.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the group to be deleted.
*/
GroupId: WorkMailIdentifier;
}
export interface DeleteGroupResponse {
}
export interface DeleteMailboxPermissionsRequest {
/**
* The identifier of the organization under which the member (user or group) exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the member (user or group)that owns the mailbox.
*/
EntityId: WorkMailIdentifier;
/**
* The identifier of the member (user or group) for which to delete granted permissions.
*/
GranteeId: WorkMailIdentifier;
}
export interface DeleteMailboxPermissionsResponse {
}
export interface DeleteResourceRequest {
/**
* The identifier associated with the organization from which the resource is deleted.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the resource to be deleted.
*/
ResourceId: ResourceId;
}
export interface DeleteResourceResponse {
}
export interface DeleteRetentionPolicyRequest {
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
/**
* The retention policy ID.
*/
Id: ShortString;
}
export interface DeleteRetentionPolicyResponse {
}
export interface DeleteUserRequest {
/**
* The organization that contains the user to be deleted.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the user to be deleted.
*/
UserId: WorkMailIdentifier;
}
export interface DeleteUserResponse {
}
export interface DeregisterFromWorkMailRequest {
/**
* The identifier for the organization under which the Amazon WorkMail entity exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the member (user or group) to be updated.
*/
EntityId: WorkMailIdentifier;
}
export interface DeregisterFromWorkMailResponse {
}
export interface DescribeGroupRequest {
/**
* The identifier for the organization under which the group exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the group to be described.
*/
GroupId: WorkMailIdentifier;
}
export interface DescribeGroupResponse {
/**
* The identifier of the described group.
*/
GroupId?: WorkMailIdentifier;
/**
* The name of the described group.
*/
Name?: GroupName;
/**
* The email of the described group.
*/
Email?: EmailAddress;
/**
* The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
*/
State?: EntityState;
/**
* The date and time when a user was registered to WorkMail, in UNIX epoch time format.
*/
EnabledDate?: Timestamp;
/**
* The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
*/
DisabledDate?: Timestamp;
}
export interface DescribeMailboxExportJobRequest {
/**
* The mailbox export job ID.
*/
JobId: MailboxExportJobId;
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
}
export interface DescribeMailboxExportJobResponse {
/**
* The identifier of the user or resource associated with the mailbox.
*/
EntityId?: WorkMailIdentifier;
/**
* The mailbox export job description.
*/
Description?: Description;
/**
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
*/
RoleArn?: RoleArn;
/**
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
*/
KmsKeyArn?: KmsKeyArn;
/**
* The name of the S3 bucket.
*/
S3BucketName?: S3BucketName;
/**
* The S3 bucket prefix.
*/
S3Prefix?: S3ObjectKey;
/**
* The path to the S3 bucket and file that the mailbox export job is exporting to.
*/
S3Path?: S3ObjectKey;
/**
* The estimated progress of the mailbox export job, in percentage points.
*/
EstimatedProgress?: Percentage;
/**
* The state of the mailbox export job.
*/
State?: MailboxExportJobState;
/**
* Error information for failed mailbox export jobs.
*/
ErrorInfo?: MailboxExportErrorInfo;
/**
* The mailbox export job start timestamp.
*/
StartTime?: Timestamp;
/**
* The mailbox export job end timestamp.
*/
EndTime?: Timestamp;
}
export interface DescribeOrganizationRequest {
/**
* The identifier for the organization to be described.
*/
OrganizationId: OrganizationId;
}
export interface DescribeOrganizationResponse {
/**
* The identifier of an organization.
*/
OrganizationId?: OrganizationId;
/**
* The alias for an organization.
*/
Alias?: OrganizationName;
/**
* The state of an organization.
*/
State?: String;
/**
* The identifier for the directory associated with an Amazon WorkMail organization.
*/
DirectoryId?: String;
/**
* The type of directory associated with the WorkMail organization.
*/
DirectoryType?: String;
/**
* The default mail domain associated with the organization.
*/
DefaultMailDomain?: String;
/**
* The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.
*/
CompletedDate?: Timestamp;
/**
* (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.
*/
ErrorMessage?: String;
/**
* The Amazon Resource Name (ARN) of the organization.
*/
ARN?: AmazonResourceName;
}
export interface DescribeResourceRequest {
/**
* The identifier associated with the organization for which the resource is described.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the resource to be described.
*/
ResourceId: ResourceId;
}
export interface DescribeResourceResponse {
/**
* The identifier of the described resource.
*/
ResourceId?: ResourceId;
/**
* The email of the described resource.
*/
Email?: EmailAddress;
/**
* The name of the described resource.
*/
Name?: ResourceName;
/**
* The type of the described resource.
*/
Type?: ResourceType;
/**
* The booking options for the described resource.
*/
BookingOptions?: BookingOptions;
/**
* The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
*/
State?: EntityState;
/**
* The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
*/
EnabledDate?: Timestamp;
/**
* The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
*/
DisabledDate?: Timestamp;
}
export interface DescribeUserRequest {
/**
* The identifier for the organization under which the user exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the user to be described.
*/
UserId: WorkMailIdentifier;
}
export interface DescribeUserResponse {
/**
* The identifier for the described user.
*/
UserId?: WorkMailIdentifier;
/**
* The name for the user.
*/
Name?: UserName;
/**
* The email of the user.
*/
Email?: EmailAddress;
/**
* The display name of the user.
*/
DisplayName?: String;
/**
* The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
*/
State?: EntityState;
/**
* In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.
*/
UserRole?: UserRole;
/**
* The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
*/
EnabledDate?: Timestamp;
/**
* The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
*/
DisabledDate?: Timestamp;
}
export type Description = string;
export interface DisassociateDelegateFromResourceRequest {
/**
* The identifier for the organization under which the resource exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the resource from which delegates' set members are removed.
*/
ResourceId: ResourceId;
/**
* The identifier for the member (user, group) to be removed from the resource's delegates.
*/
EntityId: WorkMailIdentifier;
}
export interface DisassociateDelegateFromResourceResponse {
}
export interface DisassociateMemberFromGroupRequest {
/**
* The identifier for the organization under which the group exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the group from which members are removed.
*/
GroupId: WorkMailIdentifier;
/**
* The identifier for the member to be removed to the group.
*/
MemberId: WorkMailIdentifier;
}
export interface DisassociateMemberFromGroupResponse {
}
export type EmailAddress = string;
export type EntityState = "ENABLED"|"DISABLED"|"DELETED"|string;
export interface FolderConfiguration {
/**
* The folder name.
*/
Name: FolderName;
/**
* The action to take on the folder contents at the end of the folder configuration period.
*/
Action: RetentionAction;
/**
* The period of time at which the folder configuration action is applied.
*/
Period?: RetentionPeriod;
}
export type FolderConfigurations = FolderConfiguration[];
export type FolderName = "INBOX"|"DELETED_ITEMS"|"SENT_ITEMS"|"DRAFTS"|"JUNK_EMAIL"|string;
export interface GetAccessControlEffectRequest {
/**
* The identifier for the organization.
*/
OrganizationId: OrganizationId;
/**
* The IPv4 address.
*/
IpAddress: IpAddress;
/**
* The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
*/
Action: AccessControlRuleAction;
/**
* The user ID.
*/
UserId: WorkMailIdentifier;
}
export interface GetAccessControlEffectResponse {
/**
* The rule effect.
*/
Effect?: AccessControlRuleEffect;
/**
* The rules that match the given parameters, resulting in an effect.
*/
MatchedRules?: AccessControlRuleNameList;
}
export interface GetDefaultRetentionPolicyRequest {
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
}
export interface GetDefaultRetentionPolicyResponse {
/**
* The retention policy ID.
*/
Id?: ShortString;
/**
* The retention policy name.
*/
Name?: ShortString;
/**
* The retention policy description.
*/
Description?: String;
/**
* The retention policy folder configurations.
*/
FolderConfigurations?: FolderConfigurations;
}
export interface GetMailboxDetailsRequest {
/**
* The identifier for the organization that contains the user whose mailbox details are being requested.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the user whose mailbox details are being requested.
*/
UserId: WorkMailIdentifier;
}
export interface GetMailboxDetailsResponse {
/**
* The maximum allowed mailbox size, in MB, for the specified user.
*/
MailboxQuota?: MailboxQuota;
/**
* The current mailbox size, in MB, for the specified user.
*/
MailboxSize?: MailboxSize;
}
export interface Group {
/**
* The identifier of the group.
*/
Id?: WorkMailIdentifier;
/**
* The email of the group.
*/
Email?: EmailAddress;
/**
* The name of the group.
*/
Name?: GroupName;
/**
* The state of the group, which can be ENABLED, DISABLED, or DELETED.
*/
State?: EntityState;
/**
* The date indicating when the group was enabled for Amazon WorkMail use.
*/
EnabledDate?: Timestamp;
/**
* The date indicating when the group was disabled from Amazon WorkMail use.
*/
DisabledDate?: Timestamp;
}
export type GroupName = string;
export type Groups = Group[];
export type IdempotencyClientToken = string;
export type IpAddress = string;
export type IpRange = string;
export type IpRangeList = IpRange[];
export type Jobs = MailboxExportJob[];
export type KmsKeyArn = string;
export interface ListAccessControlRulesRequest {
/**
* The identifier for the organization.
*/
OrganizationId: OrganizationId;
}
export interface ListAccessControlRulesResponse {
/**
* The access control rules.
*/
Rules?: AccessControlRulesList;
}
export interface ListAliasesRequest {
/**
* The identifier for the organization under which the entity exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the entity for which to list the aliases.
*/
EntityId: WorkMailIdentifier;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListAliasesResponse {
/**
* The entity's paginated aliases.
*/
Aliases?: Aliases;
/**
* The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*/
NextToken?: NextToken;
}
export interface ListGroupMembersRequest {
/**
* The identifier for the organization under which the group exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the group to which the members (users or groups) are associated.
*/
GroupId: WorkMailIdentifier;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListGroupMembersResponse {
/**
* The members associated to the group.
*/
Members?: Members;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
}
export interface ListGroupsRequest {
/**
* The identifier for the organization under which the groups exist.
*/
OrganizationId: OrganizationId;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListGroupsResponse {
/**
* The overview of groups for an organization.
*/
Groups?: Groups;
/**
* The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*/
NextToken?: NextToken;
}
export interface ListMailboxExportJobsRequest {
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListMailboxExportJobsResponse {
/**
* The mailbox export job details.
*/
Jobs?: Jobs;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: NextToken;
}
export interface ListMailboxPermissionsRequest {
/**
* The identifier of the organization under which the user, group, or resource exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the user, group, or resource for which to list mailbox permissions.
*/
EntityId: WorkMailIdentifier;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListMailboxPermissionsResponse {
/**
* One page of the user, group, or resource mailbox permissions.
*/
Permissions?: Permissions;
/**
* The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*/
NextToken?: NextToken;
}
export interface ListOrganizationsRequest {
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListOrganizationsResponse {
/**
* The overview of owned organizations presented as a list of organization summaries.
*/
OrganizationSummaries?: OrganizationSummaries;
/**
* The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.
*/
NextToken?: NextToken;
}
export interface ListResourceDelegatesRequest {
/**
* The identifier for the organization that contains the resource for which delegates are listed.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the resource whose delegates are listed.
*/
ResourceId: WorkMailIdentifier;
/**
* The token used to paginate through the delegates associated with a resource.
*/
NextToken?: NextToken;
/**
* The number of maximum results in a page.
*/
MaxResults?: MaxResults;
}
export interface ListResourceDelegatesResponse {
/**
* One page of the resource's delegates.
*/
Delegates?: ResourceDelegates;
/**
* The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.
*/
NextToken?: NextToken;
}
export interface ListResourcesRequest {
/**
* The identifier for the organization under which the resources exist.
*/
OrganizationId: OrganizationId;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListResourcesResponse {
/**
* One page of the organization's resource representation.
*/
Resources?: Resources;
/**
* The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The resource ARN.
*/
ResourceARN: AmazonResourceName;
}
export interface ListTagsForResourceResponse {
/**
* A list of tag key-value pairs.
*/
Tags?: TagList;
}
export interface ListUsersRequest {
/**
* The identifier for the organization under which the users exist.
*/
OrganizationId: OrganizationId;
/**
* The token to use to retrieve the next page of results. The first call does not contain any tokens.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: MaxResults;
}
export interface ListUsersResponse {
/**
* The overview of users for an organization.
*/
Users?: Users;
/**
* The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.
*/
NextToken?: NextToken;
}
export type MailboxExportErrorInfo = string;
export interface MailboxExportJob {
/**
* The identifier of the mailbox export job.
*/
JobId?: MailboxExportJobId;
/**
* The identifier of the user or resource associated with the mailbox.
*/
EntityId?: WorkMailIdentifier;
/**
* The mailbox export job description.
*/
Description?: Description;
/**
* The name of the S3 bucket.
*/
S3BucketName?: S3BucketName;
/**
* The path to the S3 bucket and file that the mailbox export job exports to.
*/
S3Path?: S3ObjectKey;
/**
* The estimated progress of the mailbox export job, in percentage points.
*/
EstimatedProgress?: Percentage;
/**
* The state of the mailbox export job.
*/
State?: MailboxExportJobState;
/**
* The mailbox export job start timestamp.
*/
StartTime?: Timestamp;
/**
* The mailbox export job end timestamp.
*/
EndTime?: Timestamp;
}
export type MailboxExportJobId = string;
export type MailboxExportJobState = "RUNNING"|"COMPLETED"|"FAILED"|"CANCELLED"|string;
export type MailboxQuota = number;
export type MailboxSize = number;
export type MaxResults = number;
export interface Member {
/**
* The identifier of the member.
*/
Id?: String;
/**
* The name of the member.
*/
Name?: String;
/**
* A member can be a user or group.
*/
Type?: MemberType;
/**
* The state of the member, which can be ENABLED, DISABLED, or DELETED.
*/
State?: EntityState;
/**
* The date indicating when the member was enabled for Amazon WorkMail use.
*/
EnabledDate?: Timestamp;
/**
* The date indicating when the member was disabled from Amazon WorkMail use.
*/
DisabledDate?: Timestamp;
}
export type MemberType = "GROUP"|"USER"|string;
export type Members = Member[];
export type NextToken = string;
export type OrganizationId = string;
export type OrganizationName = string;
export type OrganizationSummaries = OrganizationSummary[];
export interface OrganizationSummary {
/**
* The identifier associated with the organization.
*/
OrganizationId?: OrganizationId;
/**
* The alias associated with the organization.
*/
Alias?: OrganizationName;
/**
* The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.
*/
ErrorMessage?: String;
/**
* The state associated with the organization.
*/
State?: String;
}
export type Password = string;
export type Percentage = number;
export interface Permission {
/**
* The identifier of the user, group, or resource to which the permissions are granted.
*/
GranteeId: WorkMailIdentifier;
/**
* The type of user, group, or resource referred to in GranteeId.
*/
GranteeType: MemberType;
/**
* The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
*/
PermissionValues: PermissionValues;
}
export type PermissionType = "FULL_ACCESS"|"SEND_AS"|"SEND_ON_BEHALF"|string;
export type PermissionValues = PermissionType[];
export type Permissions = Permission[];
export type PolicyDescription = string;
export interface PutAccessControlRuleRequest {
/**
* The rule name.
*/
Name: AccessControlRuleName;
/**
* The rule effect.
*/
Effect: AccessControlRuleEffect;
/**
* The rule description.
*/
Description: AccessControlRuleDescription;
/**
* IPv4 CIDR ranges to include in the rule.
*/
IpRanges?: IpRangeList;
/**
* IPv4 CIDR ranges to exclude from the rule.
*/
NotIpRanges?: IpRangeList;
/**
* Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
*/
Actions?: ActionsList;
/**
* Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
*/
NotActions?: ActionsList;
/**
* User IDs to include in the rule.
*/
UserIds?: UserIdList;
/**
* User IDs to exclude from the rule.
*/
NotUserIds?: UserIdList;
/**
* The identifier of the organization.
*/
OrganizationId: OrganizationId;
}
export interface PutAccessControlRuleResponse {
}
export interface PutMailboxPermissionsRequest {
/**
* The identifier of the organization under which the user, group, or resource exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the user, group, or resource for which to update mailbox permissions.
*/
EntityId: WorkMailIdentifier;
/**
* The identifier of the user, group, or resource to which to grant the permissions.
*/
GranteeId: WorkMailIdentifier;
/**
* The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
*/
PermissionValues: PermissionValues;
}
export interface PutMailboxPermissionsResponse {
}
export interface PutRetentionPolicyRequest {
/**
* The organization ID.
*/
OrganizationId: OrganizationId;
/**
* The retention policy ID.
*/
Id?: ShortString;
/**
* The retention policy name.
*/
Name: ShortString;
/**
* The retention policy description.
*/
Description?: PolicyDescription;
/**
* The retention policy folder configurations.
*/
FolderConfigurations: FolderConfigurations;
}
export interface PutRetentionPolicyResponse {
}
export interface RegisterToWorkMailRequest {
/**
* The identifier for the organization under which the user, group, or resource exists.
*/
OrganizationId: OrganizationId;
/**
* The identifier for the user, group, or resource to be updated.
*/
EntityId: WorkMailIdentifier;
/**
* The email for the user, group, or resource to be updated.
*/
Email: EmailAddress;
}
export interface RegisterToWorkMailResponse {
}
export interface ResetPasswordRequest {
/**
* The identifier of the organization that contains the user for which the password is reset.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the user for whom the password is reset.
*/
UserId: WorkMailIdentifier;
/**
* The new password for the user.
*/
Password: Password;
}
export interface ResetPasswordResponse {
}
export interface Resource {
/**
* The identifier of the resource.
*/
Id?: WorkMailIdentifier;
/**
* The email of the resource.
*/
Email?: EmailAddress;
/**
* The name of the resource.
*/
Name?: ResourceName;
/**
* The type of the resource: equipment or room.
*/
Type?: ResourceType;
/**
* The state of the resource, which can be ENABLED, DISABLED, or DELETED.
*/
State?: EntityState;
/**
* The date indicating when the resource was enabled for Amazon WorkMail use.
*/
EnabledDate?: Timestamp;
/**
* The date indicating when the resource was disabled from Amazon WorkMail use.
*/
DisabledDate?: Timestamp;
}
export type ResourceDelegates = Delegate[];
export type ResourceId = string;
export type ResourceName = string;
export type ResourceType = "ROOM"|"EQUIPMENT"|string;
export type Resources = Resource[];
export type RetentionAction = "NONE"|"DELETE"|"PERMANENTLY_DELETE"|string;
export type RetentionPeriod = number;
export type RoleArn = string;
export type S3BucketName = string;
export type S3ObjectKey = string;
export type ShortString = string;
export interface StartMailboxExportJobRequest {
/**
* The idempotency token for the client request.
*/
ClientToken: IdempotencyClientToken;
/**
* The identifier associated with the organization.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the user or resource associated with the mailbox.
*/
EntityId: WorkMailIdentifier;
/**
* The mailbox export job description.
*/
Description?: Description;
/**
* The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
*/
RoleArn: RoleArn;
/**
* The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
*/
KmsKeyArn: KmsKeyArn;
/**
* The name of the S3 bucket.
*/
S3BucketName: S3BucketName;
/**
* The S3 bucket prefix.
*/
S3Prefix: S3ObjectKey;
}
export interface StartMailboxExportJobResponse {
/**
* The job ID.
*/
JobId?: MailboxExportJobId;
}
export type String = string;
export interface Tag {
/**
* The key of the tag.
*/
Key: TagKey;
/**
* The value of the tag.
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The resource ARN.
*/
ResourceARN: AmazonResourceName;
/**
* The tag key-value pairs.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Timestamp = Date;
export interface UntagResourceRequest {
/**
* The resource ARN.
*/
ResourceARN: AmazonResourceName;
/**
* The tag keys.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateMailboxQuotaRequest {
/**
* The identifier for the organization that contains the user for whom to update the mailbox quota.
*/
OrganizationId: OrganizationId;
/**
* The identifer for the user for whom to update the mailbox quota.
*/
UserId: WorkMailIdentifier;
/**
* The updated mailbox quota, in MB, for the specified user.
*/
MailboxQuota: MailboxQuota;
}
export interface UpdateMailboxQuotaResponse {
}
export interface UpdatePrimaryEmailAddressRequest {
/**
* The organization that contains the user, group, or resource to update.
*/
OrganizationId: OrganizationId;
/**
* The user, group, or resource to update.
*/
EntityId: WorkMailIdentifier;
/**
* The value of the email to be updated as primary.
*/
Email: EmailAddress;
}
export interface UpdatePrimaryEmailAddressResponse {
}
export interface UpdateResourceRequest {
/**
* The identifier associated with the organization for which the resource is updated.
*/
OrganizationId: OrganizationId;
/**
* The identifier of the resource to be updated.
*/
ResourceId: ResourceId;
/**
* The name of the resource to be updated.
*/
Name?: ResourceName;
/**
* The resource's booking options to be updated.
*/
BookingOptions?: BookingOptions;
}
export interface UpdateResourceResponse {
}
export interface User {
/**
* The identifier of the user.
*/
Id?: WorkMailIdentifier;
/**
* The email of the user.
*/
Email?: EmailAddress;
/**
* The name of the user.
*/
Name?: UserName;
/**
* The display name of the user.
*/
DisplayName?: String;
/**
* The state of the user, which can be ENABLED, DISABLED, or DELETED.
*/
State?: EntityState;
/**
* The role of the user.
*/
UserRole?: UserRole;
/**
* The date indicating when the user was enabled for Amazon WorkMail use.
*/
EnabledDate?: Timestamp;
/**
* The date indicating when the user was disabled from Amazon WorkMail use.
*/
DisabledDate?: Timestamp;
}
export type UserIdList = WorkMailIdentifier[];
export type UserName = string;
export type UserRole = "USER"|"RESOURCE"|"SYSTEM_USER"|string;
export type Users = User[];
export type WorkMailIdentifier = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-10-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the WorkMail client.
*/
export import Types = WorkMail;
}
export = WorkMail;