@aws-sdk/client-workmail 3.378.0 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -18,58 +18,71 @@ export type AccessControlRuleEffect = (typeof AccessControlRuleEffect)[keyof typ
|
|
|
18
18
|
*/
|
|
19
19
|
export interface AccessControlRule {
|
|
20
20
|
/**
|
|
21
|
+
* @public
|
|
21
22
|
* <p>The rule name.</p>
|
|
22
23
|
*/
|
|
23
24
|
Name?: string;
|
|
24
25
|
/**
|
|
26
|
+
* @public
|
|
25
27
|
* <p>The rule effect.</p>
|
|
26
28
|
*/
|
|
27
29
|
Effect?: AccessControlRuleEffect | string;
|
|
28
30
|
/**
|
|
31
|
+
* @public
|
|
29
32
|
* <p>The rule description.</p>
|
|
30
33
|
*/
|
|
31
34
|
Description?: string;
|
|
32
35
|
/**
|
|
36
|
+
* @public
|
|
33
37
|
* <p>IPv4 CIDR ranges to include in the rule.</p>
|
|
34
38
|
*/
|
|
35
39
|
IpRanges?: string[];
|
|
36
40
|
/**
|
|
41
|
+
* @public
|
|
37
42
|
* <p>IPv4 CIDR ranges to exclude from the rule.</p>
|
|
38
43
|
*/
|
|
39
44
|
NotIpRanges?: string[];
|
|
40
45
|
/**
|
|
46
|
+
* @public
|
|
41
47
|
* <p>Access protocol actions to include in the rule. Valid values include
|
|
42
48
|
* <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
|
|
43
49
|
* <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
|
|
44
50
|
*/
|
|
45
51
|
Actions?: string[];
|
|
46
52
|
/**
|
|
53
|
+
* @public
|
|
47
54
|
* <p>Access protocol actions to exclude from the rule. Valid values include
|
|
48
55
|
* <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
|
|
49
56
|
* <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
|
|
50
57
|
*/
|
|
51
58
|
NotActions?: string[];
|
|
52
59
|
/**
|
|
60
|
+
* @public
|
|
53
61
|
* <p>User IDs to include in the rule.</p>
|
|
54
62
|
*/
|
|
55
63
|
UserIds?: string[];
|
|
56
64
|
/**
|
|
65
|
+
* @public
|
|
57
66
|
* <p>User IDs to exclude from the rule.</p>
|
|
58
67
|
*/
|
|
59
68
|
NotUserIds?: string[];
|
|
60
69
|
/**
|
|
70
|
+
* @public
|
|
61
71
|
* <p>The date that the rule was created.</p>
|
|
62
72
|
*/
|
|
63
73
|
DateCreated?: Date;
|
|
64
74
|
/**
|
|
75
|
+
* @public
|
|
65
76
|
* <p>The date that the rule was modified.</p>
|
|
66
77
|
*/
|
|
67
78
|
DateModified?: Date;
|
|
68
79
|
/**
|
|
80
|
+
* @public
|
|
69
81
|
* <p>Impersonation role IDs to include in the rule.</p>
|
|
70
82
|
*/
|
|
71
83
|
ImpersonationRoleIds?: string[];
|
|
72
84
|
/**
|
|
85
|
+
* @public
|
|
73
86
|
* <p>Impersonation role IDs to exclude from the rule.</p>
|
|
74
87
|
*/
|
|
75
88
|
NotImpersonationRoleIds?: string[];
|
|
@@ -91,14 +104,17 @@ export type AccessEffect = (typeof AccessEffect)[keyof typeof AccessEffect];
|
|
|
91
104
|
*/
|
|
92
105
|
export interface AssociateDelegateToResourceRequest {
|
|
93
106
|
/**
|
|
107
|
+
* @public
|
|
94
108
|
* <p>The organization under which the resource exists.</p>
|
|
95
109
|
*/
|
|
96
110
|
OrganizationId: string | undefined;
|
|
97
111
|
/**
|
|
112
|
+
* @public
|
|
98
113
|
* <p>The resource for which members (users or groups) are associated.</p>
|
|
99
114
|
*/
|
|
100
115
|
ResourceId: string | undefined;
|
|
101
116
|
/**
|
|
117
|
+
* @public
|
|
102
118
|
* <p>The member (user or group) to associate to the resource.</p>
|
|
103
119
|
*/
|
|
104
120
|
EntityId: string | undefined;
|
|
@@ -182,14 +198,17 @@ export declare class OrganizationStateException extends __BaseException {
|
|
|
182
198
|
*/
|
|
183
199
|
export interface AssociateMemberToGroupRequest {
|
|
184
200
|
/**
|
|
201
|
+
* @public
|
|
185
202
|
* <p>The organization under which the group exists.</p>
|
|
186
203
|
*/
|
|
187
204
|
OrganizationId: string | undefined;
|
|
188
205
|
/**
|
|
206
|
+
* @public
|
|
189
207
|
* <p>The group to which the member (user or group) is associated.</p>
|
|
190
208
|
*/
|
|
191
209
|
GroupId: string | undefined;
|
|
192
210
|
/**
|
|
211
|
+
* @public
|
|
193
212
|
* <p>The member (user or group) to associate to the group.</p>
|
|
194
213
|
*/
|
|
195
214
|
MemberId: string | undefined;
|
|
@@ -243,10 +262,12 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
243
262
|
*/
|
|
244
263
|
export interface AssumeImpersonationRoleRequest {
|
|
245
264
|
/**
|
|
265
|
+
* @public
|
|
246
266
|
* <p>The WorkMail organization under which the impersonation role will be assumed.</p>
|
|
247
267
|
*/
|
|
248
268
|
OrganizationId: string | undefined;
|
|
249
269
|
/**
|
|
270
|
+
* @public
|
|
250
271
|
* <p>The impersonation role ID to assume.</p>
|
|
251
272
|
*/
|
|
252
273
|
ImpersonationRoleId: string | undefined;
|
|
@@ -256,10 +277,12 @@ export interface AssumeImpersonationRoleRequest {
|
|
|
256
277
|
*/
|
|
257
278
|
export interface AssumeImpersonationRoleResponse {
|
|
258
279
|
/**
|
|
280
|
+
* @public
|
|
259
281
|
* <p>The authentication token for the impersonation role.</p>
|
|
260
282
|
*/
|
|
261
283
|
Token?: string;
|
|
262
284
|
/**
|
|
285
|
+
* @public
|
|
263
286
|
* <p>The authentication token's validity, in seconds.</p>
|
|
264
287
|
*/
|
|
265
288
|
ExpiresIn?: number;
|
|
@@ -284,10 +307,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
284
307
|
*/
|
|
285
308
|
export interface RedactedEwsAvailabilityProvider {
|
|
286
309
|
/**
|
|
310
|
+
* @public
|
|
287
311
|
* <p>The endpoint of the remote EWS server.</p>
|
|
288
312
|
*/
|
|
289
313
|
EwsEndpoint?: string;
|
|
290
314
|
/**
|
|
315
|
+
* @public
|
|
291
316
|
* <p>The username used to authenticate the remote EWS server.</p>
|
|
292
317
|
*/
|
|
293
318
|
EwsUsername?: string;
|
|
@@ -298,6 +323,7 @@ export interface RedactedEwsAvailabilityProvider {
|
|
|
298
323
|
*/
|
|
299
324
|
export interface LambdaAvailabilityProvider {
|
|
300
325
|
/**
|
|
326
|
+
* @public
|
|
301
327
|
* <p>The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.</p>
|
|
302
328
|
*/
|
|
303
329
|
LambdaArn: string | undefined;
|
|
@@ -321,28 +347,34 @@ export type AvailabilityProviderType = (typeof AvailabilityProviderType)[keyof t
|
|
|
321
347
|
*/
|
|
322
348
|
export interface AvailabilityConfiguration {
|
|
323
349
|
/**
|
|
350
|
+
* @public
|
|
324
351
|
* <p>Displays the domain to which the provider applies.</p>
|
|
325
352
|
*/
|
|
326
353
|
DomainName?: string;
|
|
327
354
|
/**
|
|
355
|
+
* @public
|
|
328
356
|
* <p>Displays the provider type that applies to this domain.</p>
|
|
329
357
|
*/
|
|
330
358
|
ProviderType?: AvailabilityProviderType | string;
|
|
331
359
|
/**
|
|
360
|
+
* @public
|
|
332
361
|
* <p>If <code>ProviderType</code> is <code>EWS</code>, then this field contains
|
|
333
362
|
* <code>RedactedEwsAvailabilityProvider</code>. Otherwise, it is not required.</p>
|
|
334
363
|
*/
|
|
335
364
|
EwsProvider?: RedactedEwsAvailabilityProvider;
|
|
336
365
|
/**
|
|
366
|
+
* @public
|
|
337
367
|
* <p>If ProviderType is <code>LAMBDA</code> then this field contains
|
|
338
368
|
* <code>LambdaAvailabilityProvider</code>. Otherwise, it is not required.</p>
|
|
339
369
|
*/
|
|
340
370
|
LambdaProvider?: LambdaAvailabilityProvider;
|
|
341
371
|
/**
|
|
372
|
+
* @public
|
|
342
373
|
* <p>The date and time at which the availability configuration was created.</p>
|
|
343
374
|
*/
|
|
344
375
|
DateCreated?: Date;
|
|
345
376
|
/**
|
|
377
|
+
* @public
|
|
346
378
|
* <p>The date and time at which the availability configuration was last modified.</p>
|
|
347
379
|
*/
|
|
348
380
|
DateModified?: Date;
|
|
@@ -354,15 +386,18 @@ export interface AvailabilityConfiguration {
|
|
|
354
386
|
*/
|
|
355
387
|
export interface BookingOptions {
|
|
356
388
|
/**
|
|
389
|
+
* @public
|
|
357
390
|
* <p>The resource's ability to automatically reply to requests. If disabled, delegates
|
|
358
391
|
* must be associated to the resource.</p>
|
|
359
392
|
*/
|
|
360
393
|
AutoAcceptRequests?: boolean;
|
|
361
394
|
/**
|
|
395
|
+
* @public
|
|
362
396
|
* <p>The resource's ability to automatically decline any recurring requests.</p>
|
|
363
397
|
*/
|
|
364
398
|
AutoDeclineRecurringRequests?: boolean;
|
|
365
399
|
/**
|
|
400
|
+
* @public
|
|
366
401
|
* <p>The resource's ability to automatically decline any conflicting requests.</p>
|
|
367
402
|
*/
|
|
368
403
|
AutoDeclineConflictingRequests?: boolean;
|
|
@@ -372,14 +407,17 @@ export interface BookingOptions {
|
|
|
372
407
|
*/
|
|
373
408
|
export interface CancelMailboxExportJobRequest {
|
|
374
409
|
/**
|
|
410
|
+
* @public
|
|
375
411
|
* <p>The idempotency token for the client request.</p>
|
|
376
412
|
*/
|
|
377
413
|
ClientToken?: string;
|
|
378
414
|
/**
|
|
415
|
+
* @public
|
|
379
416
|
* <p>The job ID.</p>
|
|
380
417
|
*/
|
|
381
418
|
JobId: string | undefined;
|
|
382
419
|
/**
|
|
420
|
+
* @public
|
|
383
421
|
* <p>The organization ID.</p>
|
|
384
422
|
*/
|
|
385
423
|
OrganizationId: string | undefined;
|
|
@@ -394,14 +432,17 @@ export interface CancelMailboxExportJobResponse {
|
|
|
394
432
|
*/
|
|
395
433
|
export interface CreateAliasRequest {
|
|
396
434
|
/**
|
|
435
|
+
* @public
|
|
397
436
|
* <p>The organization under which the member (user or group) exists.</p>
|
|
398
437
|
*/
|
|
399
438
|
OrganizationId: string | undefined;
|
|
400
439
|
/**
|
|
440
|
+
* @public
|
|
401
441
|
* <p>The member (user or group) to which this alias is added.</p>
|
|
402
442
|
*/
|
|
403
443
|
EntityId: string | undefined;
|
|
404
444
|
/**
|
|
445
|
+
* @public
|
|
405
446
|
* <p>The alias to add to the member set.</p>
|
|
406
447
|
*/
|
|
407
448
|
Alias: string | undefined;
|
|
@@ -471,14 +512,17 @@ export declare class MailDomainStateException extends __BaseException {
|
|
|
471
512
|
*/
|
|
472
513
|
export interface EwsAvailabilityProvider {
|
|
473
514
|
/**
|
|
515
|
+
* @public
|
|
474
516
|
* <p>The endpoint of the remote EWS server.</p>
|
|
475
517
|
*/
|
|
476
518
|
EwsEndpoint: string | undefined;
|
|
477
519
|
/**
|
|
520
|
+
* @public
|
|
478
521
|
* <p>The username used to authenticate the remote EWS server.</p>
|
|
479
522
|
*/
|
|
480
523
|
EwsUsername: string | undefined;
|
|
481
524
|
/**
|
|
525
|
+
* @public
|
|
482
526
|
* <p>The password used to authenticate the remote EWS server.</p>
|
|
483
527
|
*/
|
|
484
528
|
EwsPassword: string | undefined;
|
|
@@ -488,22 +532,27 @@ export interface EwsAvailabilityProvider {
|
|
|
488
532
|
*/
|
|
489
533
|
export interface CreateAvailabilityConfigurationRequest {
|
|
490
534
|
/**
|
|
535
|
+
* @public
|
|
491
536
|
* <p>An idempotent token that ensures that an API request is executed only once.</p>
|
|
492
537
|
*/
|
|
493
538
|
ClientToken?: string;
|
|
494
539
|
/**
|
|
540
|
+
* @public
|
|
495
541
|
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be created.</p>
|
|
496
542
|
*/
|
|
497
543
|
OrganizationId: string | undefined;
|
|
498
544
|
/**
|
|
545
|
+
* @public
|
|
499
546
|
* <p>The domain to which the provider applies.</p>
|
|
500
547
|
*/
|
|
501
548
|
DomainName: string | undefined;
|
|
502
549
|
/**
|
|
550
|
+
* @public
|
|
503
551
|
* <p>Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>.</p>
|
|
504
552
|
*/
|
|
505
553
|
EwsProvider?: EwsAvailabilityProvider;
|
|
506
554
|
/**
|
|
555
|
+
* @public
|
|
507
556
|
* <p>Lambda availability provider definition. The request must contain exactly one provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>.</p>
|
|
508
557
|
*/
|
|
509
558
|
LambdaProvider?: LambdaAvailabilityProvider;
|
|
@@ -531,10 +580,12 @@ export declare class NameAvailabilityException extends __BaseException {
|
|
|
531
580
|
*/
|
|
532
581
|
export interface CreateGroupRequest {
|
|
533
582
|
/**
|
|
583
|
+
* @public
|
|
534
584
|
* <p>The organization under which the group is to be created.</p>
|
|
535
585
|
*/
|
|
536
586
|
OrganizationId: string | undefined;
|
|
537
587
|
/**
|
|
588
|
+
* @public
|
|
538
589
|
* <p>The name of the group.</p>
|
|
539
590
|
*/
|
|
540
591
|
Name: string | undefined;
|
|
@@ -544,6 +595,7 @@ export interface CreateGroupRequest {
|
|
|
544
595
|
*/
|
|
545
596
|
export interface CreateGroupResponse {
|
|
546
597
|
/**
|
|
598
|
+
* @public
|
|
547
599
|
* <p>The identifier of the group.</p>
|
|
548
600
|
*/
|
|
549
601
|
GroupId?: string;
|
|
@@ -567,27 +619,33 @@ export declare class ReservedNameException extends __BaseException {
|
|
|
567
619
|
*/
|
|
568
620
|
export interface ImpersonationRule {
|
|
569
621
|
/**
|
|
622
|
+
* @public
|
|
570
623
|
* <p>The identifier of the rule.</p>
|
|
571
624
|
*/
|
|
572
625
|
ImpersonationRuleId: string | undefined;
|
|
573
626
|
/**
|
|
627
|
+
* @public
|
|
574
628
|
* <p>The rule name.</p>
|
|
575
629
|
*/
|
|
576
630
|
Name?: string;
|
|
577
631
|
/**
|
|
632
|
+
* @public
|
|
578
633
|
* <p>The rule description.</p>
|
|
579
634
|
*/
|
|
580
635
|
Description?: string;
|
|
581
636
|
/**
|
|
637
|
+
* @public
|
|
582
638
|
* <p>The effect of the rule when it matches the input. Allowed effect values are
|
|
583
639
|
* <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
584
640
|
*/
|
|
585
641
|
Effect: AccessEffect | string | undefined;
|
|
586
642
|
/**
|
|
643
|
+
* @public
|
|
587
644
|
* <p>A list of user IDs that match the rule.</p>
|
|
588
645
|
*/
|
|
589
646
|
TargetUsers?: string[];
|
|
590
647
|
/**
|
|
648
|
+
* @public
|
|
591
649
|
* <p>A list of user IDs that don't match the rule.</p>
|
|
592
650
|
*/
|
|
593
651
|
NotTargetUsers?: string[];
|
|
@@ -609,27 +667,33 @@ export type ImpersonationRoleType = (typeof ImpersonationRoleType)[keyof typeof
|
|
|
609
667
|
*/
|
|
610
668
|
export interface CreateImpersonationRoleRequest {
|
|
611
669
|
/**
|
|
670
|
+
* @public
|
|
612
671
|
* <p>The idempotency token for the client request.</p>
|
|
613
672
|
*/
|
|
614
673
|
ClientToken?: string;
|
|
615
674
|
/**
|
|
675
|
+
* @public
|
|
616
676
|
* <p>The WorkMail organization to create the new impersonation role within.</p>
|
|
617
677
|
*/
|
|
618
678
|
OrganizationId: string | undefined;
|
|
619
679
|
/**
|
|
680
|
+
* @public
|
|
620
681
|
* <p>The name of the new impersonation role.</p>
|
|
621
682
|
*/
|
|
622
683
|
Name: string | undefined;
|
|
623
684
|
/**
|
|
685
|
+
* @public
|
|
624
686
|
* <p>The impersonation role's type. The available impersonation role types are
|
|
625
687
|
* <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.</p>
|
|
626
688
|
*/
|
|
627
689
|
Type: ImpersonationRoleType | string | undefined;
|
|
628
690
|
/**
|
|
691
|
+
* @public
|
|
629
692
|
* <p>The description of the new impersonation role.</p>
|
|
630
693
|
*/
|
|
631
694
|
Description?: string;
|
|
632
695
|
/**
|
|
696
|
+
* @public
|
|
633
697
|
* <p>The list of rules for the impersonation role.</p>
|
|
634
698
|
*/
|
|
635
699
|
Rules: ImpersonationRule[] | undefined;
|
|
@@ -639,6 +703,7 @@ export interface CreateImpersonationRoleRequest {
|
|
|
639
703
|
*/
|
|
640
704
|
export interface CreateImpersonationRoleResponse {
|
|
641
705
|
/**
|
|
706
|
+
* @public
|
|
642
707
|
* <p>The new impersonation role ID.</p>
|
|
643
708
|
*/
|
|
644
709
|
ImpersonationRoleId?: string;
|
|
@@ -660,54 +725,67 @@ export type MobileDeviceAccessRuleEffect = (typeof MobileDeviceAccessRuleEffect)
|
|
|
660
725
|
*/
|
|
661
726
|
export interface CreateMobileDeviceAccessRuleRequest {
|
|
662
727
|
/**
|
|
728
|
+
* @public
|
|
663
729
|
* <p>The WorkMail organization under which the rule will be created.</p>
|
|
664
730
|
*/
|
|
665
731
|
OrganizationId: string | undefined;
|
|
666
732
|
/**
|
|
733
|
+
* @public
|
|
667
734
|
* <p>The idempotency token for the client request.</p>
|
|
668
735
|
*/
|
|
669
736
|
ClientToken?: string;
|
|
670
737
|
/**
|
|
738
|
+
* @public
|
|
671
739
|
* <p>The rule name.</p>
|
|
672
740
|
*/
|
|
673
741
|
Name: string | undefined;
|
|
674
742
|
/**
|
|
743
|
+
* @public
|
|
675
744
|
* <p>The rule description.</p>
|
|
676
745
|
*/
|
|
677
746
|
Description?: string;
|
|
678
747
|
/**
|
|
748
|
+
* @public
|
|
679
749
|
* <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
680
750
|
*/
|
|
681
751
|
Effect: MobileDeviceAccessRuleEffect | string | undefined;
|
|
682
752
|
/**
|
|
753
|
+
* @public
|
|
683
754
|
* <p>Device types that the rule will match.</p>
|
|
684
755
|
*/
|
|
685
756
|
DeviceTypes?: string[];
|
|
686
757
|
/**
|
|
758
|
+
* @public
|
|
687
759
|
* <p>Device types that the rule <b>will not</b> match. All other device types will match.</p>
|
|
688
760
|
*/
|
|
689
761
|
NotDeviceTypes?: string[];
|
|
690
762
|
/**
|
|
763
|
+
* @public
|
|
691
764
|
* <p>Device models that the rule will match.</p>
|
|
692
765
|
*/
|
|
693
766
|
DeviceModels?: string[];
|
|
694
767
|
/**
|
|
768
|
+
* @public
|
|
695
769
|
* <p>Device models that the rule <b>will not</b> match. All other device models will match.</p>
|
|
696
770
|
*/
|
|
697
771
|
NotDeviceModels?: string[];
|
|
698
772
|
/**
|
|
773
|
+
* @public
|
|
699
774
|
* <p>Device operating systems that the rule will match.</p>
|
|
700
775
|
*/
|
|
701
776
|
DeviceOperatingSystems?: string[];
|
|
702
777
|
/**
|
|
778
|
+
* @public
|
|
703
779
|
* <p>Device operating systems that the rule <b>will not</b> match. All other device operating systems will match.</p>
|
|
704
780
|
*/
|
|
705
781
|
NotDeviceOperatingSystems?: string[];
|
|
706
782
|
/**
|
|
783
|
+
* @public
|
|
707
784
|
* <p>Device user agents that the rule will match.</p>
|
|
708
785
|
*/
|
|
709
786
|
DeviceUserAgents?: string[];
|
|
710
787
|
/**
|
|
788
|
+
* @public
|
|
711
789
|
* <p>Device user agents that the rule <b>will not</b> match. All other device user agents will match.</p>
|
|
712
790
|
*/
|
|
713
791
|
NotDeviceUserAgents?: string[];
|
|
@@ -717,6 +795,7 @@ export interface CreateMobileDeviceAccessRuleRequest {
|
|
|
717
795
|
*/
|
|
718
796
|
export interface CreateMobileDeviceAccessRuleResponse {
|
|
719
797
|
/**
|
|
798
|
+
* @public
|
|
720
799
|
* <p>The identifier for the newly created mobile device access rule.</p>
|
|
721
800
|
*/
|
|
722
801
|
MobileDeviceAccessRuleId?: string;
|
|
@@ -728,10 +807,12 @@ export interface CreateMobileDeviceAccessRuleResponse {
|
|
|
728
807
|
*/
|
|
729
808
|
export interface Domain {
|
|
730
809
|
/**
|
|
810
|
+
* @public
|
|
731
811
|
* <p>The fully qualified domain name.</p>
|
|
732
812
|
*/
|
|
733
813
|
DomainName?: string;
|
|
734
814
|
/**
|
|
815
|
+
* @public
|
|
735
816
|
* <p>The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.</p>
|
|
736
817
|
*/
|
|
737
818
|
HostedZoneId?: string;
|
|
@@ -741,26 +822,32 @@ export interface Domain {
|
|
|
741
822
|
*/
|
|
742
823
|
export interface CreateOrganizationRequest {
|
|
743
824
|
/**
|
|
825
|
+
* @public
|
|
744
826
|
* <p>The AWS Directory Service directory ID.</p>
|
|
745
827
|
*/
|
|
746
828
|
DirectoryId?: string;
|
|
747
829
|
/**
|
|
830
|
+
* @public
|
|
748
831
|
* <p>The organization alias.</p>
|
|
749
832
|
*/
|
|
750
833
|
Alias: string | undefined;
|
|
751
834
|
/**
|
|
835
|
+
* @public
|
|
752
836
|
* <p>The idempotency token associated with the request.</p>
|
|
753
837
|
*/
|
|
754
838
|
ClientToken?: string;
|
|
755
839
|
/**
|
|
840
|
+
* @public
|
|
756
841
|
* <p>The email domains to associate with the organization.</p>
|
|
757
842
|
*/
|
|
758
843
|
Domains?: Domain[];
|
|
759
844
|
/**
|
|
845
|
+
* @public
|
|
760
846
|
* <p>The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.</p>
|
|
761
847
|
*/
|
|
762
848
|
KmsKeyArn?: string;
|
|
763
849
|
/**
|
|
850
|
+
* @public
|
|
764
851
|
* <p>When <code>true</code>, allows organization interoperability between WorkMail and
|
|
765
852
|
* Microsoft Exchange. If <code>true</code>, you must include a AD Connector directory ID in
|
|
766
853
|
* the request.</p>
|
|
@@ -772,6 +859,7 @@ export interface CreateOrganizationRequest {
|
|
|
772
859
|
*/
|
|
773
860
|
export interface CreateOrganizationResponse {
|
|
774
861
|
/**
|
|
862
|
+
* @public
|
|
775
863
|
* <p>The organization ID.</p>
|
|
776
864
|
*/
|
|
777
865
|
OrganizationId?: string;
|
|
@@ -806,15 +894,18 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
|
806
894
|
*/
|
|
807
895
|
export interface CreateResourceRequest {
|
|
808
896
|
/**
|
|
897
|
+
* @public
|
|
809
898
|
* <p>The identifier associated with the organization for which the resource is
|
|
810
899
|
* created.</p>
|
|
811
900
|
*/
|
|
812
901
|
OrganizationId: string | undefined;
|
|
813
902
|
/**
|
|
903
|
+
* @public
|
|
814
904
|
* <p>The name of the new resource.</p>
|
|
815
905
|
*/
|
|
816
906
|
Name: string | undefined;
|
|
817
907
|
/**
|
|
908
|
+
* @public
|
|
818
909
|
* <p>The type of the new resource. The available types are <code>equipment</code> and
|
|
819
910
|
* <code>room</code>.</p>
|
|
820
911
|
*/
|
|
@@ -825,6 +916,7 @@ export interface CreateResourceRequest {
|
|
|
825
916
|
*/
|
|
826
917
|
export interface CreateResourceResponse {
|
|
827
918
|
/**
|
|
919
|
+
* @public
|
|
828
920
|
* <p>The identifier of the new resource.</p>
|
|
829
921
|
*/
|
|
830
922
|
ResourceId?: string;
|
|
@@ -834,18 +926,22 @@ export interface CreateResourceResponse {
|
|
|
834
926
|
*/
|
|
835
927
|
export interface CreateUserRequest {
|
|
836
928
|
/**
|
|
929
|
+
* @public
|
|
837
930
|
* <p>The identifier of the organization for which the user is created.</p>
|
|
838
931
|
*/
|
|
839
932
|
OrganizationId: string | undefined;
|
|
840
933
|
/**
|
|
934
|
+
* @public
|
|
841
935
|
* <p>The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.</p>
|
|
842
936
|
*/
|
|
843
937
|
Name: string | undefined;
|
|
844
938
|
/**
|
|
939
|
+
* @public
|
|
845
940
|
* <p>The display name for the new user.</p>
|
|
846
941
|
*/
|
|
847
942
|
DisplayName: string | undefined;
|
|
848
943
|
/**
|
|
944
|
+
* @public
|
|
849
945
|
* <p>The password for the new user.</p>
|
|
850
946
|
*/
|
|
851
947
|
Password: string | undefined;
|
|
@@ -855,6 +951,7 @@ export interface CreateUserRequest {
|
|
|
855
951
|
*/
|
|
856
952
|
export interface CreateUserResponse {
|
|
857
953
|
/**
|
|
954
|
+
* @public
|
|
858
955
|
* <p>The identifier for the new user.</p>
|
|
859
956
|
*/
|
|
860
957
|
UserId?: string;
|
|
@@ -892,10 +989,12 @@ export type MemberType = (typeof MemberType)[keyof typeof MemberType];
|
|
|
892
989
|
*/
|
|
893
990
|
export interface Delegate {
|
|
894
991
|
/**
|
|
992
|
+
* @public
|
|
895
993
|
* <p>The identifier for the user or group associated as the resource's delegate.</p>
|
|
896
994
|
*/
|
|
897
995
|
Id: string | undefined;
|
|
898
996
|
/**
|
|
997
|
+
* @public
|
|
899
998
|
* <p>The type of the delegate: user or group.</p>
|
|
900
999
|
*/
|
|
901
1000
|
Type: MemberType | string | undefined;
|
|
@@ -905,10 +1004,12 @@ export interface Delegate {
|
|
|
905
1004
|
*/
|
|
906
1005
|
export interface DeleteAccessControlRuleRequest {
|
|
907
1006
|
/**
|
|
1007
|
+
* @public
|
|
908
1008
|
* <p>The identifier for the organization.</p>
|
|
909
1009
|
*/
|
|
910
1010
|
OrganizationId: string | undefined;
|
|
911
1011
|
/**
|
|
1012
|
+
* @public
|
|
912
1013
|
* <p>The name of the access control rule.</p>
|
|
913
1014
|
*/
|
|
914
1015
|
Name: string | undefined;
|
|
@@ -923,15 +1024,18 @@ export interface DeleteAccessControlRuleResponse {
|
|
|
923
1024
|
*/
|
|
924
1025
|
export interface DeleteAliasRequest {
|
|
925
1026
|
/**
|
|
1027
|
+
* @public
|
|
926
1028
|
* <p>The identifier for the organization under which the user exists.</p>
|
|
927
1029
|
*/
|
|
928
1030
|
OrganizationId: string | undefined;
|
|
929
1031
|
/**
|
|
1032
|
+
* @public
|
|
930
1033
|
* <p>The identifier for the member (user or group) from which to have the aliases
|
|
931
1034
|
* removed.</p>
|
|
932
1035
|
*/
|
|
933
1036
|
EntityId: string | undefined;
|
|
934
1037
|
/**
|
|
1038
|
+
* @public
|
|
935
1039
|
* <p>The aliases to be removed from the user's set of aliases. Duplicate entries in the
|
|
936
1040
|
* list are collapsed into single entries (the list is transformed into a set).</p>
|
|
937
1041
|
*/
|
|
@@ -947,10 +1051,12 @@ export interface DeleteAliasResponse {
|
|
|
947
1051
|
*/
|
|
948
1052
|
export interface DeleteAvailabilityConfigurationRequest {
|
|
949
1053
|
/**
|
|
1054
|
+
* @public
|
|
950
1055
|
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be deleted.</p>
|
|
951
1056
|
*/
|
|
952
1057
|
OrganizationId: string | undefined;
|
|
953
1058
|
/**
|
|
1059
|
+
* @public
|
|
954
1060
|
* <p>The domain for which the <code>AvailabilityConfiguration</code> will be deleted.</p>
|
|
955
1061
|
*/
|
|
956
1062
|
DomainName: string | undefined;
|
|
@@ -965,6 +1071,7 @@ export interface DeleteAvailabilityConfigurationResponse {
|
|
|
965
1071
|
*/
|
|
966
1072
|
export interface DeleteEmailMonitoringConfigurationRequest {
|
|
967
1073
|
/**
|
|
1074
|
+
* @public
|
|
968
1075
|
* <p>The ID of the organization from which the email monitoring configuration is deleted.</p>
|
|
969
1076
|
*/
|
|
970
1077
|
OrganizationId: string | undefined;
|
|
@@ -979,10 +1086,12 @@ export interface DeleteEmailMonitoringConfigurationResponse {
|
|
|
979
1086
|
*/
|
|
980
1087
|
export interface DeleteGroupRequest {
|
|
981
1088
|
/**
|
|
1089
|
+
* @public
|
|
982
1090
|
* <p>The organization that contains the group.</p>
|
|
983
1091
|
*/
|
|
984
1092
|
OrganizationId: string | undefined;
|
|
985
1093
|
/**
|
|
1094
|
+
* @public
|
|
986
1095
|
* <p>The identifier of the group to be deleted.</p>
|
|
987
1096
|
*/
|
|
988
1097
|
GroupId: string | undefined;
|
|
@@ -997,10 +1106,12 @@ export interface DeleteGroupResponse {
|
|
|
997
1106
|
*/
|
|
998
1107
|
export interface DeleteImpersonationRoleRequest {
|
|
999
1108
|
/**
|
|
1109
|
+
* @public
|
|
1000
1110
|
* <p>The WorkMail organization from which to delete the impersonation role.</p>
|
|
1001
1111
|
*/
|
|
1002
1112
|
OrganizationId: string | undefined;
|
|
1003
1113
|
/**
|
|
1114
|
+
* @public
|
|
1004
1115
|
* <p>The ID of the impersonation role to delete.</p>
|
|
1005
1116
|
*/
|
|
1006
1117
|
ImpersonationRoleId: string | undefined;
|
|
@@ -1015,15 +1126,18 @@ export interface DeleteImpersonationRoleResponse {
|
|
|
1015
1126
|
*/
|
|
1016
1127
|
export interface DeleteMailboxPermissionsRequest {
|
|
1017
1128
|
/**
|
|
1129
|
+
* @public
|
|
1018
1130
|
* <p>The identifier of the organization under which the member (user or group)
|
|
1019
1131
|
* exists.</p>
|
|
1020
1132
|
*/
|
|
1021
1133
|
OrganizationId: string | undefined;
|
|
1022
1134
|
/**
|
|
1135
|
+
* @public
|
|
1023
1136
|
* <p>The identifier of the member (user or group) that owns the mailbox.</p>
|
|
1024
1137
|
*/
|
|
1025
1138
|
EntityId: string | undefined;
|
|
1026
1139
|
/**
|
|
1140
|
+
* @public
|
|
1027
1141
|
* <p>The identifier of the member (user or group) for which to delete granted
|
|
1028
1142
|
* permissions.</p>
|
|
1029
1143
|
*/
|
|
@@ -1039,10 +1153,12 @@ export interface DeleteMailboxPermissionsResponse {
|
|
|
1039
1153
|
*/
|
|
1040
1154
|
export interface DeleteMobileDeviceAccessOverrideRequest {
|
|
1041
1155
|
/**
|
|
1156
|
+
* @public
|
|
1042
1157
|
* <p>The WorkMail organization for which the access override will be deleted.</p>
|
|
1043
1158
|
*/
|
|
1044
1159
|
OrganizationId: string | undefined;
|
|
1045
1160
|
/**
|
|
1161
|
+
* @public
|
|
1046
1162
|
* <p>The WorkMail user for which you want to delete the override. Accepts the following types of user identities:</p>
|
|
1047
1163
|
* <ul>
|
|
1048
1164
|
* <li>
|
|
@@ -1061,6 +1177,7 @@ export interface DeleteMobileDeviceAccessOverrideRequest {
|
|
|
1061
1177
|
*/
|
|
1062
1178
|
UserId: string | undefined;
|
|
1063
1179
|
/**
|
|
1180
|
+
* @public
|
|
1064
1181
|
* <p>The mobile device for which you delete the override. <code>DeviceId</code> is case insensitive.</p>
|
|
1065
1182
|
*/
|
|
1066
1183
|
DeviceId: string | undefined;
|
|
@@ -1075,10 +1192,12 @@ export interface DeleteMobileDeviceAccessOverrideResponse {
|
|
|
1075
1192
|
*/
|
|
1076
1193
|
export interface DeleteMobileDeviceAccessRuleRequest {
|
|
1077
1194
|
/**
|
|
1195
|
+
* @public
|
|
1078
1196
|
* <p>The WorkMail organization under which the rule will be deleted.</p>
|
|
1079
1197
|
*/
|
|
1080
1198
|
OrganizationId: string | undefined;
|
|
1081
1199
|
/**
|
|
1200
|
+
* @public
|
|
1082
1201
|
* <p>The identifier of the rule to be deleted.</p>
|
|
1083
1202
|
*/
|
|
1084
1203
|
MobileDeviceAccessRuleId: string | undefined;
|
|
@@ -1093,14 +1212,17 @@ export interface DeleteMobileDeviceAccessRuleResponse {
|
|
|
1093
1212
|
*/
|
|
1094
1213
|
export interface DeleteOrganizationRequest {
|
|
1095
1214
|
/**
|
|
1215
|
+
* @public
|
|
1096
1216
|
* <p>The idempotency token associated with the request.</p>
|
|
1097
1217
|
*/
|
|
1098
1218
|
ClientToken?: string;
|
|
1099
1219
|
/**
|
|
1220
|
+
* @public
|
|
1100
1221
|
* <p>The organization ID.</p>
|
|
1101
1222
|
*/
|
|
1102
1223
|
OrganizationId: string | undefined;
|
|
1103
1224
|
/**
|
|
1225
|
+
* @public
|
|
1104
1226
|
* <p>If true, deletes the AWS Directory Service directory associated with the organization.</p>
|
|
1105
1227
|
*/
|
|
1106
1228
|
DeleteDirectory: boolean | undefined;
|
|
@@ -1110,10 +1232,12 @@ export interface DeleteOrganizationRequest {
|
|
|
1110
1232
|
*/
|
|
1111
1233
|
export interface DeleteOrganizationResponse {
|
|
1112
1234
|
/**
|
|
1235
|
+
* @public
|
|
1113
1236
|
* <p>The organization ID.</p>
|
|
1114
1237
|
*/
|
|
1115
1238
|
OrganizationId?: string;
|
|
1116
1239
|
/**
|
|
1240
|
+
* @public
|
|
1117
1241
|
* <p>The state of the organization.</p>
|
|
1118
1242
|
*/
|
|
1119
1243
|
State?: string;
|
|
@@ -1123,11 +1247,13 @@ export interface DeleteOrganizationResponse {
|
|
|
1123
1247
|
*/
|
|
1124
1248
|
export interface DeleteResourceRequest {
|
|
1125
1249
|
/**
|
|
1250
|
+
* @public
|
|
1126
1251
|
* <p>The identifier associated with the organization from which the resource is
|
|
1127
1252
|
* deleted.</p>
|
|
1128
1253
|
*/
|
|
1129
1254
|
OrganizationId: string | undefined;
|
|
1130
1255
|
/**
|
|
1256
|
+
* @public
|
|
1131
1257
|
* <p>The identifier of the resource to be deleted.</p>
|
|
1132
1258
|
*/
|
|
1133
1259
|
ResourceId: string | undefined;
|
|
@@ -1142,10 +1268,12 @@ export interface DeleteResourceResponse {
|
|
|
1142
1268
|
*/
|
|
1143
1269
|
export interface DeleteRetentionPolicyRequest {
|
|
1144
1270
|
/**
|
|
1271
|
+
* @public
|
|
1145
1272
|
* <p>The organization ID.</p>
|
|
1146
1273
|
*/
|
|
1147
1274
|
OrganizationId: string | undefined;
|
|
1148
1275
|
/**
|
|
1276
|
+
* @public
|
|
1149
1277
|
* <p>The retention policy ID.</p>
|
|
1150
1278
|
*/
|
|
1151
1279
|
Id: string | undefined;
|
|
@@ -1160,10 +1288,12 @@ export interface DeleteRetentionPolicyResponse {
|
|
|
1160
1288
|
*/
|
|
1161
1289
|
export interface DeleteUserRequest {
|
|
1162
1290
|
/**
|
|
1291
|
+
* @public
|
|
1163
1292
|
* <p>The organization that contains the user to be deleted.</p>
|
|
1164
1293
|
*/
|
|
1165
1294
|
OrganizationId: string | undefined;
|
|
1166
1295
|
/**
|
|
1296
|
+
* @public
|
|
1167
1297
|
* <p>The identifier of the user to be deleted.</p>
|
|
1168
1298
|
*/
|
|
1169
1299
|
UserId: string | undefined;
|
|
@@ -1178,10 +1308,12 @@ export interface DeleteUserResponse {
|
|
|
1178
1308
|
*/
|
|
1179
1309
|
export interface DeregisterFromWorkMailRequest {
|
|
1180
1310
|
/**
|
|
1311
|
+
* @public
|
|
1181
1312
|
* <p>The identifier for the organization under which the WorkMail entity exists.</p>
|
|
1182
1313
|
*/
|
|
1183
1314
|
OrganizationId: string | undefined;
|
|
1184
1315
|
/**
|
|
1316
|
+
* @public
|
|
1185
1317
|
* <p>The identifier for the member (user or group) to be updated.</p>
|
|
1186
1318
|
*/
|
|
1187
1319
|
EntityId: string | undefined;
|
|
@@ -1196,10 +1328,12 @@ export interface DeregisterFromWorkMailResponse {
|
|
|
1196
1328
|
*/
|
|
1197
1329
|
export interface DeregisterMailDomainRequest {
|
|
1198
1330
|
/**
|
|
1331
|
+
* @public
|
|
1199
1332
|
* <p>The WorkMail organization for which the domain will be deregistered.</p>
|
|
1200
1333
|
*/
|
|
1201
1334
|
OrganizationId: string | undefined;
|
|
1202
1335
|
/**
|
|
1336
|
+
* @public
|
|
1203
1337
|
* <p>The domain to deregister in WorkMail and SES.</p>
|
|
1204
1338
|
*/
|
|
1205
1339
|
DomainName: string | undefined;
|
|
@@ -1241,6 +1375,7 @@ export declare class MailDomainInUseException extends __BaseException {
|
|
|
1241
1375
|
*/
|
|
1242
1376
|
export interface DescribeEmailMonitoringConfigurationRequest {
|
|
1243
1377
|
/**
|
|
1378
|
+
* @public
|
|
1244
1379
|
* <p>The ID of the organization for which the email monitoring configuration is described.</p>
|
|
1245
1380
|
*/
|
|
1246
1381
|
OrganizationId: string | undefined;
|
|
@@ -1250,10 +1385,12 @@ export interface DescribeEmailMonitoringConfigurationRequest {
|
|
|
1250
1385
|
*/
|
|
1251
1386
|
export interface DescribeEmailMonitoringConfigurationResponse {
|
|
1252
1387
|
/**
|
|
1388
|
+
* @public
|
|
1253
1389
|
* <p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>
|
|
1254
1390
|
*/
|
|
1255
1391
|
RoleArn?: string;
|
|
1256
1392
|
/**
|
|
1393
|
+
* @public
|
|
1257
1394
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>
|
|
1258
1395
|
*/
|
|
1259
1396
|
LogGroupArn?: string;
|
|
@@ -1263,10 +1400,12 @@ export interface DescribeEmailMonitoringConfigurationResponse {
|
|
|
1263
1400
|
*/
|
|
1264
1401
|
export interface DescribeGroupRequest {
|
|
1265
1402
|
/**
|
|
1403
|
+
* @public
|
|
1266
1404
|
* <p>The identifier for the organization under which the group exists.</p>
|
|
1267
1405
|
*/
|
|
1268
1406
|
OrganizationId: string | undefined;
|
|
1269
1407
|
/**
|
|
1408
|
+
* @public
|
|
1270
1409
|
* <p>The identifier for the group to be described.</p>
|
|
1271
1410
|
*/
|
|
1272
1411
|
GroupId: string | undefined;
|
|
@@ -1289,28 +1428,34 @@ export type EntityState = (typeof EntityState)[keyof typeof EntityState];
|
|
|
1289
1428
|
*/
|
|
1290
1429
|
export interface DescribeGroupResponse {
|
|
1291
1430
|
/**
|
|
1431
|
+
* @public
|
|
1292
1432
|
* <p>The identifier of the described group.</p>
|
|
1293
1433
|
*/
|
|
1294
1434
|
GroupId?: string;
|
|
1295
1435
|
/**
|
|
1436
|
+
* @public
|
|
1296
1437
|
* <p>The name of the described group.</p>
|
|
1297
1438
|
*/
|
|
1298
1439
|
Name?: string;
|
|
1299
1440
|
/**
|
|
1441
|
+
* @public
|
|
1300
1442
|
* <p>The email of the described group.</p>
|
|
1301
1443
|
*/
|
|
1302
1444
|
Email?: string;
|
|
1303
1445
|
/**
|
|
1446
|
+
* @public
|
|
1304
1447
|
* <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or
|
|
1305
1448
|
* never registered to WorkMail).</p>
|
|
1306
1449
|
*/
|
|
1307
1450
|
State?: EntityState | string;
|
|
1308
1451
|
/**
|
|
1452
|
+
* @public
|
|
1309
1453
|
* <p>The date and time when a user was registered to WorkMail, in UNIX epoch time
|
|
1310
1454
|
* format.</p>
|
|
1311
1455
|
*/
|
|
1312
1456
|
EnabledDate?: Date;
|
|
1313
1457
|
/**
|
|
1458
|
+
* @public
|
|
1314
1459
|
* <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time
|
|
1315
1460
|
* format.</p>
|
|
1316
1461
|
*/
|
|
@@ -1321,6 +1466,7 @@ export interface DescribeGroupResponse {
|
|
|
1321
1466
|
*/
|
|
1322
1467
|
export interface DescribeInboundDmarcSettingsRequest {
|
|
1323
1468
|
/**
|
|
1469
|
+
* @public
|
|
1324
1470
|
* <p>Lists the ID of the given organization.</p>
|
|
1325
1471
|
*/
|
|
1326
1472
|
OrganizationId: string | undefined;
|
|
@@ -1330,6 +1476,7 @@ export interface DescribeInboundDmarcSettingsRequest {
|
|
|
1330
1476
|
*/
|
|
1331
1477
|
export interface DescribeInboundDmarcSettingsResponse {
|
|
1332
1478
|
/**
|
|
1479
|
+
* @public
|
|
1333
1480
|
* <p>Lists the enforcement setting of the applied policy.</p>
|
|
1334
1481
|
*/
|
|
1335
1482
|
Enforced?: boolean;
|
|
@@ -1339,10 +1486,12 @@ export interface DescribeInboundDmarcSettingsResponse {
|
|
|
1339
1486
|
*/
|
|
1340
1487
|
export interface DescribeMailboxExportJobRequest {
|
|
1341
1488
|
/**
|
|
1489
|
+
* @public
|
|
1342
1490
|
* <p>The mailbox export job ID.</p>
|
|
1343
1491
|
*/
|
|
1344
1492
|
JobId: string | undefined;
|
|
1345
1493
|
/**
|
|
1494
|
+
* @public
|
|
1346
1495
|
* <p>The organization ID.</p>
|
|
1347
1496
|
*/
|
|
1348
1497
|
OrganizationId: string | undefined;
|
|
@@ -1366,53 +1515,65 @@ export type MailboxExportJobState = (typeof MailboxExportJobState)[keyof typeof
|
|
|
1366
1515
|
*/
|
|
1367
1516
|
export interface DescribeMailboxExportJobResponse {
|
|
1368
1517
|
/**
|
|
1518
|
+
* @public
|
|
1369
1519
|
* <p>The identifier of the user or resource associated with the mailbox.</p>
|
|
1370
1520
|
*/
|
|
1371
1521
|
EntityId?: string;
|
|
1372
1522
|
/**
|
|
1523
|
+
* @public
|
|
1373
1524
|
* <p>The mailbox export job description.</p>
|
|
1374
1525
|
*/
|
|
1375
1526
|
Description?: string;
|
|
1376
1527
|
/**
|
|
1528
|
+
* @public
|
|
1377
1529
|
* <p>The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple
|
|
1378
1530
|
* Storage Service (Amazon S3) bucket.</p>
|
|
1379
1531
|
*/
|
|
1380
1532
|
RoleArn?: string;
|
|
1381
1533
|
/**
|
|
1534
|
+
* @public
|
|
1382
1535
|
* <p>The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)
|
|
1383
1536
|
* key that encrypts the exported mailbox content.</p>
|
|
1384
1537
|
*/
|
|
1385
1538
|
KmsKeyArn?: string;
|
|
1386
1539
|
/**
|
|
1540
|
+
* @public
|
|
1387
1541
|
* <p>The name of the S3 bucket.</p>
|
|
1388
1542
|
*/
|
|
1389
1543
|
S3BucketName?: string;
|
|
1390
1544
|
/**
|
|
1545
|
+
* @public
|
|
1391
1546
|
* <p>The S3 bucket prefix.</p>
|
|
1392
1547
|
*/
|
|
1393
1548
|
S3Prefix?: string;
|
|
1394
1549
|
/**
|
|
1550
|
+
* @public
|
|
1395
1551
|
* <p>The path to the S3 bucket and file that the mailbox export job is exporting
|
|
1396
1552
|
* to.</p>
|
|
1397
1553
|
*/
|
|
1398
1554
|
S3Path?: string;
|
|
1399
1555
|
/**
|
|
1556
|
+
* @public
|
|
1400
1557
|
* <p>The estimated progress of the mailbox export job, in percentage points.</p>
|
|
1401
1558
|
*/
|
|
1402
1559
|
EstimatedProgress?: number;
|
|
1403
1560
|
/**
|
|
1561
|
+
* @public
|
|
1404
1562
|
* <p>The state of the mailbox export job.</p>
|
|
1405
1563
|
*/
|
|
1406
1564
|
State?: MailboxExportJobState | string;
|
|
1407
1565
|
/**
|
|
1566
|
+
* @public
|
|
1408
1567
|
* <p>Error information for failed mailbox export jobs.</p>
|
|
1409
1568
|
*/
|
|
1410
1569
|
ErrorInfo?: string;
|
|
1411
1570
|
/**
|
|
1571
|
+
* @public
|
|
1412
1572
|
* <p>The mailbox export job start timestamp.</p>
|
|
1413
1573
|
*/
|
|
1414
1574
|
StartTime?: Date;
|
|
1415
1575
|
/**
|
|
1576
|
+
* @public
|
|
1416
1577
|
* <p>The mailbox export job end timestamp.</p>
|
|
1417
1578
|
*/
|
|
1418
1579
|
EndTime?: Date;
|
|
@@ -1422,6 +1583,7 @@ export interface DescribeMailboxExportJobResponse {
|
|
|
1422
1583
|
*/
|
|
1423
1584
|
export interface DescribeOrganizationRequest {
|
|
1424
1585
|
/**
|
|
1586
|
+
* @public
|
|
1425
1587
|
* <p>The identifier for the organization to be described.</p>
|
|
1426
1588
|
*/
|
|
1427
1589
|
OrganizationId: string | undefined;
|
|
@@ -1431,40 +1593,49 @@ export interface DescribeOrganizationRequest {
|
|
|
1431
1593
|
*/
|
|
1432
1594
|
export interface DescribeOrganizationResponse {
|
|
1433
1595
|
/**
|
|
1596
|
+
* @public
|
|
1434
1597
|
* <p>The identifier of an organization.</p>
|
|
1435
1598
|
*/
|
|
1436
1599
|
OrganizationId?: string;
|
|
1437
1600
|
/**
|
|
1601
|
+
* @public
|
|
1438
1602
|
* <p>The alias for an organization.</p>
|
|
1439
1603
|
*/
|
|
1440
1604
|
Alias?: string;
|
|
1441
1605
|
/**
|
|
1606
|
+
* @public
|
|
1442
1607
|
* <p>The state of an organization.</p>
|
|
1443
1608
|
*/
|
|
1444
1609
|
State?: string;
|
|
1445
1610
|
/**
|
|
1611
|
+
* @public
|
|
1446
1612
|
* <p>The identifier for the directory associated with an WorkMail organization.</p>
|
|
1447
1613
|
*/
|
|
1448
1614
|
DirectoryId?: string;
|
|
1449
1615
|
/**
|
|
1616
|
+
* @public
|
|
1450
1617
|
* <p>The type of directory associated with the WorkMail organization.</p>
|
|
1451
1618
|
*/
|
|
1452
1619
|
DirectoryType?: string;
|
|
1453
1620
|
/**
|
|
1621
|
+
* @public
|
|
1454
1622
|
* <p>The default mail domain associated with the organization.</p>
|
|
1455
1623
|
*/
|
|
1456
1624
|
DefaultMailDomain?: string;
|
|
1457
1625
|
/**
|
|
1626
|
+
* @public
|
|
1458
1627
|
* <p>The date at which the organization became usable in the WorkMail context, in UNIX epoch
|
|
1459
1628
|
* time format.</p>
|
|
1460
1629
|
*/
|
|
1461
1630
|
CompletedDate?: Date;
|
|
1462
1631
|
/**
|
|
1632
|
+
* @public
|
|
1463
1633
|
* <p>(Optional) The error message indicating if unexpected behavior was encountered with
|
|
1464
1634
|
* regards to the organization.</p>
|
|
1465
1635
|
*/
|
|
1466
1636
|
ErrorMessage?: string;
|
|
1467
1637
|
/**
|
|
1638
|
+
* @public
|
|
1468
1639
|
* <p>The Amazon Resource Name (ARN) of the organization.</p>
|
|
1469
1640
|
*/
|
|
1470
1641
|
ARN?: string;
|
|
@@ -1474,11 +1645,13 @@ export interface DescribeOrganizationResponse {
|
|
|
1474
1645
|
*/
|
|
1475
1646
|
export interface DescribeResourceRequest {
|
|
1476
1647
|
/**
|
|
1648
|
+
* @public
|
|
1477
1649
|
* <p>The identifier associated with the organization for which the resource is
|
|
1478
1650
|
* described.</p>
|
|
1479
1651
|
*/
|
|
1480
1652
|
OrganizationId: string | undefined;
|
|
1481
1653
|
/**
|
|
1654
|
+
* @public
|
|
1482
1655
|
* <p>The identifier of the resource to be described.</p>
|
|
1483
1656
|
*/
|
|
1484
1657
|
ResourceId: string | undefined;
|
|
@@ -1488,36 +1661,44 @@ export interface DescribeResourceRequest {
|
|
|
1488
1661
|
*/
|
|
1489
1662
|
export interface DescribeResourceResponse {
|
|
1490
1663
|
/**
|
|
1664
|
+
* @public
|
|
1491
1665
|
* <p>The identifier of the described resource.</p>
|
|
1492
1666
|
*/
|
|
1493
1667
|
ResourceId?: string;
|
|
1494
1668
|
/**
|
|
1669
|
+
* @public
|
|
1495
1670
|
* <p>The email of the described resource.</p>
|
|
1496
1671
|
*/
|
|
1497
1672
|
Email?: string;
|
|
1498
1673
|
/**
|
|
1674
|
+
* @public
|
|
1499
1675
|
* <p>The name of the described resource.</p>
|
|
1500
1676
|
*/
|
|
1501
1677
|
Name?: string;
|
|
1502
1678
|
/**
|
|
1679
|
+
* @public
|
|
1503
1680
|
* <p>The type of the described resource.</p>
|
|
1504
1681
|
*/
|
|
1505
1682
|
Type?: ResourceType | string;
|
|
1506
1683
|
/**
|
|
1684
|
+
* @public
|
|
1507
1685
|
* <p>The booking options for the described resource.</p>
|
|
1508
1686
|
*/
|
|
1509
1687
|
BookingOptions?: BookingOptions;
|
|
1510
1688
|
/**
|
|
1689
|
+
* @public
|
|
1511
1690
|
* <p>The state of the resource: enabled (registered to WorkMail), disabled (deregistered
|
|
1512
1691
|
* or never registered to WorkMail), or deleted.</p>
|
|
1513
1692
|
*/
|
|
1514
1693
|
State?: EntityState | string;
|
|
1515
1694
|
/**
|
|
1695
|
+
* @public
|
|
1516
1696
|
* <p>The date and time when a resource was enabled for WorkMail, in UNIX epoch time
|
|
1517
1697
|
* format.</p>
|
|
1518
1698
|
*/
|
|
1519
1699
|
EnabledDate?: Date;
|
|
1520
1700
|
/**
|
|
1701
|
+
* @public
|
|
1521
1702
|
* <p>The date and time when a resource was disabled from WorkMail, in UNIX epoch time
|
|
1522
1703
|
* format.</p>
|
|
1523
1704
|
*/
|
|
@@ -1528,10 +1709,12 @@ export interface DescribeResourceResponse {
|
|
|
1528
1709
|
*/
|
|
1529
1710
|
export interface DescribeUserRequest {
|
|
1530
1711
|
/**
|
|
1712
|
+
* @public
|
|
1531
1713
|
* <p>The identifier for the organization under which the user exists.</p>
|
|
1532
1714
|
*/
|
|
1533
1715
|
OrganizationId: string | undefined;
|
|
1534
1716
|
/**
|
|
1717
|
+
* @public
|
|
1535
1718
|
* <p>The identifier for the user to be described.</p>
|
|
1536
1719
|
*/
|
|
1537
1720
|
UserId: string | undefined;
|
|
@@ -1554,27 +1737,33 @@ export type UserRole = (typeof UserRole)[keyof typeof UserRole];
|
|
|
1554
1737
|
*/
|
|
1555
1738
|
export interface DescribeUserResponse {
|
|
1556
1739
|
/**
|
|
1740
|
+
* @public
|
|
1557
1741
|
* <p>The identifier for the described user.</p>
|
|
1558
1742
|
*/
|
|
1559
1743
|
UserId?: string;
|
|
1560
1744
|
/**
|
|
1745
|
+
* @public
|
|
1561
1746
|
* <p>The name for the user.</p>
|
|
1562
1747
|
*/
|
|
1563
1748
|
Name?: string;
|
|
1564
1749
|
/**
|
|
1750
|
+
* @public
|
|
1565
1751
|
* <p>The email of the user.</p>
|
|
1566
1752
|
*/
|
|
1567
1753
|
Email?: string;
|
|
1568
1754
|
/**
|
|
1755
|
+
* @public
|
|
1569
1756
|
* <p>The display name of the user.</p>
|
|
1570
1757
|
*/
|
|
1571
1758
|
DisplayName?: string;
|
|
1572
1759
|
/**
|
|
1760
|
+
* @public
|
|
1573
1761
|
* <p>The state of a user: enabled (registered to WorkMail) or disabled (deregistered or
|
|
1574
1762
|
* never registered to WorkMail).</p>
|
|
1575
1763
|
*/
|
|
1576
1764
|
State?: EntityState | string;
|
|
1577
1765
|
/**
|
|
1766
|
+
* @public
|
|
1578
1767
|
* <p>In certain cases, other entities are modeled as users. If interoperability is
|
|
1579
1768
|
* enabled, resources are imported into WorkMail as users. Because different WorkMail
|
|
1580
1769
|
* organizations rely on different directory types, administrators can distinguish between an
|
|
@@ -1583,11 +1772,13 @@ export interface DescribeUserResponse {
|
|
|
1583
1772
|
*/
|
|
1584
1773
|
UserRole?: UserRole | string;
|
|
1585
1774
|
/**
|
|
1775
|
+
* @public
|
|
1586
1776
|
* <p>The date and time at which the user was enabled for WorkMailusage, in UNIX epoch
|
|
1587
1777
|
* time format.</p>
|
|
1588
1778
|
*/
|
|
1589
1779
|
EnabledDate?: Date;
|
|
1590
1780
|
/**
|
|
1781
|
+
* @public
|
|
1591
1782
|
* <p>The date and time at which the user was disabled for WorkMail usage, in UNIX epoch
|
|
1592
1783
|
* time format.</p>
|
|
1593
1784
|
*/
|
|
@@ -1598,15 +1789,18 @@ export interface DescribeUserResponse {
|
|
|
1598
1789
|
*/
|
|
1599
1790
|
export interface DisassociateDelegateFromResourceRequest {
|
|
1600
1791
|
/**
|
|
1792
|
+
* @public
|
|
1601
1793
|
* <p>The identifier for the organization under which the resource exists.</p>
|
|
1602
1794
|
*/
|
|
1603
1795
|
OrganizationId: string | undefined;
|
|
1604
1796
|
/**
|
|
1797
|
+
* @public
|
|
1605
1798
|
* <p>The identifier of the resource from which delegates' set members are removed.
|
|
1606
1799
|
* </p>
|
|
1607
1800
|
*/
|
|
1608
1801
|
ResourceId: string | undefined;
|
|
1609
1802
|
/**
|
|
1803
|
+
* @public
|
|
1610
1804
|
* <p>The identifier for the member (user, group) to be removed from the resource's
|
|
1611
1805
|
* delegates.</p>
|
|
1612
1806
|
*/
|
|
@@ -1622,14 +1816,17 @@ export interface DisassociateDelegateFromResourceResponse {
|
|
|
1622
1816
|
*/
|
|
1623
1817
|
export interface DisassociateMemberFromGroupRequest {
|
|
1624
1818
|
/**
|
|
1819
|
+
* @public
|
|
1625
1820
|
* <p>The identifier for the organization under which the group exists.</p>
|
|
1626
1821
|
*/
|
|
1627
1822
|
OrganizationId: string | undefined;
|
|
1628
1823
|
/**
|
|
1824
|
+
* @public
|
|
1629
1825
|
* <p>The identifier for the group from which members are removed.</p>
|
|
1630
1826
|
*/
|
|
1631
1827
|
GroupId: string | undefined;
|
|
1632
1828
|
/**
|
|
1829
|
+
* @public
|
|
1633
1830
|
* <p>The identifier for the member to be removed to the group.</p>
|
|
1634
1831
|
*/
|
|
1635
1832
|
MemberId: string | undefined;
|
|
@@ -1645,14 +1842,17 @@ export interface DisassociateMemberFromGroupResponse {
|
|
|
1645
1842
|
*/
|
|
1646
1843
|
export interface DnsRecord {
|
|
1647
1844
|
/**
|
|
1845
|
+
* @public
|
|
1648
1846
|
* <p>The RFC 1035 record type. Possible values: <code>CNAME</code>, <code>A</code>, <code>MX</code>.</p>
|
|
1649
1847
|
*/
|
|
1650
1848
|
Type?: string;
|
|
1651
1849
|
/**
|
|
1850
|
+
* @public
|
|
1652
1851
|
* <p>The DNS hostname.- For example, <code>domain.example.com</code>.</p>
|
|
1653
1852
|
*/
|
|
1654
1853
|
Hostname?: string;
|
|
1655
1854
|
/**
|
|
1855
|
+
* @public
|
|
1656
1856
|
* <p>The value returned by the DNS for a query to that hostname and record type.</p>
|
|
1657
1857
|
*/
|
|
1658
1858
|
Value?: string;
|
|
@@ -1719,15 +1919,18 @@ export type FolderName = (typeof FolderName)[keyof typeof FolderName];
|
|
|
1719
1919
|
*/
|
|
1720
1920
|
export interface FolderConfiguration {
|
|
1721
1921
|
/**
|
|
1922
|
+
* @public
|
|
1722
1923
|
* <p>The folder name.</p>
|
|
1723
1924
|
*/
|
|
1724
1925
|
Name: FolderName | string | undefined;
|
|
1725
1926
|
/**
|
|
1927
|
+
* @public
|
|
1726
1928
|
* <p>The action to take on the folder contents at the end of the folder configuration
|
|
1727
1929
|
* period.</p>
|
|
1728
1930
|
*/
|
|
1729
1931
|
Action: RetentionAction | string | undefined;
|
|
1730
1932
|
/**
|
|
1933
|
+
* @public
|
|
1731
1934
|
* <p>The number of days for which the folder-configuration action applies.</p>
|
|
1732
1935
|
*/
|
|
1733
1936
|
Period?: number;
|
|
@@ -1737,24 +1940,29 @@ export interface FolderConfiguration {
|
|
|
1737
1940
|
*/
|
|
1738
1941
|
export interface GetAccessControlEffectRequest {
|
|
1739
1942
|
/**
|
|
1943
|
+
* @public
|
|
1740
1944
|
* <p>The identifier for the organization.</p>
|
|
1741
1945
|
*/
|
|
1742
1946
|
OrganizationId: string | undefined;
|
|
1743
1947
|
/**
|
|
1948
|
+
* @public
|
|
1744
1949
|
* <p>The IPv4 address.</p>
|
|
1745
1950
|
*/
|
|
1746
1951
|
IpAddress: string | undefined;
|
|
1747
1952
|
/**
|
|
1953
|
+
* @public
|
|
1748
1954
|
* <p>The access protocol action. Valid values include <code>ActiveSync</code>,
|
|
1749
1955
|
* <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>,
|
|
1750
1956
|
* <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
|
|
1751
1957
|
*/
|
|
1752
1958
|
Action: string | undefined;
|
|
1753
1959
|
/**
|
|
1960
|
+
* @public
|
|
1754
1961
|
* <p>The user ID.</p>
|
|
1755
1962
|
*/
|
|
1756
1963
|
UserId?: string;
|
|
1757
1964
|
/**
|
|
1965
|
+
* @public
|
|
1758
1966
|
* <p>The impersonation role ID.</p>
|
|
1759
1967
|
*/
|
|
1760
1968
|
ImpersonationRoleId?: string;
|
|
@@ -1764,10 +1972,12 @@ export interface GetAccessControlEffectRequest {
|
|
|
1764
1972
|
*/
|
|
1765
1973
|
export interface GetAccessControlEffectResponse {
|
|
1766
1974
|
/**
|
|
1975
|
+
* @public
|
|
1767
1976
|
* <p>The rule effect.</p>
|
|
1768
1977
|
*/
|
|
1769
1978
|
Effect?: AccessControlRuleEffect | string;
|
|
1770
1979
|
/**
|
|
1980
|
+
* @public
|
|
1771
1981
|
* <p>The rules that match the given parameters, resulting in an effect.</p>
|
|
1772
1982
|
*/
|
|
1773
1983
|
MatchedRules?: string[];
|
|
@@ -1777,6 +1987,7 @@ export interface GetAccessControlEffectResponse {
|
|
|
1777
1987
|
*/
|
|
1778
1988
|
export interface GetDefaultRetentionPolicyRequest {
|
|
1779
1989
|
/**
|
|
1990
|
+
* @public
|
|
1780
1991
|
* <p>The organization ID.</p>
|
|
1781
1992
|
*/
|
|
1782
1993
|
OrganizationId: string | undefined;
|
|
@@ -1786,18 +1997,22 @@ export interface GetDefaultRetentionPolicyRequest {
|
|
|
1786
1997
|
*/
|
|
1787
1998
|
export interface GetDefaultRetentionPolicyResponse {
|
|
1788
1999
|
/**
|
|
2000
|
+
* @public
|
|
1789
2001
|
* <p>The retention policy ID.</p>
|
|
1790
2002
|
*/
|
|
1791
2003
|
Id?: string;
|
|
1792
2004
|
/**
|
|
2005
|
+
* @public
|
|
1793
2006
|
* <p>The retention policy name.</p>
|
|
1794
2007
|
*/
|
|
1795
2008
|
Name?: string;
|
|
1796
2009
|
/**
|
|
2010
|
+
* @public
|
|
1797
2011
|
* <p>The retention policy description.</p>
|
|
1798
2012
|
*/
|
|
1799
2013
|
Description?: string;
|
|
1800
2014
|
/**
|
|
2015
|
+
* @public
|
|
1801
2016
|
* <p>The retention policy folder configurations.</p>
|
|
1802
2017
|
*/
|
|
1803
2018
|
FolderConfigurations?: FolderConfiguration[];
|
|
@@ -1807,10 +2022,12 @@ export interface GetDefaultRetentionPolicyResponse {
|
|
|
1807
2022
|
*/
|
|
1808
2023
|
export interface GetImpersonationRoleRequest {
|
|
1809
2024
|
/**
|
|
2025
|
+
* @public
|
|
1810
2026
|
* <p>The WorkMail organization from which to retrieve the impersonation role.</p>
|
|
1811
2027
|
*/
|
|
1812
2028
|
OrganizationId: string | undefined;
|
|
1813
2029
|
/**
|
|
2030
|
+
* @public
|
|
1814
2031
|
* <p>The impersonation role ID to retrieve.</p>
|
|
1815
2032
|
*/
|
|
1816
2033
|
ImpersonationRoleId: string | undefined;
|
|
@@ -1820,30 +2037,37 @@ export interface GetImpersonationRoleRequest {
|
|
|
1820
2037
|
*/
|
|
1821
2038
|
export interface GetImpersonationRoleResponse {
|
|
1822
2039
|
/**
|
|
2040
|
+
* @public
|
|
1823
2041
|
* <p>The impersonation role ID.</p>
|
|
1824
2042
|
*/
|
|
1825
2043
|
ImpersonationRoleId?: string;
|
|
1826
2044
|
/**
|
|
2045
|
+
* @public
|
|
1827
2046
|
* <p>The impersonation role name.</p>
|
|
1828
2047
|
*/
|
|
1829
2048
|
Name?: string;
|
|
1830
2049
|
/**
|
|
2050
|
+
* @public
|
|
1831
2051
|
* <p>The impersonation role type.</p>
|
|
1832
2052
|
*/
|
|
1833
2053
|
Type?: ImpersonationRoleType | string;
|
|
1834
2054
|
/**
|
|
2055
|
+
* @public
|
|
1835
2056
|
* <p>The impersonation role description.</p>
|
|
1836
2057
|
*/
|
|
1837
2058
|
Description?: string;
|
|
1838
2059
|
/**
|
|
2060
|
+
* @public
|
|
1839
2061
|
* <p>The list of rules for the given impersonation role.</p>
|
|
1840
2062
|
*/
|
|
1841
2063
|
Rules?: ImpersonationRule[];
|
|
1842
2064
|
/**
|
|
2065
|
+
* @public
|
|
1843
2066
|
* <p>The date when the impersonation role was created.</p>
|
|
1844
2067
|
*/
|
|
1845
2068
|
DateCreated?: Date;
|
|
1846
2069
|
/**
|
|
2070
|
+
* @public
|
|
1847
2071
|
* <p>The date when the impersonation role was last modified.</p>
|
|
1848
2072
|
*/
|
|
1849
2073
|
DateModified?: Date;
|
|
@@ -1853,14 +2077,17 @@ export interface GetImpersonationRoleResponse {
|
|
|
1853
2077
|
*/
|
|
1854
2078
|
export interface GetImpersonationRoleEffectRequest {
|
|
1855
2079
|
/**
|
|
2080
|
+
* @public
|
|
1856
2081
|
* <p>The WorkMail organization where the impersonation role is defined.</p>
|
|
1857
2082
|
*/
|
|
1858
2083
|
OrganizationId: string | undefined;
|
|
1859
2084
|
/**
|
|
2085
|
+
* @public
|
|
1860
2086
|
* <p>The impersonation role ID to test.</p>
|
|
1861
2087
|
*/
|
|
1862
2088
|
ImpersonationRoleId: string | undefined;
|
|
1863
2089
|
/**
|
|
2090
|
+
* @public
|
|
1864
2091
|
* <p>The WorkMail organization user chosen to test the impersonation role. The following identity
|
|
1865
2092
|
* formats are available:</p>
|
|
1866
2093
|
* <ul>
|
|
@@ -1886,10 +2113,12 @@ export interface GetImpersonationRoleEffectRequest {
|
|
|
1886
2113
|
*/
|
|
1887
2114
|
export interface ImpersonationMatchedRule {
|
|
1888
2115
|
/**
|
|
2116
|
+
* @public
|
|
1889
2117
|
* <p>The ID of the rule that matched the input</p>
|
|
1890
2118
|
*/
|
|
1891
2119
|
ImpersonationRuleId?: string;
|
|
1892
2120
|
/**
|
|
2121
|
+
* @public
|
|
1893
2122
|
* <p>The name of the rule that matched the input.</p>
|
|
1894
2123
|
*/
|
|
1895
2124
|
Name?: string;
|
|
@@ -1899,16 +2128,19 @@ export interface ImpersonationMatchedRule {
|
|
|
1899
2128
|
*/
|
|
1900
2129
|
export interface GetImpersonationRoleEffectResponse {
|
|
1901
2130
|
/**
|
|
2131
|
+
* @public
|
|
1902
2132
|
* <p>The impersonation role type.</p>
|
|
1903
2133
|
*/
|
|
1904
2134
|
Type?: ImpersonationRoleType | string;
|
|
1905
2135
|
/**
|
|
2136
|
+
* @public
|
|
1906
2137
|
* <p>
|
|
1907
2138
|
* <code></code>Effect of the impersonation role on the target user based on its rules. Available
|
|
1908
2139
|
* effects are <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
1909
2140
|
*/
|
|
1910
2141
|
Effect?: AccessEffect | string;
|
|
1911
2142
|
/**
|
|
2143
|
+
* @public
|
|
1912
2144
|
* <p>A list of the rules that match the input and produce the configured effect.</p>
|
|
1913
2145
|
*/
|
|
1914
2146
|
MatchedRules?: ImpersonationMatchedRule[];
|
|
@@ -1918,11 +2150,13 @@ export interface GetImpersonationRoleEffectResponse {
|
|
|
1918
2150
|
*/
|
|
1919
2151
|
export interface GetMailboxDetailsRequest {
|
|
1920
2152
|
/**
|
|
2153
|
+
* @public
|
|
1921
2154
|
* <p>The identifier for the organization that contains the user whose mailbox details are
|
|
1922
2155
|
* being requested.</p>
|
|
1923
2156
|
*/
|
|
1924
2157
|
OrganizationId: string | undefined;
|
|
1925
2158
|
/**
|
|
2159
|
+
* @public
|
|
1926
2160
|
* <p>The identifier for the user whose mailbox details are being requested.</p>
|
|
1927
2161
|
*/
|
|
1928
2162
|
UserId: string | undefined;
|
|
@@ -1932,10 +2166,12 @@ export interface GetMailboxDetailsRequest {
|
|
|
1932
2166
|
*/
|
|
1933
2167
|
export interface GetMailboxDetailsResponse {
|
|
1934
2168
|
/**
|
|
2169
|
+
* @public
|
|
1935
2170
|
* <p>The maximum allowed mailbox size, in MB, for the specified user.</p>
|
|
1936
2171
|
*/
|
|
1937
2172
|
MailboxQuota?: number;
|
|
1938
2173
|
/**
|
|
2174
|
+
* @public
|
|
1939
2175
|
* <p>The current mailbox size, in MB, for the specified user.</p>
|
|
1940
2176
|
*/
|
|
1941
2177
|
MailboxSize?: number;
|
|
@@ -1945,10 +2181,12 @@ export interface GetMailboxDetailsResponse {
|
|
|
1945
2181
|
*/
|
|
1946
2182
|
export interface GetMailDomainRequest {
|
|
1947
2183
|
/**
|
|
2184
|
+
* @public
|
|
1948
2185
|
* <p>The WorkMail organization for which the domain is retrieved.</p>
|
|
1949
2186
|
*/
|
|
1950
2187
|
OrganizationId: string | undefined;
|
|
1951
2188
|
/**
|
|
2189
|
+
* @public
|
|
1952
2190
|
* <p>The domain from which you want to retrieve details.</p>
|
|
1953
2191
|
*/
|
|
1954
2192
|
DomainName: string | undefined;
|
|
@@ -1958,23 +2196,28 @@ export interface GetMailDomainRequest {
|
|
|
1958
2196
|
*/
|
|
1959
2197
|
export interface GetMailDomainResponse {
|
|
1960
2198
|
/**
|
|
2199
|
+
* @public
|
|
1961
2200
|
* <p>A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming
|
|
1962
2201
|
* email traffic to SES. See admin guide for more details.</p>
|
|
1963
2202
|
*/
|
|
1964
2203
|
Records?: DnsRecord[];
|
|
1965
2204
|
/**
|
|
2205
|
+
* @public
|
|
1966
2206
|
* <p>Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.</p>
|
|
1967
2207
|
*/
|
|
1968
2208
|
IsTestDomain?: boolean;
|
|
1969
2209
|
/**
|
|
2210
|
+
* @public
|
|
1970
2211
|
* <p>Specifies whether the domain is the default domain for your organization.</p>
|
|
1971
2212
|
*/
|
|
1972
2213
|
IsDefault?: boolean;
|
|
1973
2214
|
/**
|
|
2215
|
+
* @public
|
|
1974
2216
|
* <p> Indicates the status of the domain ownership verification.</p>
|
|
1975
2217
|
*/
|
|
1976
2218
|
OwnershipVerificationStatus?: DnsRecordVerificationStatus | string;
|
|
1977
2219
|
/**
|
|
2220
|
+
* @public
|
|
1978
2221
|
* <p>Indicates the status of a DKIM verification.</p>
|
|
1979
2222
|
*/
|
|
1980
2223
|
DkimVerificationStatus?: DnsRecordVerificationStatus | string;
|
|
@@ -1984,22 +2227,27 @@ export interface GetMailDomainResponse {
|
|
|
1984
2227
|
*/
|
|
1985
2228
|
export interface GetMobileDeviceAccessEffectRequest {
|
|
1986
2229
|
/**
|
|
2230
|
+
* @public
|
|
1987
2231
|
* <p>The WorkMail organization to simulate the access effect for.</p>
|
|
1988
2232
|
*/
|
|
1989
2233
|
OrganizationId: string | undefined;
|
|
1990
2234
|
/**
|
|
2235
|
+
* @public
|
|
1991
2236
|
* <p>Device type the simulated user will report.</p>
|
|
1992
2237
|
*/
|
|
1993
2238
|
DeviceType?: string;
|
|
1994
2239
|
/**
|
|
2240
|
+
* @public
|
|
1995
2241
|
* <p>Device model the simulated user will report.</p>
|
|
1996
2242
|
*/
|
|
1997
2243
|
DeviceModel?: string;
|
|
1998
2244
|
/**
|
|
2245
|
+
* @public
|
|
1999
2246
|
* <p>Device operating system the simulated user will report.</p>
|
|
2000
2247
|
*/
|
|
2001
2248
|
DeviceOperatingSystem?: string;
|
|
2002
2249
|
/**
|
|
2250
|
+
* @public
|
|
2003
2251
|
* <p>Device user agent the simulated user will report.</p>
|
|
2004
2252
|
*/
|
|
2005
2253
|
DeviceUserAgent?: string;
|
|
@@ -2010,10 +2258,12 @@ export interface GetMobileDeviceAccessEffectRequest {
|
|
|
2010
2258
|
*/
|
|
2011
2259
|
export interface MobileDeviceAccessMatchedRule {
|
|
2012
2260
|
/**
|
|
2261
|
+
* @public
|
|
2013
2262
|
* <p>Identifier of the rule that a simulated user matches.</p>
|
|
2014
2263
|
*/
|
|
2015
2264
|
MobileDeviceAccessRuleId?: string;
|
|
2016
2265
|
/**
|
|
2266
|
+
* @public
|
|
2017
2267
|
* <p>Name of a rule that a simulated user matches.</p>
|
|
2018
2268
|
*/
|
|
2019
2269
|
Name?: string;
|
|
@@ -2023,11 +2273,13 @@ export interface MobileDeviceAccessMatchedRule {
|
|
|
2023
2273
|
*/
|
|
2024
2274
|
export interface GetMobileDeviceAccessEffectResponse {
|
|
2025
2275
|
/**
|
|
2276
|
+
* @public
|
|
2026
2277
|
* <p>The effect of the simulated access, <code>ALLOW</code> or <code>DENY</code>, after evaluating mobile device access rules in the WorkMail organization for the simulated
|
|
2027
2278
|
* user parameters.</p>
|
|
2028
2279
|
*/
|
|
2029
2280
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
2030
2281
|
/**
|
|
2282
|
+
* @public
|
|
2031
2283
|
* <p>A list of the rules which matched the simulated user input and produced the effect.</p>
|
|
2032
2284
|
*/
|
|
2033
2285
|
MatchedRules?: MobileDeviceAccessMatchedRule[];
|
|
@@ -2037,10 +2289,12 @@ export interface GetMobileDeviceAccessEffectResponse {
|
|
|
2037
2289
|
*/
|
|
2038
2290
|
export interface GetMobileDeviceAccessOverrideRequest {
|
|
2039
2291
|
/**
|
|
2292
|
+
* @public
|
|
2040
2293
|
* <p>The WorkMail organization to which you want to apply the override.</p>
|
|
2041
2294
|
*/
|
|
2042
2295
|
OrganizationId: string | undefined;
|
|
2043
2296
|
/**
|
|
2297
|
+
* @public
|
|
2044
2298
|
* <p>Identifies the WorkMail user for the override. Accepts the following types of user identities: </p>
|
|
2045
2299
|
* <ul>
|
|
2046
2300
|
* <li>
|
|
@@ -2059,6 +2313,7 @@ export interface GetMobileDeviceAccessOverrideRequest {
|
|
|
2059
2313
|
*/
|
|
2060
2314
|
UserId: string | undefined;
|
|
2061
2315
|
/**
|
|
2316
|
+
* @public
|
|
2062
2317
|
* <p>The mobile device to which the override applies. <code>DeviceId</code> is case insensitive.</p>
|
|
2063
2318
|
*/
|
|
2064
2319
|
DeviceId: string | undefined;
|
|
@@ -2068,26 +2323,32 @@ export interface GetMobileDeviceAccessOverrideRequest {
|
|
|
2068
2323
|
*/
|
|
2069
2324
|
export interface GetMobileDeviceAccessOverrideResponse {
|
|
2070
2325
|
/**
|
|
2326
|
+
* @public
|
|
2071
2327
|
* <p>The WorkMail user to which the access override applies.</p>
|
|
2072
2328
|
*/
|
|
2073
2329
|
UserId?: string;
|
|
2074
2330
|
/**
|
|
2331
|
+
* @public
|
|
2075
2332
|
* <p>The device to which the access override applies.</p>
|
|
2076
2333
|
*/
|
|
2077
2334
|
DeviceId?: string;
|
|
2078
2335
|
/**
|
|
2336
|
+
* @public
|
|
2079
2337
|
* <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
2080
2338
|
*/
|
|
2081
2339
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
2082
2340
|
/**
|
|
2341
|
+
* @public
|
|
2083
2342
|
* <p>A description of the override.</p>
|
|
2084
2343
|
*/
|
|
2085
2344
|
Description?: string;
|
|
2086
2345
|
/**
|
|
2346
|
+
* @public
|
|
2087
2347
|
* <p>The date the override was first created.</p>
|
|
2088
2348
|
*/
|
|
2089
2349
|
DateCreated?: Date;
|
|
2090
2350
|
/**
|
|
2351
|
+
* @public
|
|
2091
2352
|
* <p>The date the description was last modified.</p>
|
|
2092
2353
|
*/
|
|
2093
2354
|
DateModified?: Date;
|
|
@@ -2098,26 +2359,32 @@ export interface GetMobileDeviceAccessOverrideResponse {
|
|
|
2098
2359
|
*/
|
|
2099
2360
|
export interface Group {
|
|
2100
2361
|
/**
|
|
2362
|
+
* @public
|
|
2101
2363
|
* <p>The identifier of the group.</p>
|
|
2102
2364
|
*/
|
|
2103
2365
|
Id?: string;
|
|
2104
2366
|
/**
|
|
2367
|
+
* @public
|
|
2105
2368
|
* <p>The email of the group.</p>
|
|
2106
2369
|
*/
|
|
2107
2370
|
Email?: string;
|
|
2108
2371
|
/**
|
|
2372
|
+
* @public
|
|
2109
2373
|
* <p>The name of the group.</p>
|
|
2110
2374
|
*/
|
|
2111
2375
|
Name?: string;
|
|
2112
2376
|
/**
|
|
2377
|
+
* @public
|
|
2113
2378
|
* <p>The state of the group, which can be ENABLED, DISABLED, or DELETED.</p>
|
|
2114
2379
|
*/
|
|
2115
2380
|
State?: EntityState | string;
|
|
2116
2381
|
/**
|
|
2382
|
+
* @public
|
|
2117
2383
|
* <p>The date indicating when the group was enabled for WorkMail use.</p>
|
|
2118
2384
|
*/
|
|
2119
2385
|
EnabledDate?: Date;
|
|
2120
2386
|
/**
|
|
2387
|
+
* @public
|
|
2121
2388
|
* <p>The date indicating when the group was disabled from WorkMail use.</p>
|
|
2122
2389
|
*/
|
|
2123
2390
|
DisabledDate?: Date;
|
|
@@ -2128,22 +2395,27 @@ export interface Group {
|
|
|
2128
2395
|
*/
|
|
2129
2396
|
export interface ImpersonationRole {
|
|
2130
2397
|
/**
|
|
2398
|
+
* @public
|
|
2131
2399
|
* <p>The identifier of the impersonation role.</p>
|
|
2132
2400
|
*/
|
|
2133
2401
|
ImpersonationRoleId?: string;
|
|
2134
2402
|
/**
|
|
2403
|
+
* @public
|
|
2135
2404
|
* <p>The impersonation role name.</p>
|
|
2136
2405
|
*/
|
|
2137
2406
|
Name?: string;
|
|
2138
2407
|
/**
|
|
2408
|
+
* @public
|
|
2139
2409
|
* <p>The impersonation role type.</p>
|
|
2140
2410
|
*/
|
|
2141
2411
|
Type?: ImpersonationRoleType | string;
|
|
2142
2412
|
/**
|
|
2413
|
+
* @public
|
|
2143
2414
|
* <p>The date when the impersonation role was created.</p>
|
|
2144
2415
|
*/
|
|
2145
2416
|
DateCreated?: Date;
|
|
2146
2417
|
/**
|
|
2418
|
+
* @public
|
|
2147
2419
|
* <p>The date when the impersonation role was last modified.</p>
|
|
2148
2420
|
*/
|
|
2149
2421
|
DateModified?: Date;
|
|
@@ -2170,38 +2442,47 @@ export declare class InvalidConfigurationException extends __BaseException {
|
|
|
2170
2442
|
*/
|
|
2171
2443
|
export interface MailboxExportJob {
|
|
2172
2444
|
/**
|
|
2445
|
+
* @public
|
|
2173
2446
|
* <p>The identifier of the mailbox export job.</p>
|
|
2174
2447
|
*/
|
|
2175
2448
|
JobId?: string;
|
|
2176
2449
|
/**
|
|
2450
|
+
* @public
|
|
2177
2451
|
* <p>The identifier of the user or resource associated with the mailbox.</p>
|
|
2178
2452
|
*/
|
|
2179
2453
|
EntityId?: string;
|
|
2180
2454
|
/**
|
|
2455
|
+
* @public
|
|
2181
2456
|
* <p>The mailbox export job description.</p>
|
|
2182
2457
|
*/
|
|
2183
2458
|
Description?: string;
|
|
2184
2459
|
/**
|
|
2460
|
+
* @public
|
|
2185
2461
|
* <p>The name of the S3 bucket.</p>
|
|
2186
2462
|
*/
|
|
2187
2463
|
S3BucketName?: string;
|
|
2188
2464
|
/**
|
|
2465
|
+
* @public
|
|
2189
2466
|
* <p>The path to the S3 bucket and file that the mailbox export job exports to.</p>
|
|
2190
2467
|
*/
|
|
2191
2468
|
S3Path?: string;
|
|
2192
2469
|
/**
|
|
2470
|
+
* @public
|
|
2193
2471
|
* <p>The estimated progress of the mailbox export job, in percentage points.</p>
|
|
2194
2472
|
*/
|
|
2195
2473
|
EstimatedProgress?: number;
|
|
2196
2474
|
/**
|
|
2475
|
+
* @public
|
|
2197
2476
|
* <p>The state of the mailbox export job.</p>
|
|
2198
2477
|
*/
|
|
2199
2478
|
State?: MailboxExportJobState | string;
|
|
2200
2479
|
/**
|
|
2480
|
+
* @public
|
|
2201
2481
|
* <p>The mailbox export job start timestamp.</p>
|
|
2202
2482
|
*/
|
|
2203
2483
|
StartTime?: Date;
|
|
2204
2484
|
/**
|
|
2485
|
+
* @public
|
|
2205
2486
|
* <p>The mailbox export job end timestamp.</p>
|
|
2206
2487
|
*/
|
|
2207
2488
|
EndTime?: Date;
|
|
@@ -2211,6 +2492,7 @@ export interface MailboxExportJob {
|
|
|
2211
2492
|
*/
|
|
2212
2493
|
export interface ListAccessControlRulesRequest {
|
|
2213
2494
|
/**
|
|
2495
|
+
* @public
|
|
2214
2496
|
* <p>The identifier for the organization.</p>
|
|
2215
2497
|
*/
|
|
2216
2498
|
OrganizationId: string | undefined;
|
|
@@ -2220,6 +2502,7 @@ export interface ListAccessControlRulesRequest {
|
|
|
2220
2502
|
*/
|
|
2221
2503
|
export interface ListAccessControlRulesResponse {
|
|
2222
2504
|
/**
|
|
2505
|
+
* @public
|
|
2223
2506
|
* <p>The access control rules.</p>
|
|
2224
2507
|
*/
|
|
2225
2508
|
Rules?: AccessControlRule[];
|
|
@@ -2229,19 +2512,23 @@ export interface ListAccessControlRulesResponse {
|
|
|
2229
2512
|
*/
|
|
2230
2513
|
export interface ListAliasesRequest {
|
|
2231
2514
|
/**
|
|
2515
|
+
* @public
|
|
2232
2516
|
* <p>The identifier for the organization under which the entity exists.</p>
|
|
2233
2517
|
*/
|
|
2234
2518
|
OrganizationId: string | undefined;
|
|
2235
2519
|
/**
|
|
2520
|
+
* @public
|
|
2236
2521
|
* <p>The identifier for the entity for which to list the aliases.</p>
|
|
2237
2522
|
*/
|
|
2238
2523
|
EntityId: string | undefined;
|
|
2239
2524
|
/**
|
|
2525
|
+
* @public
|
|
2240
2526
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2241
2527
|
* contain any tokens.</p>
|
|
2242
2528
|
*/
|
|
2243
2529
|
NextToken?: string;
|
|
2244
2530
|
/**
|
|
2531
|
+
* @public
|
|
2245
2532
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2246
2533
|
*/
|
|
2247
2534
|
MaxResults?: number;
|
|
@@ -2251,10 +2538,12 @@ export interface ListAliasesRequest {
|
|
|
2251
2538
|
*/
|
|
2252
2539
|
export interface ListAliasesResponse {
|
|
2253
2540
|
/**
|
|
2541
|
+
* @public
|
|
2254
2542
|
* <p>The entity's paginated aliases.</p>
|
|
2255
2543
|
*/
|
|
2256
2544
|
Aliases?: string[];
|
|
2257
2545
|
/**
|
|
2546
|
+
* @public
|
|
2258
2547
|
* <p>The token to use to retrieve the next page of results. The value is "null" when there
|
|
2259
2548
|
* are no more results to return.</p>
|
|
2260
2549
|
*/
|
|
@@ -2265,15 +2554,18 @@ export interface ListAliasesResponse {
|
|
|
2265
2554
|
*/
|
|
2266
2555
|
export interface ListAvailabilityConfigurationsRequest {
|
|
2267
2556
|
/**
|
|
2557
|
+
* @public
|
|
2268
2558
|
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code>'s will be
|
|
2269
2559
|
* listed.</p>
|
|
2270
2560
|
*/
|
|
2271
2561
|
OrganizationId: string | undefined;
|
|
2272
2562
|
/**
|
|
2563
|
+
* @public
|
|
2273
2564
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2274
2565
|
*/
|
|
2275
2566
|
MaxResults?: number;
|
|
2276
2567
|
/**
|
|
2568
|
+
* @public
|
|
2277
2569
|
* <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
|
|
2278
2570
|
*/
|
|
2279
2571
|
NextToken?: string;
|
|
@@ -2283,10 +2575,12 @@ export interface ListAvailabilityConfigurationsRequest {
|
|
|
2283
2575
|
*/
|
|
2284
2576
|
export interface ListAvailabilityConfigurationsResponse {
|
|
2285
2577
|
/**
|
|
2578
|
+
* @public
|
|
2286
2579
|
* <p>The list of <code>AvailabilityConfiguration</code>'s that exist for the specified WorkMail organization.</p>
|
|
2287
2580
|
*/
|
|
2288
2581
|
AvailabilityConfigurations?: AvailabilityConfiguration[];
|
|
2289
2582
|
/**
|
|
2583
|
+
* @public
|
|
2290
2584
|
* <p>The token to use to retrieve the next page of results. The value is <code>null</code> when there are no further results to return.</p>
|
|
2291
2585
|
*/
|
|
2292
2586
|
NextToken?: string;
|
|
@@ -2296,20 +2590,24 @@ export interface ListAvailabilityConfigurationsResponse {
|
|
|
2296
2590
|
*/
|
|
2297
2591
|
export interface ListGroupMembersRequest {
|
|
2298
2592
|
/**
|
|
2593
|
+
* @public
|
|
2299
2594
|
* <p>The identifier for the organization under which the group exists.</p>
|
|
2300
2595
|
*/
|
|
2301
2596
|
OrganizationId: string | undefined;
|
|
2302
2597
|
/**
|
|
2598
|
+
* @public
|
|
2303
2599
|
* <p>The identifier for the group to which the members (users or groups) are
|
|
2304
2600
|
* associated.</p>
|
|
2305
2601
|
*/
|
|
2306
2602
|
GroupId: string | undefined;
|
|
2307
2603
|
/**
|
|
2604
|
+
* @public
|
|
2308
2605
|
* <p> The token to use to retrieve the next page of results. The first call does not
|
|
2309
2606
|
* contain any tokens.</p>
|
|
2310
2607
|
*/
|
|
2311
2608
|
NextToken?: string;
|
|
2312
2609
|
/**
|
|
2610
|
+
* @public
|
|
2313
2611
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2314
2612
|
*/
|
|
2315
2613
|
MaxResults?: number;
|
|
@@ -2320,26 +2618,32 @@ export interface ListGroupMembersRequest {
|
|
|
2320
2618
|
*/
|
|
2321
2619
|
export interface Member {
|
|
2322
2620
|
/**
|
|
2621
|
+
* @public
|
|
2323
2622
|
* <p>The identifier of the member.</p>
|
|
2324
2623
|
*/
|
|
2325
2624
|
Id?: string;
|
|
2326
2625
|
/**
|
|
2626
|
+
* @public
|
|
2327
2627
|
* <p>The name of the member.</p>
|
|
2328
2628
|
*/
|
|
2329
2629
|
Name?: string;
|
|
2330
2630
|
/**
|
|
2631
|
+
* @public
|
|
2331
2632
|
* <p>A member can be a user or group.</p>
|
|
2332
2633
|
*/
|
|
2333
2634
|
Type?: MemberType | string;
|
|
2334
2635
|
/**
|
|
2636
|
+
* @public
|
|
2335
2637
|
* <p>The state of the member, which can be ENABLED, DISABLED, or DELETED.</p>
|
|
2336
2638
|
*/
|
|
2337
2639
|
State?: EntityState | string;
|
|
2338
2640
|
/**
|
|
2641
|
+
* @public
|
|
2339
2642
|
* <p>The date indicating when the member was enabled for WorkMail use.</p>
|
|
2340
2643
|
*/
|
|
2341
2644
|
EnabledDate?: Date;
|
|
2342
2645
|
/**
|
|
2646
|
+
* @public
|
|
2343
2647
|
* <p>The date indicating when the member was disabled from WorkMail use.</p>
|
|
2344
2648
|
*/
|
|
2345
2649
|
DisabledDate?: Date;
|
|
@@ -2349,10 +2653,12 @@ export interface Member {
|
|
|
2349
2653
|
*/
|
|
2350
2654
|
export interface ListGroupMembersResponse {
|
|
2351
2655
|
/**
|
|
2656
|
+
* @public
|
|
2352
2657
|
* <p>The members associated to the group.</p>
|
|
2353
2658
|
*/
|
|
2354
2659
|
Members?: Member[];
|
|
2355
2660
|
/**
|
|
2661
|
+
* @public
|
|
2356
2662
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2357
2663
|
* contain any tokens.</p>
|
|
2358
2664
|
*/
|
|
@@ -2363,15 +2669,18 @@ export interface ListGroupMembersResponse {
|
|
|
2363
2669
|
*/
|
|
2364
2670
|
export interface ListGroupsRequest {
|
|
2365
2671
|
/**
|
|
2672
|
+
* @public
|
|
2366
2673
|
* <p>The identifier for the organization under which the groups exist.</p>
|
|
2367
2674
|
*/
|
|
2368
2675
|
OrganizationId: string | undefined;
|
|
2369
2676
|
/**
|
|
2677
|
+
* @public
|
|
2370
2678
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2371
2679
|
* contain any tokens.</p>
|
|
2372
2680
|
*/
|
|
2373
2681
|
NextToken?: string;
|
|
2374
2682
|
/**
|
|
2683
|
+
* @public
|
|
2375
2684
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2376
2685
|
*/
|
|
2377
2686
|
MaxResults?: number;
|
|
@@ -2381,10 +2690,12 @@ export interface ListGroupsRequest {
|
|
|
2381
2690
|
*/
|
|
2382
2691
|
export interface ListGroupsResponse {
|
|
2383
2692
|
/**
|
|
2693
|
+
* @public
|
|
2384
2694
|
* <p>The overview of groups for an organization.</p>
|
|
2385
2695
|
*/
|
|
2386
2696
|
Groups?: Group[];
|
|
2387
2697
|
/**
|
|
2698
|
+
* @public
|
|
2388
2699
|
* <p>The token to use to retrieve the next page of results. The value is "null" when there
|
|
2389
2700
|
* are no more results to return.</p>
|
|
2390
2701
|
*/
|
|
@@ -2395,15 +2706,18 @@ export interface ListGroupsResponse {
|
|
|
2395
2706
|
*/
|
|
2396
2707
|
export interface ListImpersonationRolesRequest {
|
|
2397
2708
|
/**
|
|
2709
|
+
* @public
|
|
2398
2710
|
* <p>The WorkMail organization to which the listed impersonation roles belong.</p>
|
|
2399
2711
|
*/
|
|
2400
2712
|
OrganizationId: string | undefined;
|
|
2401
2713
|
/**
|
|
2714
|
+
* @public
|
|
2402
2715
|
* <p>The token used to retrieve the next page of results. The first call doesn't require a
|
|
2403
2716
|
* token.</p>
|
|
2404
2717
|
*/
|
|
2405
2718
|
NextToken?: string;
|
|
2406
2719
|
/**
|
|
2720
|
+
* @public
|
|
2407
2721
|
* <p>The maximum number of results returned in a single call.</p>
|
|
2408
2722
|
*/
|
|
2409
2723
|
MaxResults?: number;
|
|
@@ -2413,10 +2727,12 @@ export interface ListImpersonationRolesRequest {
|
|
|
2413
2727
|
*/
|
|
2414
2728
|
export interface ListImpersonationRolesResponse {
|
|
2415
2729
|
/**
|
|
2730
|
+
* @public
|
|
2416
2731
|
* <p>The list of impersonation roles under the given WorkMail organization.</p>
|
|
2417
2732
|
*/
|
|
2418
2733
|
Roles?: ImpersonationRole[];
|
|
2419
2734
|
/**
|
|
2735
|
+
* @public
|
|
2420
2736
|
* <p>The token to retrieve the next page of results. The value is <code>null</code> when
|
|
2421
2737
|
* there are no results to return.</p>
|
|
2422
2738
|
*/
|
|
@@ -2427,14 +2743,17 @@ export interface ListImpersonationRolesResponse {
|
|
|
2427
2743
|
*/
|
|
2428
2744
|
export interface ListMailboxExportJobsRequest {
|
|
2429
2745
|
/**
|
|
2746
|
+
* @public
|
|
2430
2747
|
* <p>The organization ID.</p>
|
|
2431
2748
|
*/
|
|
2432
2749
|
OrganizationId: string | undefined;
|
|
2433
2750
|
/**
|
|
2751
|
+
* @public
|
|
2434
2752
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
2435
2753
|
*/
|
|
2436
2754
|
NextToken?: string;
|
|
2437
2755
|
/**
|
|
2756
|
+
* @public
|
|
2438
2757
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2439
2758
|
*/
|
|
2440
2759
|
MaxResults?: number;
|
|
@@ -2444,10 +2763,12 @@ export interface ListMailboxExportJobsRequest {
|
|
|
2444
2763
|
*/
|
|
2445
2764
|
export interface ListMailboxExportJobsResponse {
|
|
2446
2765
|
/**
|
|
2766
|
+
* @public
|
|
2447
2767
|
* <p>The mailbox export job details.</p>
|
|
2448
2768
|
*/
|
|
2449
2769
|
Jobs?: MailboxExportJob[];
|
|
2450
2770
|
/**
|
|
2771
|
+
* @public
|
|
2451
2772
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
2452
2773
|
*/
|
|
2453
2774
|
NextToken?: string;
|
|
@@ -2457,21 +2778,25 @@ export interface ListMailboxExportJobsResponse {
|
|
|
2457
2778
|
*/
|
|
2458
2779
|
export interface ListMailboxPermissionsRequest {
|
|
2459
2780
|
/**
|
|
2781
|
+
* @public
|
|
2460
2782
|
* <p>The identifier of the organization under which the user, group, or resource
|
|
2461
2783
|
* exists.</p>
|
|
2462
2784
|
*/
|
|
2463
2785
|
OrganizationId: string | undefined;
|
|
2464
2786
|
/**
|
|
2787
|
+
* @public
|
|
2465
2788
|
* <p>The identifier of the user, group, or resource for which to list mailbox
|
|
2466
2789
|
* permissions.</p>
|
|
2467
2790
|
*/
|
|
2468
2791
|
EntityId: string | undefined;
|
|
2469
2792
|
/**
|
|
2793
|
+
* @public
|
|
2470
2794
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2471
2795
|
* contain any tokens.</p>
|
|
2472
2796
|
*/
|
|
2473
2797
|
NextToken?: string;
|
|
2474
2798
|
/**
|
|
2799
|
+
* @public
|
|
2475
2800
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2476
2801
|
*/
|
|
2477
2802
|
MaxResults?: number;
|
|
@@ -2496,15 +2821,18 @@ export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType
|
|
|
2496
2821
|
*/
|
|
2497
2822
|
export interface Permission {
|
|
2498
2823
|
/**
|
|
2824
|
+
* @public
|
|
2499
2825
|
* <p>The identifier of the user, group, or resource to which the permissions are
|
|
2500
2826
|
* granted.</p>
|
|
2501
2827
|
*/
|
|
2502
2828
|
GranteeId: string | undefined;
|
|
2503
2829
|
/**
|
|
2830
|
+
* @public
|
|
2504
2831
|
* <p>The type of user, group, or resource referred to in GranteeId.</p>
|
|
2505
2832
|
*/
|
|
2506
2833
|
GranteeType: MemberType | string | undefined;
|
|
2507
2834
|
/**
|
|
2835
|
+
* @public
|
|
2508
2836
|
* <p>The permissions granted to the grantee. SEND_AS allows the grantee to send email as
|
|
2509
2837
|
* the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF
|
|
2510
2838
|
* allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not
|
|
@@ -2519,10 +2847,12 @@ export interface Permission {
|
|
|
2519
2847
|
*/
|
|
2520
2848
|
export interface ListMailboxPermissionsResponse {
|
|
2521
2849
|
/**
|
|
2850
|
+
* @public
|
|
2522
2851
|
* <p>One page of the user, group, or resource mailbox permissions.</p>
|
|
2523
2852
|
*/
|
|
2524
2853
|
Permissions?: Permission[];
|
|
2525
2854
|
/**
|
|
2855
|
+
* @public
|
|
2526
2856
|
* <p>The token to use to retrieve the next page of results. The value is "null" when there
|
|
2527
2857
|
* are no more results to return.</p>
|
|
2528
2858
|
*/
|
|
@@ -2533,14 +2863,17 @@ export interface ListMailboxPermissionsResponse {
|
|
|
2533
2863
|
*/
|
|
2534
2864
|
export interface ListMailDomainsRequest {
|
|
2535
2865
|
/**
|
|
2866
|
+
* @public
|
|
2536
2867
|
* <p>The WorkMail organization for which to list domains.</p>
|
|
2537
2868
|
*/
|
|
2538
2869
|
OrganizationId: string | undefined;
|
|
2539
2870
|
/**
|
|
2871
|
+
* @public
|
|
2540
2872
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2541
2873
|
*/
|
|
2542
2874
|
MaxResults?: number;
|
|
2543
2875
|
/**
|
|
2876
|
+
* @public
|
|
2544
2877
|
* <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
|
|
2545
2878
|
*/
|
|
2546
2879
|
NextToken?: string;
|
|
@@ -2551,10 +2884,12 @@ export interface ListMailDomainsRequest {
|
|
|
2551
2884
|
*/
|
|
2552
2885
|
export interface MailDomainSummary {
|
|
2553
2886
|
/**
|
|
2887
|
+
* @public
|
|
2554
2888
|
* <p>The domain name.</p>
|
|
2555
2889
|
*/
|
|
2556
2890
|
DomainName?: string;
|
|
2557
2891
|
/**
|
|
2892
|
+
* @public
|
|
2558
2893
|
* <p>Whether the domain is default or not.</p>
|
|
2559
2894
|
*/
|
|
2560
2895
|
DefaultDomain?: boolean;
|
|
@@ -2564,10 +2899,12 @@ export interface MailDomainSummary {
|
|
|
2564
2899
|
*/
|
|
2565
2900
|
export interface ListMailDomainsResponse {
|
|
2566
2901
|
/**
|
|
2902
|
+
* @public
|
|
2567
2903
|
* <p>The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default.</p>
|
|
2568
2904
|
*/
|
|
2569
2905
|
MailDomains?: MailDomainSummary[];
|
|
2570
2906
|
/**
|
|
2907
|
+
* @public
|
|
2571
2908
|
* <p>The token to use to retrieve the next page of results. The value becomes <code>null</code> when there are no more results to return.</p>
|
|
2572
2909
|
*/
|
|
2573
2910
|
NextToken?: string;
|
|
@@ -2577,10 +2914,12 @@ export interface ListMailDomainsResponse {
|
|
|
2577
2914
|
*/
|
|
2578
2915
|
export interface ListMobileDeviceAccessOverridesRequest {
|
|
2579
2916
|
/**
|
|
2917
|
+
* @public
|
|
2580
2918
|
* <p>The WorkMail organization under which to list mobile device access overrides.</p>
|
|
2581
2919
|
*/
|
|
2582
2920
|
OrganizationId: string | undefined;
|
|
2583
2921
|
/**
|
|
2922
|
+
* @public
|
|
2584
2923
|
* <p>The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:</p>
|
|
2585
2924
|
* <ul>
|
|
2586
2925
|
* <li>
|
|
@@ -2599,14 +2938,17 @@ export interface ListMobileDeviceAccessOverridesRequest {
|
|
|
2599
2938
|
*/
|
|
2600
2939
|
UserId?: string;
|
|
2601
2940
|
/**
|
|
2941
|
+
* @public
|
|
2602
2942
|
* <p>The mobile device to which the access override applies.</p>
|
|
2603
2943
|
*/
|
|
2604
2944
|
DeviceId?: string;
|
|
2605
2945
|
/**
|
|
2946
|
+
* @public
|
|
2606
2947
|
* <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
|
|
2607
2948
|
*/
|
|
2608
2949
|
NextToken?: string;
|
|
2609
2950
|
/**
|
|
2951
|
+
* @public
|
|
2610
2952
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2611
2953
|
*/
|
|
2612
2954
|
MaxResults?: number;
|
|
@@ -2617,26 +2959,32 @@ export interface ListMobileDeviceAccessOverridesRequest {
|
|
|
2617
2959
|
*/
|
|
2618
2960
|
export interface MobileDeviceAccessOverride {
|
|
2619
2961
|
/**
|
|
2962
|
+
* @public
|
|
2620
2963
|
* <p>The WorkMail user to which the access override applies.</p>
|
|
2621
2964
|
*/
|
|
2622
2965
|
UserId?: string;
|
|
2623
2966
|
/**
|
|
2967
|
+
* @public
|
|
2624
2968
|
* <p>The device to which the override applies.</p>
|
|
2625
2969
|
*/
|
|
2626
2970
|
DeviceId?: string;
|
|
2627
2971
|
/**
|
|
2972
|
+
* @public
|
|
2628
2973
|
* <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
2629
2974
|
*/
|
|
2630
2975
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
2631
2976
|
/**
|
|
2977
|
+
* @public
|
|
2632
2978
|
* <p>A description of the override.</p>
|
|
2633
2979
|
*/
|
|
2634
2980
|
Description?: string;
|
|
2635
2981
|
/**
|
|
2982
|
+
* @public
|
|
2636
2983
|
* <p>The date the override was first created.</p>
|
|
2637
2984
|
*/
|
|
2638
2985
|
DateCreated?: Date;
|
|
2639
2986
|
/**
|
|
2987
|
+
* @public
|
|
2640
2988
|
* <p>The date the override was last modified.</p>
|
|
2641
2989
|
*/
|
|
2642
2990
|
DateModified?: Date;
|
|
@@ -2646,10 +2994,12 @@ export interface MobileDeviceAccessOverride {
|
|
|
2646
2994
|
*/
|
|
2647
2995
|
export interface ListMobileDeviceAccessOverridesResponse {
|
|
2648
2996
|
/**
|
|
2997
|
+
* @public
|
|
2649
2998
|
* <p>The list of mobile device access overrides that exist for the specified WorkMail organization and user.</p>
|
|
2650
2999
|
*/
|
|
2651
3000
|
Overrides?: MobileDeviceAccessOverride[];
|
|
2652
3001
|
/**
|
|
3002
|
+
* @public
|
|
2653
3003
|
* <p>The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.</p>
|
|
2654
3004
|
*/
|
|
2655
3005
|
NextToken?: string;
|
|
@@ -2659,6 +3009,7 @@ export interface ListMobileDeviceAccessOverridesResponse {
|
|
|
2659
3009
|
*/
|
|
2660
3010
|
export interface ListMobileDeviceAccessRulesRequest {
|
|
2661
3011
|
/**
|
|
3012
|
+
* @public
|
|
2662
3013
|
* <p>The WorkMail organization for which to list the rules.</p>
|
|
2663
3014
|
*/
|
|
2664
3015
|
OrganizationId: string | undefined;
|
|
@@ -2669,58 +3020,72 @@ export interface ListMobileDeviceAccessRulesRequest {
|
|
|
2669
3020
|
*/
|
|
2670
3021
|
export interface MobileDeviceAccessRule {
|
|
2671
3022
|
/**
|
|
3023
|
+
* @public
|
|
2672
3024
|
* <p>The ID assigned to a mobile access rule.</p>
|
|
2673
3025
|
*/
|
|
2674
3026
|
MobileDeviceAccessRuleId?: string;
|
|
2675
3027
|
/**
|
|
3028
|
+
* @public
|
|
2676
3029
|
* <p>The name of a mobile access rule.</p>
|
|
2677
3030
|
*/
|
|
2678
3031
|
Name?: string;
|
|
2679
3032
|
/**
|
|
3033
|
+
* @public
|
|
2680
3034
|
* <p>The description of a mobile access rule.</p>
|
|
2681
3035
|
*/
|
|
2682
3036
|
Description?: string;
|
|
2683
3037
|
/**
|
|
3038
|
+
* @public
|
|
2684
3039
|
* <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
2685
3040
|
*/
|
|
2686
3041
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
2687
3042
|
/**
|
|
3043
|
+
* @public
|
|
2688
3044
|
* <p>Device types that a rule will match.</p>
|
|
2689
3045
|
*/
|
|
2690
3046
|
DeviceTypes?: string[];
|
|
2691
3047
|
/**
|
|
3048
|
+
* @public
|
|
2692
3049
|
* <p>Device types that a rule <b>will not</b> match. All other device types will match.</p>
|
|
2693
3050
|
*/
|
|
2694
3051
|
NotDeviceTypes?: string[];
|
|
2695
3052
|
/**
|
|
3053
|
+
* @public
|
|
2696
3054
|
* <p>Device models that a rule will match.</p>
|
|
2697
3055
|
*/
|
|
2698
3056
|
DeviceModels?: string[];
|
|
2699
3057
|
/**
|
|
3058
|
+
* @public
|
|
2700
3059
|
* <p>Device models that a rule <b>will not</b> match. All other device models will match.</p>
|
|
2701
3060
|
*/
|
|
2702
3061
|
NotDeviceModels?: string[];
|
|
2703
3062
|
/**
|
|
3063
|
+
* @public
|
|
2704
3064
|
* <p>Device operating systems that a rule will match.</p>
|
|
2705
3065
|
*/
|
|
2706
3066
|
DeviceOperatingSystems?: string[];
|
|
2707
3067
|
/**
|
|
3068
|
+
* @public
|
|
2708
3069
|
* <p>Device operating systems that a rule <b>will not</b> match. All other device types will match.</p>
|
|
2709
3070
|
*/
|
|
2710
3071
|
NotDeviceOperatingSystems?: string[];
|
|
2711
3072
|
/**
|
|
3073
|
+
* @public
|
|
2712
3074
|
* <p>Device user agents that a rule will match.</p>
|
|
2713
3075
|
*/
|
|
2714
3076
|
DeviceUserAgents?: string[];
|
|
2715
3077
|
/**
|
|
3078
|
+
* @public
|
|
2716
3079
|
* <p>Device user agents that a rule <b>will not</b> match. All other device user agents will match.</p>
|
|
2717
3080
|
*/
|
|
2718
3081
|
NotDeviceUserAgents?: string[];
|
|
2719
3082
|
/**
|
|
3083
|
+
* @public
|
|
2720
3084
|
* <p>The date and time at which an access rule was created.</p>
|
|
2721
3085
|
*/
|
|
2722
3086
|
DateCreated?: Date;
|
|
2723
3087
|
/**
|
|
3088
|
+
* @public
|
|
2724
3089
|
* <p>The date and time at which an access rule was modified.</p>
|
|
2725
3090
|
*/
|
|
2726
3091
|
DateModified?: Date;
|
|
@@ -2730,6 +3095,7 @@ export interface MobileDeviceAccessRule {
|
|
|
2730
3095
|
*/
|
|
2731
3096
|
export interface ListMobileDeviceAccessRulesResponse {
|
|
2732
3097
|
/**
|
|
3098
|
+
* @public
|
|
2733
3099
|
* <p>The list of mobile device access rules that exist under the specified WorkMail organization.</p>
|
|
2734
3100
|
*/
|
|
2735
3101
|
Rules?: MobileDeviceAccessRule[];
|
|
@@ -2739,11 +3105,13 @@ export interface ListMobileDeviceAccessRulesResponse {
|
|
|
2739
3105
|
*/
|
|
2740
3106
|
export interface ListOrganizationsRequest {
|
|
2741
3107
|
/**
|
|
3108
|
+
* @public
|
|
2742
3109
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2743
3110
|
* contain any tokens.</p>
|
|
2744
3111
|
*/
|
|
2745
3112
|
NextToken?: string;
|
|
2746
3113
|
/**
|
|
3114
|
+
* @public
|
|
2747
3115
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2748
3116
|
*/
|
|
2749
3117
|
MaxResults?: number;
|
|
@@ -2754,24 +3122,29 @@ export interface ListOrganizationsRequest {
|
|
|
2754
3122
|
*/
|
|
2755
3123
|
export interface OrganizationSummary {
|
|
2756
3124
|
/**
|
|
3125
|
+
* @public
|
|
2757
3126
|
* <p>The identifier associated with the organization.</p>
|
|
2758
3127
|
*/
|
|
2759
3128
|
OrganizationId?: string;
|
|
2760
3129
|
/**
|
|
3130
|
+
* @public
|
|
2761
3131
|
* <p>The alias associated with the organization.</p>
|
|
2762
3132
|
*/
|
|
2763
3133
|
Alias?: string;
|
|
2764
3134
|
/**
|
|
3135
|
+
* @public
|
|
2765
3136
|
* <p>The default email domain associated with the organization.</p>
|
|
2766
3137
|
*/
|
|
2767
3138
|
DefaultMailDomain?: string;
|
|
2768
3139
|
/**
|
|
3140
|
+
* @public
|
|
2769
3141
|
* <p>The error message associated with the organization. It is only present if unexpected
|
|
2770
3142
|
* behavior has occurred with regards to the organization. It provides insight or solutions
|
|
2771
3143
|
* regarding unexpected behavior.</p>
|
|
2772
3144
|
*/
|
|
2773
3145
|
ErrorMessage?: string;
|
|
2774
3146
|
/**
|
|
3147
|
+
* @public
|
|
2775
3148
|
* <p>The state associated with the organization.</p>
|
|
2776
3149
|
*/
|
|
2777
3150
|
State?: string;
|
|
@@ -2781,11 +3154,13 @@ export interface OrganizationSummary {
|
|
|
2781
3154
|
*/
|
|
2782
3155
|
export interface ListOrganizationsResponse {
|
|
2783
3156
|
/**
|
|
3157
|
+
* @public
|
|
2784
3158
|
* <p>The overview of owned organizations presented as a list of organization
|
|
2785
3159
|
* summaries.</p>
|
|
2786
3160
|
*/
|
|
2787
3161
|
OrganizationSummaries?: OrganizationSummary[];
|
|
2788
3162
|
/**
|
|
3163
|
+
* @public
|
|
2789
3164
|
* <p>The token to use to retrieve the next page of results. The value is "null" when there
|
|
2790
3165
|
* are no more results to return.</p>
|
|
2791
3166
|
*/
|
|
@@ -2796,20 +3171,24 @@ export interface ListOrganizationsResponse {
|
|
|
2796
3171
|
*/
|
|
2797
3172
|
export interface ListResourceDelegatesRequest {
|
|
2798
3173
|
/**
|
|
3174
|
+
* @public
|
|
2799
3175
|
* <p>The identifier for the organization that contains the resource for which delegates
|
|
2800
3176
|
* are listed.</p>
|
|
2801
3177
|
*/
|
|
2802
3178
|
OrganizationId: string | undefined;
|
|
2803
3179
|
/**
|
|
3180
|
+
* @public
|
|
2804
3181
|
* <p>The identifier for the resource whose delegates are listed.</p>
|
|
2805
3182
|
*/
|
|
2806
3183
|
ResourceId: string | undefined;
|
|
2807
3184
|
/**
|
|
3185
|
+
* @public
|
|
2808
3186
|
* <p>The token used to paginate through the delegates associated with a
|
|
2809
3187
|
* resource.</p>
|
|
2810
3188
|
*/
|
|
2811
3189
|
NextToken?: string;
|
|
2812
3190
|
/**
|
|
3191
|
+
* @public
|
|
2813
3192
|
* <p>The number of maximum results in a page.</p>
|
|
2814
3193
|
*/
|
|
2815
3194
|
MaxResults?: number;
|
|
@@ -2819,10 +3198,12 @@ export interface ListResourceDelegatesRequest {
|
|
|
2819
3198
|
*/
|
|
2820
3199
|
export interface ListResourceDelegatesResponse {
|
|
2821
3200
|
/**
|
|
3201
|
+
* @public
|
|
2822
3202
|
* <p>One page of the resource's delegates.</p>
|
|
2823
3203
|
*/
|
|
2824
3204
|
Delegates?: Delegate[];
|
|
2825
3205
|
/**
|
|
3206
|
+
* @public
|
|
2826
3207
|
* <p>The token used to paginate through the delegates associated with a resource. While
|
|
2827
3208
|
* results are still available, it has an associated value. When the last page is reached, the
|
|
2828
3209
|
* token is empty.</p>
|
|
@@ -2834,15 +3215,18 @@ export interface ListResourceDelegatesResponse {
|
|
|
2834
3215
|
*/
|
|
2835
3216
|
export interface ListResourcesRequest {
|
|
2836
3217
|
/**
|
|
3218
|
+
* @public
|
|
2837
3219
|
* <p>The identifier for the organization under which the resources exist.</p>
|
|
2838
3220
|
*/
|
|
2839
3221
|
OrganizationId: string | undefined;
|
|
2840
3222
|
/**
|
|
3223
|
+
* @public
|
|
2841
3224
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2842
3225
|
* contain any tokens.</p>
|
|
2843
3226
|
*/
|
|
2844
3227
|
NextToken?: string;
|
|
2845
3228
|
/**
|
|
3229
|
+
* @public
|
|
2846
3230
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2847
3231
|
*/
|
|
2848
3232
|
MaxResults?: number;
|
|
@@ -2853,30 +3237,37 @@ export interface ListResourcesRequest {
|
|
|
2853
3237
|
*/
|
|
2854
3238
|
export interface Resource {
|
|
2855
3239
|
/**
|
|
3240
|
+
* @public
|
|
2856
3241
|
* <p>The identifier of the resource.</p>
|
|
2857
3242
|
*/
|
|
2858
3243
|
Id?: string;
|
|
2859
3244
|
/**
|
|
3245
|
+
* @public
|
|
2860
3246
|
* <p>The email of the resource.</p>
|
|
2861
3247
|
*/
|
|
2862
3248
|
Email?: string;
|
|
2863
3249
|
/**
|
|
3250
|
+
* @public
|
|
2864
3251
|
* <p>The name of the resource.</p>
|
|
2865
3252
|
*/
|
|
2866
3253
|
Name?: string;
|
|
2867
3254
|
/**
|
|
3255
|
+
* @public
|
|
2868
3256
|
* <p>The type of the resource: equipment or room.</p>
|
|
2869
3257
|
*/
|
|
2870
3258
|
Type?: ResourceType | string;
|
|
2871
3259
|
/**
|
|
3260
|
+
* @public
|
|
2872
3261
|
* <p>The state of the resource, which can be ENABLED, DISABLED, or DELETED.</p>
|
|
2873
3262
|
*/
|
|
2874
3263
|
State?: EntityState | string;
|
|
2875
3264
|
/**
|
|
3265
|
+
* @public
|
|
2876
3266
|
* <p>The date indicating when the resource was enabled for WorkMail use.</p>
|
|
2877
3267
|
*/
|
|
2878
3268
|
EnabledDate?: Date;
|
|
2879
3269
|
/**
|
|
3270
|
+
* @public
|
|
2880
3271
|
* <p>The date indicating when the resource was disabled from WorkMail use.</p>
|
|
2881
3272
|
*/
|
|
2882
3273
|
DisabledDate?: Date;
|
|
@@ -2886,10 +3277,12 @@ export interface Resource {
|
|
|
2886
3277
|
*/
|
|
2887
3278
|
export interface ListResourcesResponse {
|
|
2888
3279
|
/**
|
|
3280
|
+
* @public
|
|
2889
3281
|
* <p>One page of the organization's resource representation.</p>
|
|
2890
3282
|
*/
|
|
2891
3283
|
Resources?: Resource[];
|
|
2892
3284
|
/**
|
|
3285
|
+
* @public
|
|
2893
3286
|
* <p> The token used to paginate through all the organization's resources. While results
|
|
2894
3287
|
* are still available, it has an associated value. When the last page is reached, the token
|
|
2895
3288
|
* is empty.</p>
|
|
@@ -2901,6 +3294,7 @@ export interface ListResourcesResponse {
|
|
|
2901
3294
|
*/
|
|
2902
3295
|
export interface ListTagsForResourceRequest {
|
|
2903
3296
|
/**
|
|
3297
|
+
* @public
|
|
2904
3298
|
* <p>The resource ARN.</p>
|
|
2905
3299
|
*/
|
|
2906
3300
|
ResourceARN: string | undefined;
|
|
@@ -2911,10 +3305,12 @@ export interface ListTagsForResourceRequest {
|
|
|
2911
3305
|
*/
|
|
2912
3306
|
export interface Tag {
|
|
2913
3307
|
/**
|
|
3308
|
+
* @public
|
|
2914
3309
|
* <p>The key of the tag.</p>
|
|
2915
3310
|
*/
|
|
2916
3311
|
Key: string | undefined;
|
|
2917
3312
|
/**
|
|
3313
|
+
* @public
|
|
2918
3314
|
* <p>The value of the tag.</p>
|
|
2919
3315
|
*/
|
|
2920
3316
|
Value: string | undefined;
|
|
@@ -2924,6 +3320,7 @@ export interface Tag {
|
|
|
2924
3320
|
*/
|
|
2925
3321
|
export interface ListTagsForResourceResponse {
|
|
2926
3322
|
/**
|
|
3323
|
+
* @public
|
|
2927
3324
|
* <p>A list of tag key-value pairs.</p>
|
|
2928
3325
|
*/
|
|
2929
3326
|
Tags?: Tag[];
|
|
@@ -2933,15 +3330,18 @@ export interface ListTagsForResourceResponse {
|
|
|
2933
3330
|
*/
|
|
2934
3331
|
export interface ListUsersRequest {
|
|
2935
3332
|
/**
|
|
3333
|
+
* @public
|
|
2936
3334
|
* <p>The identifier for the organization under which the users exist.</p>
|
|
2937
3335
|
*/
|
|
2938
3336
|
OrganizationId: string | undefined;
|
|
2939
3337
|
/**
|
|
3338
|
+
* @public
|
|
2940
3339
|
* <p>The token to use to retrieve the next page of results. The first call does not
|
|
2941
3340
|
* contain any tokens.</p>
|
|
2942
3341
|
*/
|
|
2943
3342
|
NextToken?: string;
|
|
2944
3343
|
/**
|
|
3344
|
+
* @public
|
|
2945
3345
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2946
3346
|
*/
|
|
2947
3347
|
MaxResults?: number;
|
|
@@ -2952,34 +3352,42 @@ export interface ListUsersRequest {
|
|
|
2952
3352
|
*/
|
|
2953
3353
|
export interface User {
|
|
2954
3354
|
/**
|
|
3355
|
+
* @public
|
|
2955
3356
|
* <p>The identifier of the user.</p>
|
|
2956
3357
|
*/
|
|
2957
3358
|
Id?: string;
|
|
2958
3359
|
/**
|
|
3360
|
+
* @public
|
|
2959
3361
|
* <p>The email of the user.</p>
|
|
2960
3362
|
*/
|
|
2961
3363
|
Email?: string;
|
|
2962
3364
|
/**
|
|
3365
|
+
* @public
|
|
2963
3366
|
* <p>The name of the user.</p>
|
|
2964
3367
|
*/
|
|
2965
3368
|
Name?: string;
|
|
2966
3369
|
/**
|
|
3370
|
+
* @public
|
|
2967
3371
|
* <p>The display name of the user.</p>
|
|
2968
3372
|
*/
|
|
2969
3373
|
DisplayName?: string;
|
|
2970
3374
|
/**
|
|
3375
|
+
* @public
|
|
2971
3376
|
* <p>The state of the user, which can be ENABLED, DISABLED, or DELETED.</p>
|
|
2972
3377
|
*/
|
|
2973
3378
|
State?: EntityState | string;
|
|
2974
3379
|
/**
|
|
3380
|
+
* @public
|
|
2975
3381
|
* <p>The role of the user.</p>
|
|
2976
3382
|
*/
|
|
2977
3383
|
UserRole?: UserRole | string;
|
|
2978
3384
|
/**
|
|
3385
|
+
* @public
|
|
2979
3386
|
* <p>The date indicating when the user was enabled for WorkMail use.</p>
|
|
2980
3387
|
*/
|
|
2981
3388
|
EnabledDate?: Date;
|
|
2982
3389
|
/**
|
|
3390
|
+
* @public
|
|
2983
3391
|
* <p>The date indicating when the user was disabled from WorkMail use.</p>
|
|
2984
3392
|
*/
|
|
2985
3393
|
DisabledDate?: Date;
|
|
@@ -2989,10 +3397,12 @@ export interface User {
|
|
|
2989
3397
|
*/
|
|
2990
3398
|
export interface ListUsersResponse {
|
|
2991
3399
|
/**
|
|
3400
|
+
* @public
|
|
2992
3401
|
* <p>The overview of users for an organization.</p>
|
|
2993
3402
|
*/
|
|
2994
3403
|
Users?: User[];
|
|
2995
3404
|
/**
|
|
3405
|
+
* @public
|
|
2996
3406
|
* <p> The token to use to retrieve the next page of results. This value is `null` when
|
|
2997
3407
|
* there are no more results to return.</p>
|
|
2998
3408
|
*/
|
|
@@ -3003,54 +3413,66 @@ export interface ListUsersResponse {
|
|
|
3003
3413
|
*/
|
|
3004
3414
|
export interface PutAccessControlRuleRequest {
|
|
3005
3415
|
/**
|
|
3416
|
+
* @public
|
|
3006
3417
|
* <p>The rule name.</p>
|
|
3007
3418
|
*/
|
|
3008
3419
|
Name: string | undefined;
|
|
3009
3420
|
/**
|
|
3421
|
+
* @public
|
|
3010
3422
|
* <p>The rule effect.</p>
|
|
3011
3423
|
*/
|
|
3012
3424
|
Effect: AccessControlRuleEffect | string | undefined;
|
|
3013
3425
|
/**
|
|
3426
|
+
* @public
|
|
3014
3427
|
* <p>The rule description.</p>
|
|
3015
3428
|
*/
|
|
3016
3429
|
Description: string | undefined;
|
|
3017
3430
|
/**
|
|
3431
|
+
* @public
|
|
3018
3432
|
* <p>IPv4 CIDR ranges to include in the rule.</p>
|
|
3019
3433
|
*/
|
|
3020
3434
|
IpRanges?: string[];
|
|
3021
3435
|
/**
|
|
3436
|
+
* @public
|
|
3022
3437
|
* <p>IPv4 CIDR ranges to exclude from the rule.</p>
|
|
3023
3438
|
*/
|
|
3024
3439
|
NotIpRanges?: string[];
|
|
3025
3440
|
/**
|
|
3441
|
+
* @public
|
|
3026
3442
|
* <p>Access protocol actions to include in the rule. Valid values include
|
|
3027
3443
|
* <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
|
|
3028
3444
|
* <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
|
|
3029
3445
|
*/
|
|
3030
3446
|
Actions?: string[];
|
|
3031
3447
|
/**
|
|
3448
|
+
* @public
|
|
3032
3449
|
* <p>Access protocol actions to exclude from the rule. Valid values include
|
|
3033
3450
|
* <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
|
|
3034
3451
|
* <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
|
|
3035
3452
|
*/
|
|
3036
3453
|
NotActions?: string[];
|
|
3037
3454
|
/**
|
|
3455
|
+
* @public
|
|
3038
3456
|
* <p>User IDs to include in the rule.</p>
|
|
3039
3457
|
*/
|
|
3040
3458
|
UserIds?: string[];
|
|
3041
3459
|
/**
|
|
3460
|
+
* @public
|
|
3042
3461
|
* <p>User IDs to exclude from the rule.</p>
|
|
3043
3462
|
*/
|
|
3044
3463
|
NotUserIds?: string[];
|
|
3045
3464
|
/**
|
|
3465
|
+
* @public
|
|
3046
3466
|
* <p>The identifier of the organization.</p>
|
|
3047
3467
|
*/
|
|
3048
3468
|
OrganizationId: string | undefined;
|
|
3049
3469
|
/**
|
|
3470
|
+
* @public
|
|
3050
3471
|
* <p>Impersonation role IDs to include in the rule.</p>
|
|
3051
3472
|
*/
|
|
3052
3473
|
ImpersonationRoleIds?: string[];
|
|
3053
3474
|
/**
|
|
3475
|
+
* @public
|
|
3054
3476
|
* <p>Impersonation role IDs to exclude from the rule.</p>
|
|
3055
3477
|
*/
|
|
3056
3478
|
NotImpersonationRoleIds?: string[];
|
|
@@ -3065,14 +3487,17 @@ export interface PutAccessControlRuleResponse {
|
|
|
3065
3487
|
*/
|
|
3066
3488
|
export interface PutEmailMonitoringConfigurationRequest {
|
|
3067
3489
|
/**
|
|
3490
|
+
* @public
|
|
3068
3491
|
* <p>The ID of the organization for which the email monitoring configuration is set.</p>
|
|
3069
3492
|
*/
|
|
3070
3493
|
OrganizationId: string | undefined;
|
|
3071
3494
|
/**
|
|
3495
|
+
* @public
|
|
3072
3496
|
* <p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>
|
|
3073
3497
|
*/
|
|
3074
3498
|
RoleArn: string | undefined;
|
|
3075
3499
|
/**
|
|
3500
|
+
* @public
|
|
3076
3501
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>
|
|
3077
3502
|
*/
|
|
3078
3503
|
LogGroupArn: string | undefined;
|
|
@@ -3087,10 +3512,12 @@ export interface PutEmailMonitoringConfigurationResponse {
|
|
|
3087
3512
|
*/
|
|
3088
3513
|
export interface PutInboundDmarcSettingsRequest {
|
|
3089
3514
|
/**
|
|
3515
|
+
* @public
|
|
3090
3516
|
* <p>The ID of the organization that you are applying the DMARC policy to.</p>
|
|
3091
3517
|
*/
|
|
3092
3518
|
OrganizationId: string | undefined;
|
|
3093
3519
|
/**
|
|
3520
|
+
* @public
|
|
3094
3521
|
* <p>Enforces or suspends a policy after it's applied.</p>
|
|
3095
3522
|
*/
|
|
3096
3523
|
Enforced: boolean | undefined;
|
|
@@ -3105,21 +3532,25 @@ export interface PutInboundDmarcSettingsResponse {
|
|
|
3105
3532
|
*/
|
|
3106
3533
|
export interface PutMailboxPermissionsRequest {
|
|
3107
3534
|
/**
|
|
3535
|
+
* @public
|
|
3108
3536
|
* <p>The identifier of the organization under which the user, group, or resource
|
|
3109
3537
|
* exists.</p>
|
|
3110
3538
|
*/
|
|
3111
3539
|
OrganizationId: string | undefined;
|
|
3112
3540
|
/**
|
|
3541
|
+
* @public
|
|
3113
3542
|
* <p>The identifier of the user, group, or resource for which to update mailbox
|
|
3114
3543
|
* permissions.</p>
|
|
3115
3544
|
*/
|
|
3116
3545
|
EntityId: string | undefined;
|
|
3117
3546
|
/**
|
|
3547
|
+
* @public
|
|
3118
3548
|
* <p>The identifier of the user, group, or resource to which to grant the
|
|
3119
3549
|
* permissions.</p>
|
|
3120
3550
|
*/
|
|
3121
3551
|
GranteeId: string | undefined;
|
|
3122
3552
|
/**
|
|
3553
|
+
* @public
|
|
3123
3554
|
* <p>The permissions granted to the grantee. SEND_AS allows the grantee to send email as
|
|
3124
3555
|
* the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF
|
|
3125
3556
|
* allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not
|
|
@@ -3139,10 +3570,12 @@ export interface PutMailboxPermissionsResponse {
|
|
|
3139
3570
|
*/
|
|
3140
3571
|
export interface PutMobileDeviceAccessOverrideRequest {
|
|
3141
3572
|
/**
|
|
3573
|
+
* @public
|
|
3142
3574
|
* <p>Identifies the WorkMail organization for which you create the override.</p>
|
|
3143
3575
|
*/
|
|
3144
3576
|
OrganizationId: string | undefined;
|
|
3145
3577
|
/**
|
|
3578
|
+
* @public
|
|
3146
3579
|
* <p>The WorkMail user for which you create the override. Accepts the following types of user identities:</p>
|
|
3147
3580
|
* <ul>
|
|
3148
3581
|
* <li>
|
|
@@ -3161,14 +3594,17 @@ export interface PutMobileDeviceAccessOverrideRequest {
|
|
|
3161
3594
|
*/
|
|
3162
3595
|
UserId: string | undefined;
|
|
3163
3596
|
/**
|
|
3597
|
+
* @public
|
|
3164
3598
|
* <p>The mobile device for which you create the override. <code>DeviceId</code> is case insensitive.</p>
|
|
3165
3599
|
*/
|
|
3166
3600
|
DeviceId: string | undefined;
|
|
3167
3601
|
/**
|
|
3602
|
+
* @public
|
|
3168
3603
|
* <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
3169
3604
|
*/
|
|
3170
3605
|
Effect: MobileDeviceAccessRuleEffect | string | undefined;
|
|
3171
3606
|
/**
|
|
3607
|
+
* @public
|
|
3172
3608
|
* <p>A description of the override.</p>
|
|
3173
3609
|
*/
|
|
3174
3610
|
Description?: string;
|
|
@@ -3183,22 +3619,27 @@ export interface PutMobileDeviceAccessOverrideResponse {
|
|
|
3183
3619
|
*/
|
|
3184
3620
|
export interface PutRetentionPolicyRequest {
|
|
3185
3621
|
/**
|
|
3622
|
+
* @public
|
|
3186
3623
|
* <p>The organization ID.</p>
|
|
3187
3624
|
*/
|
|
3188
3625
|
OrganizationId: string | undefined;
|
|
3189
3626
|
/**
|
|
3627
|
+
* @public
|
|
3190
3628
|
* <p>The retention policy ID.</p>
|
|
3191
3629
|
*/
|
|
3192
3630
|
Id?: string;
|
|
3193
3631
|
/**
|
|
3632
|
+
* @public
|
|
3194
3633
|
* <p>The retention policy name.</p>
|
|
3195
3634
|
*/
|
|
3196
3635
|
Name: string | undefined;
|
|
3197
3636
|
/**
|
|
3637
|
+
* @public
|
|
3198
3638
|
* <p>The retention policy description.</p>
|
|
3199
3639
|
*/
|
|
3200
3640
|
Description?: string;
|
|
3201
3641
|
/**
|
|
3642
|
+
* @public
|
|
3202
3643
|
* <p>The retention policy folder configurations.</p>
|
|
3203
3644
|
*/
|
|
3204
3645
|
FolderConfigurations: FolderConfiguration[] | undefined;
|
|
@@ -3213,14 +3654,17 @@ export interface PutRetentionPolicyResponse {
|
|
|
3213
3654
|
*/
|
|
3214
3655
|
export interface RegisterMailDomainRequest {
|
|
3215
3656
|
/**
|
|
3657
|
+
* @public
|
|
3216
3658
|
* <p>Idempotency token used when retrying requests.</p>
|
|
3217
3659
|
*/
|
|
3218
3660
|
ClientToken?: string;
|
|
3219
3661
|
/**
|
|
3662
|
+
* @public
|
|
3220
3663
|
* <p>The WorkMail organization under which you're creating the domain.</p>
|
|
3221
3664
|
*/
|
|
3222
3665
|
OrganizationId: string | undefined;
|
|
3223
3666
|
/**
|
|
3667
|
+
* @public
|
|
3224
3668
|
* <p>The name of the mail domain to create in WorkMail and SES.</p>
|
|
3225
3669
|
*/
|
|
3226
3670
|
DomainName: string | undefined;
|
|
@@ -3235,15 +3679,18 @@ export interface RegisterMailDomainResponse {
|
|
|
3235
3679
|
*/
|
|
3236
3680
|
export interface RegisterToWorkMailRequest {
|
|
3237
3681
|
/**
|
|
3682
|
+
* @public
|
|
3238
3683
|
* <p>The identifier for the organization under which the user, group, or resource
|
|
3239
3684
|
* exists.</p>
|
|
3240
3685
|
*/
|
|
3241
3686
|
OrganizationId: string | undefined;
|
|
3242
3687
|
/**
|
|
3688
|
+
* @public
|
|
3243
3689
|
* <p>The identifier for the user, group, or resource to be updated.</p>
|
|
3244
3690
|
*/
|
|
3245
3691
|
EntityId: string | undefined;
|
|
3246
3692
|
/**
|
|
3693
|
+
* @public
|
|
3247
3694
|
* <p>The email for the user, group, or resource to be updated.</p>
|
|
3248
3695
|
*/
|
|
3249
3696
|
Email: string | undefined;
|
|
@@ -3258,15 +3705,18 @@ export interface RegisterToWorkMailResponse {
|
|
|
3258
3705
|
*/
|
|
3259
3706
|
export interface ResetPasswordRequest {
|
|
3260
3707
|
/**
|
|
3708
|
+
* @public
|
|
3261
3709
|
* <p>The identifier of the organization that contains the user for which the password is
|
|
3262
3710
|
* reset.</p>
|
|
3263
3711
|
*/
|
|
3264
3712
|
OrganizationId: string | undefined;
|
|
3265
3713
|
/**
|
|
3714
|
+
* @public
|
|
3266
3715
|
* <p>The identifier of the user for whom the password is reset.</p>
|
|
3267
3716
|
*/
|
|
3268
3717
|
UserId: string | undefined;
|
|
3269
3718
|
/**
|
|
3719
|
+
* @public
|
|
3270
3720
|
* <p>The new password for the user.</p>
|
|
3271
3721
|
*/
|
|
3272
3722
|
Password: string | undefined;
|
|
@@ -3281,36 +3731,44 @@ export interface ResetPasswordResponse {
|
|
|
3281
3731
|
*/
|
|
3282
3732
|
export interface StartMailboxExportJobRequest {
|
|
3283
3733
|
/**
|
|
3734
|
+
* @public
|
|
3284
3735
|
* <p>The idempotency token for the client request.</p>
|
|
3285
3736
|
*/
|
|
3286
3737
|
ClientToken?: string;
|
|
3287
3738
|
/**
|
|
3739
|
+
* @public
|
|
3288
3740
|
* <p>The identifier associated with the organization.</p>
|
|
3289
3741
|
*/
|
|
3290
3742
|
OrganizationId: string | undefined;
|
|
3291
3743
|
/**
|
|
3744
|
+
* @public
|
|
3292
3745
|
* <p>The identifier of the user or resource associated with the mailbox.</p>
|
|
3293
3746
|
*/
|
|
3294
3747
|
EntityId: string | undefined;
|
|
3295
3748
|
/**
|
|
3749
|
+
* @public
|
|
3296
3750
|
* <p>The mailbox export job description.</p>
|
|
3297
3751
|
*/
|
|
3298
3752
|
Description?: string;
|
|
3299
3753
|
/**
|
|
3754
|
+
* @public
|
|
3300
3755
|
* <p>The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3
|
|
3301
3756
|
* bucket.</p>
|
|
3302
3757
|
*/
|
|
3303
3758
|
RoleArn: string | undefined;
|
|
3304
3759
|
/**
|
|
3760
|
+
* @public
|
|
3305
3761
|
* <p>The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)
|
|
3306
3762
|
* key that encrypts the exported mailbox content.</p>
|
|
3307
3763
|
*/
|
|
3308
3764
|
KmsKeyArn: string | undefined;
|
|
3309
3765
|
/**
|
|
3766
|
+
* @public
|
|
3310
3767
|
* <p>The name of the S3 bucket.</p>
|
|
3311
3768
|
*/
|
|
3312
3769
|
S3BucketName: string | undefined;
|
|
3313
3770
|
/**
|
|
3771
|
+
* @public
|
|
3314
3772
|
* <p>The S3 bucket prefix.</p>
|
|
3315
3773
|
*/
|
|
3316
3774
|
S3Prefix: string | undefined;
|
|
@@ -3320,6 +3778,7 @@ export interface StartMailboxExportJobRequest {
|
|
|
3320
3778
|
*/
|
|
3321
3779
|
export interface StartMailboxExportJobResponse {
|
|
3322
3780
|
/**
|
|
3781
|
+
* @public
|
|
3323
3782
|
* <p>The job ID.</p>
|
|
3324
3783
|
*/
|
|
3325
3784
|
JobId?: string;
|
|
@@ -3329,10 +3788,12 @@ export interface StartMailboxExportJobResponse {
|
|
|
3329
3788
|
*/
|
|
3330
3789
|
export interface TagResourceRequest {
|
|
3331
3790
|
/**
|
|
3791
|
+
* @public
|
|
3332
3792
|
* <p>The resource ARN.</p>
|
|
3333
3793
|
*/
|
|
3334
3794
|
ResourceARN: string | undefined;
|
|
3335
3795
|
/**
|
|
3796
|
+
* @public
|
|
3336
3797
|
* <p>The tag key-value pairs.</p>
|
|
3337
3798
|
*/
|
|
3338
3799
|
Tags: Tag[] | undefined;
|
|
@@ -3360,18 +3821,22 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
3360
3821
|
*/
|
|
3361
3822
|
export interface TestAvailabilityConfigurationRequest {
|
|
3362
3823
|
/**
|
|
3824
|
+
* @public
|
|
3363
3825
|
* <p>The WorkMail organization where the availability provider will be tested.</p>
|
|
3364
3826
|
*/
|
|
3365
3827
|
OrganizationId: string | undefined;
|
|
3366
3828
|
/**
|
|
3829
|
+
* @public
|
|
3367
3830
|
* <p>The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.</p>
|
|
3368
3831
|
*/
|
|
3369
3832
|
DomainName?: string;
|
|
3370
3833
|
/**
|
|
3834
|
+
* @public
|
|
3371
3835
|
* <p>Describes an EWS based availability provider. This is only used as input to the service.</p>
|
|
3372
3836
|
*/
|
|
3373
3837
|
EwsProvider?: EwsAvailabilityProvider;
|
|
3374
3838
|
/**
|
|
3839
|
+
* @public
|
|
3375
3840
|
* <p>Describes a Lambda based availability provider.</p>
|
|
3376
3841
|
*/
|
|
3377
3842
|
LambdaProvider?: LambdaAvailabilityProvider;
|
|
@@ -3381,10 +3846,12 @@ export interface TestAvailabilityConfigurationRequest {
|
|
|
3381
3846
|
*/
|
|
3382
3847
|
export interface TestAvailabilityConfigurationResponse {
|
|
3383
3848
|
/**
|
|
3849
|
+
* @public
|
|
3384
3850
|
* <p>Boolean indicating whether the test passed or failed.</p>
|
|
3385
3851
|
*/
|
|
3386
3852
|
TestPassed?: boolean;
|
|
3387
3853
|
/**
|
|
3854
|
+
* @public
|
|
3388
3855
|
* <p>String containing the reason for a failed test if <code>TestPassed</code> is false.</p>
|
|
3389
3856
|
*/
|
|
3390
3857
|
FailureReason?: string;
|
|
@@ -3394,10 +3861,12 @@ export interface TestAvailabilityConfigurationResponse {
|
|
|
3394
3861
|
*/
|
|
3395
3862
|
export interface UntagResourceRequest {
|
|
3396
3863
|
/**
|
|
3864
|
+
* @public
|
|
3397
3865
|
* <p>The resource ARN.</p>
|
|
3398
3866
|
*/
|
|
3399
3867
|
ResourceARN: string | undefined;
|
|
3400
3868
|
/**
|
|
3869
|
+
* @public
|
|
3401
3870
|
* <p>The tag keys.</p>
|
|
3402
3871
|
*/
|
|
3403
3872
|
TagKeys: string[] | undefined;
|
|
@@ -3412,21 +3881,25 @@ export interface UntagResourceResponse {
|
|
|
3412
3881
|
*/
|
|
3413
3882
|
export interface UpdateAvailabilityConfigurationRequest {
|
|
3414
3883
|
/**
|
|
3884
|
+
* @public
|
|
3415
3885
|
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be
|
|
3416
3886
|
* updated.</p>
|
|
3417
3887
|
*/
|
|
3418
3888
|
OrganizationId: string | undefined;
|
|
3419
3889
|
/**
|
|
3890
|
+
* @public
|
|
3420
3891
|
* <p>The domain to which the provider applies the availability configuration.</p>
|
|
3421
3892
|
*/
|
|
3422
3893
|
DomainName: string | undefined;
|
|
3423
3894
|
/**
|
|
3895
|
+
* @public
|
|
3424
3896
|
* <p>The EWS availability provider definition. The request must contain exactly one provider
|
|
3425
3897
|
* definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>. The previously
|
|
3426
3898
|
* stored provider will be overridden by the one provided.</p>
|
|
3427
3899
|
*/
|
|
3428
3900
|
EwsProvider?: EwsAvailabilityProvider;
|
|
3429
3901
|
/**
|
|
3902
|
+
* @public
|
|
3430
3903
|
* <p>The Lambda availability provider definition. The request must contain exactly one
|
|
3431
3904
|
* provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>. The
|
|
3432
3905
|
* previously stored provider will be overridden by the one provided.</p>
|
|
@@ -3443,10 +3916,12 @@ export interface UpdateAvailabilityConfigurationResponse {
|
|
|
3443
3916
|
*/
|
|
3444
3917
|
export interface UpdateDefaultMailDomainRequest {
|
|
3445
3918
|
/**
|
|
3919
|
+
* @public
|
|
3446
3920
|
* <p>The WorkMail organization for which to list domains.</p>
|
|
3447
3921
|
*/
|
|
3448
3922
|
OrganizationId: string | undefined;
|
|
3449
3923
|
/**
|
|
3924
|
+
* @public
|
|
3450
3925
|
* <p>The domain name that will become the default domain.</p>
|
|
3451
3926
|
*/
|
|
3452
3927
|
DomainName: string | undefined;
|
|
@@ -3461,26 +3936,32 @@ export interface UpdateDefaultMailDomainResponse {
|
|
|
3461
3936
|
*/
|
|
3462
3937
|
export interface UpdateImpersonationRoleRequest {
|
|
3463
3938
|
/**
|
|
3939
|
+
* @public
|
|
3464
3940
|
* <p>The WorkMail organization that contains the impersonation role to update.</p>
|
|
3465
3941
|
*/
|
|
3466
3942
|
OrganizationId: string | undefined;
|
|
3467
3943
|
/**
|
|
3944
|
+
* @public
|
|
3468
3945
|
* <p>The ID of the impersonation role to update.</p>
|
|
3469
3946
|
*/
|
|
3470
3947
|
ImpersonationRoleId: string | undefined;
|
|
3471
3948
|
/**
|
|
3949
|
+
* @public
|
|
3472
3950
|
* <p>The updated impersonation role name.</p>
|
|
3473
3951
|
*/
|
|
3474
3952
|
Name: string | undefined;
|
|
3475
3953
|
/**
|
|
3954
|
+
* @public
|
|
3476
3955
|
* <p>The updated impersonation role type.</p>
|
|
3477
3956
|
*/
|
|
3478
3957
|
Type: ImpersonationRoleType | string | undefined;
|
|
3479
3958
|
/**
|
|
3959
|
+
* @public
|
|
3480
3960
|
* <p>The updated impersonation role description.</p>
|
|
3481
3961
|
*/
|
|
3482
3962
|
Description?: string;
|
|
3483
3963
|
/**
|
|
3964
|
+
* @public
|
|
3484
3965
|
* <p>The updated list of rules.</p>
|
|
3485
3966
|
*/
|
|
3486
3967
|
Rules: ImpersonationRule[] | undefined;
|
|
@@ -3495,15 +3976,18 @@ export interface UpdateImpersonationRoleResponse {
|
|
|
3495
3976
|
*/
|
|
3496
3977
|
export interface UpdateMailboxQuotaRequest {
|
|
3497
3978
|
/**
|
|
3979
|
+
* @public
|
|
3498
3980
|
* <p>The identifier for the organization that contains the user for whom to update the
|
|
3499
3981
|
* mailbox quota.</p>
|
|
3500
3982
|
*/
|
|
3501
3983
|
OrganizationId: string | undefined;
|
|
3502
3984
|
/**
|
|
3985
|
+
* @public
|
|
3503
3986
|
* <p>The identifer for the user for whom to update the mailbox quota.</p>
|
|
3504
3987
|
*/
|
|
3505
3988
|
UserId: string | undefined;
|
|
3506
3989
|
/**
|
|
3990
|
+
* @public
|
|
3507
3991
|
* <p>The updated mailbox quota, in MB, for the specified user.</p>
|
|
3508
3992
|
*/
|
|
3509
3993
|
MailboxQuota: number | undefined;
|
|
@@ -3518,54 +4002,67 @@ export interface UpdateMailboxQuotaResponse {
|
|
|
3518
4002
|
*/
|
|
3519
4003
|
export interface UpdateMobileDeviceAccessRuleRequest {
|
|
3520
4004
|
/**
|
|
4005
|
+
* @public
|
|
3521
4006
|
* <p>The WorkMail organization under which the rule will be updated.</p>
|
|
3522
4007
|
*/
|
|
3523
4008
|
OrganizationId: string | undefined;
|
|
3524
4009
|
/**
|
|
4010
|
+
* @public
|
|
3525
4011
|
* <p>The identifier of the rule to be updated.</p>
|
|
3526
4012
|
*/
|
|
3527
4013
|
MobileDeviceAccessRuleId: string | undefined;
|
|
3528
4014
|
/**
|
|
4015
|
+
* @public
|
|
3529
4016
|
* <p>The updated rule name.</p>
|
|
3530
4017
|
*/
|
|
3531
4018
|
Name: string | undefined;
|
|
3532
4019
|
/**
|
|
4020
|
+
* @public
|
|
3533
4021
|
* <p>The updated rule description.</p>
|
|
3534
4022
|
*/
|
|
3535
4023
|
Description?: string;
|
|
3536
4024
|
/**
|
|
4025
|
+
* @public
|
|
3537
4026
|
* <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
3538
4027
|
*/
|
|
3539
4028
|
Effect: MobileDeviceAccessRuleEffect | string | undefined;
|
|
3540
4029
|
/**
|
|
4030
|
+
* @public
|
|
3541
4031
|
* <p>Device types that the updated rule will match.</p>
|
|
3542
4032
|
*/
|
|
3543
4033
|
DeviceTypes?: string[];
|
|
3544
4034
|
/**
|
|
4035
|
+
* @public
|
|
3545
4036
|
* <p>Device types that the updated rule <b>will not</b> match. All other device types will match.</p>
|
|
3546
4037
|
*/
|
|
3547
4038
|
NotDeviceTypes?: string[];
|
|
3548
4039
|
/**
|
|
4040
|
+
* @public
|
|
3549
4041
|
* <p>Device models that the updated rule will match.</p>
|
|
3550
4042
|
*/
|
|
3551
4043
|
DeviceModels?: string[];
|
|
3552
4044
|
/**
|
|
4045
|
+
* @public
|
|
3553
4046
|
* <p>Device models that the updated rule <b>will not</b> match. All other device models will match.</p>
|
|
3554
4047
|
*/
|
|
3555
4048
|
NotDeviceModels?: string[];
|
|
3556
4049
|
/**
|
|
4050
|
+
* @public
|
|
3557
4051
|
* <p>Device operating systems that the updated rule will match.</p>
|
|
3558
4052
|
*/
|
|
3559
4053
|
DeviceOperatingSystems?: string[];
|
|
3560
4054
|
/**
|
|
4055
|
+
* @public
|
|
3561
4056
|
* <p>Device operating systems that the updated rule <b>will not</b> match. All other device operating systems will match.</p>
|
|
3562
4057
|
*/
|
|
3563
4058
|
NotDeviceOperatingSystems?: string[];
|
|
3564
4059
|
/**
|
|
4060
|
+
* @public
|
|
3565
4061
|
* <p>User agents that the updated rule will match.</p>
|
|
3566
4062
|
*/
|
|
3567
4063
|
DeviceUserAgents?: string[];
|
|
3568
4064
|
/**
|
|
4065
|
+
* @public
|
|
3569
4066
|
* <p>User agents that the updated rule <b>will not</b> match. All other user agents will match.</p>
|
|
3570
4067
|
*/
|
|
3571
4068
|
NotDeviceUserAgents?: string[];
|
|
@@ -3580,14 +4077,17 @@ export interface UpdateMobileDeviceAccessRuleResponse {
|
|
|
3580
4077
|
*/
|
|
3581
4078
|
export interface UpdatePrimaryEmailAddressRequest {
|
|
3582
4079
|
/**
|
|
4080
|
+
* @public
|
|
3583
4081
|
* <p>The organization that contains the user, group, or resource to update.</p>
|
|
3584
4082
|
*/
|
|
3585
4083
|
OrganizationId: string | undefined;
|
|
3586
4084
|
/**
|
|
4085
|
+
* @public
|
|
3587
4086
|
* <p>The user, group, or resource to update.</p>
|
|
3588
4087
|
*/
|
|
3589
4088
|
EntityId: string | undefined;
|
|
3590
4089
|
/**
|
|
4090
|
+
* @public
|
|
3591
4091
|
* <p>The value of the email to be updated as primary.</p>
|
|
3592
4092
|
*/
|
|
3593
4093
|
Email: string | undefined;
|
|
@@ -3602,19 +4102,23 @@ export interface UpdatePrimaryEmailAddressResponse {
|
|
|
3602
4102
|
*/
|
|
3603
4103
|
export interface UpdateResourceRequest {
|
|
3604
4104
|
/**
|
|
4105
|
+
* @public
|
|
3605
4106
|
* <p>The identifier associated with the organization for which the resource is
|
|
3606
4107
|
* updated.</p>
|
|
3607
4108
|
*/
|
|
3608
4109
|
OrganizationId: string | undefined;
|
|
3609
4110
|
/**
|
|
4111
|
+
* @public
|
|
3610
4112
|
* <p>The identifier of the resource to be updated.</p>
|
|
3611
4113
|
*/
|
|
3612
4114
|
ResourceId: string | undefined;
|
|
3613
4115
|
/**
|
|
4116
|
+
* @public
|
|
3614
4117
|
* <p>The name of the resource to be updated.</p>
|
|
3615
4118
|
*/
|
|
3616
4119
|
Name?: string;
|
|
3617
4120
|
/**
|
|
4121
|
+
* @public
|
|
3618
4122
|
* <p>The resource's booking options to be updated.</p>
|
|
3619
4123
|
*/
|
|
3620
4124
|
BookingOptions?: BookingOptions;
|