@aws-sdk/client-workmail 3.183.0 → 3.185.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.
- package/CHANGELOG.md +22 -0
- package/README.md +1 -1
- package/dist-cjs/WorkMail.js +105 -0
- package/dist-cjs/commands/AssumeImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/CreateImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/DeleteImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/GetImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/GetImpersonationRoleEffectCommand.js +36 -0
- package/dist-cjs/commands/ListImpersonationRolesCommand.js +36 -0
- package/dist-cjs/commands/UpdateImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +97 -19
- package/dist-cjs/pagination/ListImpersonationRolesPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +628 -5
- package/dist-es/WorkMail.js +406 -294
- package/dist-es/WorkMailClient.js +28 -22
- package/dist-es/commands/AssociateDelegateToResourceCommand.js +28 -21
- package/dist-es/commands/AssociateMemberToGroupCommand.js +28 -21
- package/dist-es/commands/AssumeImpersonationRoleCommand.js +39 -0
- package/dist-es/commands/CancelMailboxExportJobCommand.js +28 -21
- package/dist-es/commands/CreateAliasCommand.js +28 -21
- package/dist-es/commands/CreateAvailabilityConfigurationCommand.js +28 -21
- package/dist-es/commands/CreateGroupCommand.js +28 -21
- package/dist-es/commands/CreateImpersonationRoleCommand.js +39 -0
- package/dist-es/commands/CreateMobileDeviceAccessRuleCommand.js +28 -21
- package/dist-es/commands/CreateOrganizationCommand.js +28 -21
- package/dist-es/commands/CreateResourceCommand.js +28 -21
- package/dist-es/commands/CreateUserCommand.js +28 -21
- package/dist-es/commands/DeleteAccessControlRuleCommand.js +28 -21
- package/dist-es/commands/DeleteAliasCommand.js +28 -21
- package/dist-es/commands/DeleteAvailabilityConfigurationCommand.js +28 -21
- package/dist-es/commands/DeleteEmailMonitoringConfigurationCommand.js +28 -21
- package/dist-es/commands/DeleteGroupCommand.js +28 -21
- package/dist-es/commands/DeleteImpersonationRoleCommand.js +39 -0
- package/dist-es/commands/DeleteMailboxPermissionsCommand.js +28 -21
- package/dist-es/commands/DeleteMobileDeviceAccessOverrideCommand.js +28 -21
- package/dist-es/commands/DeleteMobileDeviceAccessRuleCommand.js +28 -21
- package/dist-es/commands/DeleteOrganizationCommand.js +28 -21
- package/dist-es/commands/DeleteResourceCommand.js +28 -21
- package/dist-es/commands/DeleteRetentionPolicyCommand.js +28 -21
- package/dist-es/commands/DeleteUserCommand.js +28 -21
- package/dist-es/commands/DeregisterFromWorkMailCommand.js +28 -21
- package/dist-es/commands/DeregisterMailDomainCommand.js +28 -21
- package/dist-es/commands/DescribeEmailMonitoringConfigurationCommand.js +28 -21
- package/dist-es/commands/DescribeGroupCommand.js +28 -21
- package/dist-es/commands/DescribeInboundDmarcSettingsCommand.js +28 -21
- package/dist-es/commands/DescribeMailboxExportJobCommand.js +28 -21
- package/dist-es/commands/DescribeOrganizationCommand.js +28 -21
- package/dist-es/commands/DescribeResourceCommand.js +28 -21
- package/dist-es/commands/DescribeUserCommand.js +28 -21
- package/dist-es/commands/DisassociateDelegateFromResourceCommand.js +28 -21
- package/dist-es/commands/DisassociateMemberFromGroupCommand.js +28 -21
- package/dist-es/commands/GetAccessControlEffectCommand.js +28 -21
- package/dist-es/commands/GetDefaultRetentionPolicyCommand.js +28 -21
- package/dist-es/commands/GetImpersonationRoleCommand.js +39 -0
- package/dist-es/commands/GetImpersonationRoleEffectCommand.js +39 -0
- package/dist-es/commands/GetMailDomainCommand.js +28 -21
- package/dist-es/commands/GetMailboxDetailsCommand.js +28 -21
- package/dist-es/commands/GetMobileDeviceAccessEffectCommand.js +28 -21
- package/dist-es/commands/GetMobileDeviceAccessOverrideCommand.js +28 -21
- package/dist-es/commands/ListAccessControlRulesCommand.js +28 -21
- package/dist-es/commands/ListAliasesCommand.js +28 -21
- package/dist-es/commands/ListAvailabilityConfigurationsCommand.js +28 -21
- package/dist-es/commands/ListGroupMembersCommand.js +28 -21
- package/dist-es/commands/ListGroupsCommand.js +28 -21
- package/dist-es/commands/ListImpersonationRolesCommand.js +39 -0
- package/dist-es/commands/ListMailDomainsCommand.js +28 -21
- package/dist-es/commands/ListMailboxExportJobsCommand.js +28 -21
- package/dist-es/commands/ListMailboxPermissionsCommand.js +28 -21
- package/dist-es/commands/ListMobileDeviceAccessOverridesCommand.js +28 -21
- package/dist-es/commands/ListMobileDeviceAccessRulesCommand.js +28 -21
- package/dist-es/commands/ListOrganizationsCommand.js +28 -21
- package/dist-es/commands/ListResourceDelegatesCommand.js +28 -21
- package/dist-es/commands/ListResourcesCommand.js +28 -21
- package/dist-es/commands/ListTagsForResourceCommand.js +28 -21
- package/dist-es/commands/ListUsersCommand.js +28 -21
- package/dist-es/commands/PutAccessControlRuleCommand.js +28 -21
- package/dist-es/commands/PutEmailMonitoringConfigurationCommand.js +28 -21
- package/dist-es/commands/PutInboundDmarcSettingsCommand.js +28 -21
- package/dist-es/commands/PutMailboxPermissionsCommand.js +28 -21
- package/dist-es/commands/PutMobileDeviceAccessOverrideCommand.js +28 -21
- package/dist-es/commands/PutRetentionPolicyCommand.js +28 -21
- package/dist-es/commands/RegisterMailDomainCommand.js +28 -21
- package/dist-es/commands/RegisterToWorkMailCommand.js +28 -21
- package/dist-es/commands/ResetPasswordCommand.js +28 -21
- package/dist-es/commands/StartMailboxExportJobCommand.js +28 -21
- package/dist-es/commands/TagResourceCommand.js +28 -21
- package/dist-es/commands/TestAvailabilityConfigurationCommand.js +28 -21
- package/dist-es/commands/UntagResourceCommand.js +28 -21
- package/dist-es/commands/UpdateAvailabilityConfigurationCommand.js +28 -21
- package/dist-es/commands/UpdateDefaultMailDomainCommand.js +28 -21
- package/dist-es/commands/UpdateImpersonationRoleCommand.js +39 -0
- package/dist-es/commands/UpdateMailboxQuotaCommand.js +28 -21
- package/dist-es/commands/UpdateMobileDeviceAccessRuleCommand.js +28 -21
- package/dist-es/commands/UpdatePrimaryEmailAddressCommand.js +28 -21
- package/dist-es/commands/UpdateResourceCommand.js +28 -21
- package/dist-es/commands/index.js +7 -0
- package/dist-es/endpoints.js +8 -8
- package/dist-es/models/WorkMailServiceException.js +10 -5
- package/dist-es/models/models_0.js +461 -776
- package/dist-es/pagination/ListAliasesPaginator.js +68 -25
- package/dist-es/pagination/ListAvailabilityConfigurationsPaginator.js +68 -25
- package/dist-es/pagination/ListGroupMembersPaginator.js +68 -25
- package/dist-es/pagination/ListGroupsPaginator.js +68 -25
- package/dist-es/pagination/ListImpersonationRolesPaginator.js +75 -0
- package/dist-es/pagination/ListMailDomainsPaginator.js +68 -25
- package/dist-es/pagination/ListMailboxExportJobsPaginator.js +68 -25
- package/dist-es/pagination/ListMailboxPermissionsPaginator.js +68 -25
- package/dist-es/pagination/ListMobileDeviceAccessOverridesPaginator.js +68 -25
- package/dist-es/pagination/ListOrganizationsPaginator.js +68 -25
- package/dist-es/pagination/ListResourceDelegatesPaginator.js +68 -25
- package/dist-es/pagination/ListResourcesPaginator.js +68 -25
- package/dist-es/pagination/ListUsersPaginator.js +68 -25
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +7042 -4887
- package/dist-es/runtimeConfig.browser.js +12 -26
- package/dist-es/runtimeConfig.js +12 -30
- package/dist-es/runtimeConfig.native.js +5 -8
- package/dist-es/runtimeConfig.shared.js +11 -8
- package/dist-types/WorkMail.d.ts +91 -32
- package/dist-types/WorkMailClient.d.ts +10 -3
- package/dist-types/commands/AssumeImpersonationRoleCommand.d.ts +36 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateImpersonationRoleCommand.d.ts +40 -0
- package/dist-types/commands/CreateMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateOrganizationCommand.d.ts +9 -5
- package/dist-types/commands/CreateResourceCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/DeleteMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterFromWorkMailCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterMailDomainCommand.d.ts +1 -1
- package/dist-types/commands/GetAccessControlEffectCommand.d.ts +1 -1
- package/dist-types/commands/GetImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/GetImpersonationRoleEffectCommand.d.ts +35 -0
- package/dist-types/commands/GetMobileDeviceAccessEffectCommand.d.ts +1 -1
- package/dist-types/commands/ListImpersonationRolesCommand.d.ts +35 -0
- package/dist-types/commands/ListMailDomainsCommand.d.ts +1 -1
- package/dist-types/commands/ListMobileDeviceAccessRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutAccessControlRuleCommand.d.ts +1 -1
- package/dist-types/commands/RegisterMailDomainCommand.d.ts +1 -1
- package/dist-types/commands/RegisterToWorkMailCommand.d.ts +2 -2
- package/dist-types/commands/StartMailboxExportJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TestAvailabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/UpdateMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +442 -73
- package/dist-types/pagination/ListImpersonationRolesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +21 -0
- package/dist-types/ts3.4/WorkMail.d.ts +119 -0
- package/dist-types/ts3.4/WorkMailClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssumeImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetImpersonationRoleEffectCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListImpersonationRolesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +157 -9
- package/dist-types/ts3.4/pagination/ListImpersonationRolesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +84 -0
- package/package.json +5 -5
|
@@ -5,7 +5,7 @@ export declare enum AccessControlRuleEffect {
|
|
|
5
5
|
DENY = "DENY"
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* <p>A rule that controls access to an
|
|
8
|
+
* <p>A rule that controls access to an WorkMail organization.</p>
|
|
9
9
|
*/
|
|
10
10
|
export interface AccessControlRule {
|
|
11
11
|
/**
|
|
@@ -56,6 +56,18 @@ export interface AccessControlRule {
|
|
|
56
56
|
* <p>The date that the rule was modified.</p>
|
|
57
57
|
*/
|
|
58
58
|
DateModified?: Date;
|
|
59
|
+
/**
|
|
60
|
+
* <p>Impersonation role IDs to include in the rule.</p>
|
|
61
|
+
*/
|
|
62
|
+
ImpersonationRoleIds?: string[];
|
|
63
|
+
/**
|
|
64
|
+
* <p>Impersonation role IDs to exclude from the rule.</p>
|
|
65
|
+
*/
|
|
66
|
+
NotImpersonationRoleIds?: string[];
|
|
67
|
+
}
|
|
68
|
+
export declare enum AccessEffect {
|
|
69
|
+
ALLOW = "ALLOW",
|
|
70
|
+
DENY = "DENY"
|
|
59
71
|
}
|
|
60
72
|
export interface AssociateDelegateToResourceRequest {
|
|
61
73
|
/**
|
|
@@ -189,6 +201,38 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
189
201
|
*/
|
|
190
202
|
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
191
203
|
}
|
|
204
|
+
export interface AssumeImpersonationRoleRequest {
|
|
205
|
+
/**
|
|
206
|
+
* <p>The WorkMail organization under which the impersonation role will be assumed.</p>
|
|
207
|
+
*/
|
|
208
|
+
OrganizationId: string | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* <p>The impersonation role ID to assume.</p>
|
|
211
|
+
*/
|
|
212
|
+
ImpersonationRoleId: string | undefined;
|
|
213
|
+
}
|
|
214
|
+
export interface AssumeImpersonationRoleResponse {
|
|
215
|
+
/**
|
|
216
|
+
* <p>The authentication token for the impersonation role.</p>
|
|
217
|
+
*/
|
|
218
|
+
Token?: string;
|
|
219
|
+
/**
|
|
220
|
+
* <p>The authentication token's validity, in seconds.</p>
|
|
221
|
+
*/
|
|
222
|
+
ExpiresIn?: number;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* <p>The resource cannot be found.</p>
|
|
226
|
+
*/
|
|
227
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
228
|
+
readonly name: "ResourceNotFoundException";
|
|
229
|
+
readonly $fault: "client";
|
|
230
|
+
Message?: string;
|
|
231
|
+
/**
|
|
232
|
+
* @internal
|
|
233
|
+
*/
|
|
234
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
235
|
+
}
|
|
192
236
|
/**
|
|
193
237
|
* <p>Describes an EWS based availability provider when returned from the service. It does not
|
|
194
238
|
* contain the password of the endpoint.</p>
|
|
@@ -231,7 +275,7 @@ export interface AvailabilityConfiguration {
|
|
|
231
275
|
ProviderType?: AvailabilityProviderType | string;
|
|
232
276
|
/**
|
|
233
277
|
* <p>If <code>ProviderType</code> is <code>EWS</code>, then this field contains
|
|
234
|
-
* <code>RedactedEwsAvailabilityProvider</code>. Otherwise, it is not
|
|
278
|
+
* <code>RedactedEwsAvailabilityProvider</code>. Otherwise, it is not required.</p>
|
|
235
279
|
*/
|
|
236
280
|
EwsProvider?: RedactedEwsAvailabilityProvider;
|
|
237
281
|
/**
|
|
@@ -372,7 +416,7 @@ export interface CreateAvailabilityConfigurationRequest {
|
|
|
372
416
|
*/
|
|
373
417
|
ClientToken?: string;
|
|
374
418
|
/**
|
|
375
|
-
* <p>The
|
|
419
|
+
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be created.</p>
|
|
376
420
|
*/
|
|
377
421
|
OrganizationId: string | undefined;
|
|
378
422
|
/**
|
|
@@ -391,7 +435,7 @@ export interface CreateAvailabilityConfigurationRequest {
|
|
|
391
435
|
export interface CreateAvailabilityConfigurationResponse {
|
|
392
436
|
}
|
|
393
437
|
/**
|
|
394
|
-
* <p>The user, group, or resource name isn't unique in
|
|
438
|
+
* <p>The user, group, or resource name isn't unique in WorkMail.</p>
|
|
395
439
|
*/
|
|
396
440
|
export declare class NameAvailabilityException extends __BaseException {
|
|
397
441
|
readonly name: "NameAvailabilityException";
|
|
@@ -419,7 +463,7 @@ export interface CreateGroupResponse {
|
|
|
419
463
|
GroupId?: string;
|
|
420
464
|
}
|
|
421
465
|
/**
|
|
422
|
-
* <p>This user, group, or resource name is not allowed in
|
|
466
|
+
* <p>This user, group, or resource name is not allowed in WorkMail.</p>
|
|
423
467
|
*/
|
|
424
468
|
export declare class ReservedNameException extends __BaseException {
|
|
425
469
|
readonly name: "ReservedNameException";
|
|
@@ -430,13 +474,80 @@ export declare class ReservedNameException extends __BaseException {
|
|
|
430
474
|
*/
|
|
431
475
|
constructor(opts: __ExceptionOptionType<ReservedNameException, __BaseException>);
|
|
432
476
|
}
|
|
477
|
+
/**
|
|
478
|
+
* <p>The rules for the given impersonation role.</p>
|
|
479
|
+
*/
|
|
480
|
+
export interface ImpersonationRule {
|
|
481
|
+
/**
|
|
482
|
+
* <p>The identifier of the rule.</p>
|
|
483
|
+
*/
|
|
484
|
+
ImpersonationRuleId: string | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* <p>The rule name.</p>
|
|
487
|
+
*/
|
|
488
|
+
Name?: string;
|
|
489
|
+
/**
|
|
490
|
+
* <p>The rule description.</p>
|
|
491
|
+
*/
|
|
492
|
+
Description?: string;
|
|
493
|
+
/**
|
|
494
|
+
* <p>The effect of the rule when it matches the input. Allowed effect values are
|
|
495
|
+
* <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
496
|
+
*/
|
|
497
|
+
Effect: AccessEffect | string | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* <p>A list of user IDs that match the rule.</p>
|
|
500
|
+
*/
|
|
501
|
+
TargetUsers?: string[];
|
|
502
|
+
/**
|
|
503
|
+
* <p>A list of user IDs that don't match the rule.</p>
|
|
504
|
+
*/
|
|
505
|
+
NotTargetUsers?: string[];
|
|
506
|
+
}
|
|
507
|
+
export declare enum ImpersonationRoleType {
|
|
508
|
+
FULL_ACCESS = "FULL_ACCESS",
|
|
509
|
+
READ_ONLY = "READ_ONLY"
|
|
510
|
+
}
|
|
511
|
+
export interface CreateImpersonationRoleRequest {
|
|
512
|
+
/**
|
|
513
|
+
* <p>The idempotency token for the client request.</p>
|
|
514
|
+
*/
|
|
515
|
+
ClientToken?: string;
|
|
516
|
+
/**
|
|
517
|
+
* <p>The WorkMail organization to create the new impersonation role within.</p>
|
|
518
|
+
*/
|
|
519
|
+
OrganizationId: string | undefined;
|
|
520
|
+
/**
|
|
521
|
+
* <p>The name of the new impersonation role.</p>
|
|
522
|
+
*/
|
|
523
|
+
Name: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* <p>The impersonation role's type. The available impersonation role types are
|
|
526
|
+
* <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.</p>
|
|
527
|
+
*/
|
|
528
|
+
Type: ImpersonationRoleType | string | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* <p>The description of the new impersonation role.</p>
|
|
531
|
+
*/
|
|
532
|
+
Description?: string;
|
|
533
|
+
/**
|
|
534
|
+
* <p>The list of rules for the impersonation role.</p>
|
|
535
|
+
*/
|
|
536
|
+
Rules: ImpersonationRule[] | undefined;
|
|
537
|
+
}
|
|
538
|
+
export interface CreateImpersonationRoleResponse {
|
|
539
|
+
/**
|
|
540
|
+
* <p>The new impersonation role ID.</p>
|
|
541
|
+
*/
|
|
542
|
+
ImpersonationRoleId?: string;
|
|
543
|
+
}
|
|
433
544
|
export declare enum MobileDeviceAccessRuleEffect {
|
|
434
545
|
ALLOW = "ALLOW",
|
|
435
546
|
DENY = "DENY"
|
|
436
547
|
}
|
|
437
548
|
export interface CreateMobileDeviceAccessRuleRequest {
|
|
438
549
|
/**
|
|
439
|
-
* <p>The
|
|
550
|
+
* <p>The WorkMail organization under which the rule will be created.</p>
|
|
440
551
|
*/
|
|
441
552
|
OrganizationId: string | undefined;
|
|
442
553
|
/**
|
|
@@ -495,8 +606,8 @@ export interface CreateMobileDeviceAccessRuleResponse {
|
|
|
495
606
|
MobileDeviceAccessRuleId?: string;
|
|
496
607
|
}
|
|
497
608
|
/**
|
|
498
|
-
* <p>The domain to associate with an
|
|
499
|
-
* <p>When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html">Adding a domain</a> in the <i>
|
|
609
|
+
* <p>The domain to associate with an WorkMail organization.</p>
|
|
610
|
+
* <p>When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html">Adding a domain</a> in the <i>WorkMail Administrator Guide</i>.</p>
|
|
500
611
|
*/
|
|
501
612
|
export interface Domain {
|
|
502
613
|
/**
|
|
@@ -526,12 +637,13 @@ export interface CreateOrganizationRequest {
|
|
|
526
637
|
*/
|
|
527
638
|
Domains?: Domain[];
|
|
528
639
|
/**
|
|
529
|
-
* <p>The Amazon Resource Name (ARN) of a customer managed
|
|
530
|
-
* KMS.</p>
|
|
640
|
+
* <p>The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.</p>
|
|
531
641
|
*/
|
|
532
642
|
KmsKeyArn?: string;
|
|
533
643
|
/**
|
|
534
|
-
* <p>When <code>true</code>, allows organization interoperability between
|
|
644
|
+
* <p>When <code>true</code>, allows organization interoperability between WorkMail and
|
|
645
|
+
* Microsoft Exchange. If <code>true</code>, you must include a AD Connector directory ID in
|
|
646
|
+
* the request.</p>
|
|
535
647
|
*/
|
|
536
648
|
EnableInteroperability?: boolean;
|
|
537
649
|
}
|
|
@@ -666,7 +778,7 @@ export interface DeleteAliasResponse {
|
|
|
666
778
|
}
|
|
667
779
|
export interface DeleteAvailabilityConfigurationRequest {
|
|
668
780
|
/**
|
|
669
|
-
* <p>The
|
|
781
|
+
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be deleted.</p>
|
|
670
782
|
*/
|
|
671
783
|
OrganizationId: string | undefined;
|
|
672
784
|
/**
|
|
@@ -696,6 +808,18 @@ export interface DeleteGroupRequest {
|
|
|
696
808
|
}
|
|
697
809
|
export interface DeleteGroupResponse {
|
|
698
810
|
}
|
|
811
|
+
export interface DeleteImpersonationRoleRequest {
|
|
812
|
+
/**
|
|
813
|
+
* <p>The WorkMail organization from which to delete the impersonation role.</p>
|
|
814
|
+
*/
|
|
815
|
+
OrganizationId: string | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* <p>The ID of the impersonation role to delete.</p>
|
|
818
|
+
*/
|
|
819
|
+
ImpersonationRoleId: string | undefined;
|
|
820
|
+
}
|
|
821
|
+
export interface DeleteImpersonationRoleResponse {
|
|
822
|
+
}
|
|
699
823
|
export interface DeleteMailboxPermissionsRequest {
|
|
700
824
|
/**
|
|
701
825
|
* <p>The identifier of the organization under which the member (user or group)
|
|
@@ -716,7 +840,7 @@ export interface DeleteMailboxPermissionsResponse {
|
|
|
716
840
|
}
|
|
717
841
|
export interface DeleteMobileDeviceAccessOverrideRequest {
|
|
718
842
|
/**
|
|
719
|
-
* <p>The
|
|
843
|
+
* <p>The WorkMail organization for which the access override will be deleted.</p>
|
|
720
844
|
*/
|
|
721
845
|
OrganizationId: string | undefined;
|
|
722
846
|
/**
|
|
@@ -746,7 +870,7 @@ export interface DeleteMobileDeviceAccessOverrideResponse {
|
|
|
746
870
|
}
|
|
747
871
|
export interface DeleteMobileDeviceAccessRuleRequest {
|
|
748
872
|
/**
|
|
749
|
-
* <p>The
|
|
873
|
+
* <p>The WorkMail organization under which the rule will be deleted.</p>
|
|
750
874
|
*/
|
|
751
875
|
OrganizationId: string | undefined;
|
|
752
876
|
/**
|
|
@@ -819,7 +943,7 @@ export interface DeleteUserResponse {
|
|
|
819
943
|
}
|
|
820
944
|
export interface DeregisterFromWorkMailRequest {
|
|
821
945
|
/**
|
|
822
|
-
* <p>The identifier for the organization under which the
|
|
946
|
+
* <p>The identifier for the organization under which the WorkMail entity exists.</p>
|
|
823
947
|
*/
|
|
824
948
|
OrganizationId: string | undefined;
|
|
825
949
|
/**
|
|
@@ -831,18 +955,18 @@ export interface DeregisterFromWorkMailResponse {
|
|
|
831
955
|
}
|
|
832
956
|
export interface DeregisterMailDomainRequest {
|
|
833
957
|
/**
|
|
834
|
-
* <p>The
|
|
958
|
+
* <p>The WorkMail organization for which the domain will be deregistered.</p>
|
|
835
959
|
*/
|
|
836
960
|
OrganizationId: string | undefined;
|
|
837
961
|
/**
|
|
838
|
-
* <p>The domain to deregister in WorkMail and SES
|
|
962
|
+
* <p>The domain to deregister in WorkMail and SES.</p>
|
|
839
963
|
*/
|
|
840
964
|
DomainName: string | undefined;
|
|
841
965
|
}
|
|
842
966
|
export interface DeregisterMailDomainResponse {
|
|
843
967
|
}
|
|
844
968
|
/**
|
|
845
|
-
* <p>You SES configuration has customizations that
|
|
969
|
+
* <p>You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to
|
|
846
970
|
* <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html">CreateReceiptRule</a>.</p>
|
|
847
971
|
*/
|
|
848
972
|
export declare class InvalidCustomSesConfigurationException extends __BaseException {
|
|
@@ -882,18 +1006,6 @@ export interface DescribeEmailMonitoringConfigurationResponse {
|
|
|
882
1006
|
*/
|
|
883
1007
|
LogGroupArn?: string;
|
|
884
1008
|
}
|
|
885
|
-
/**
|
|
886
|
-
* <p>The resource cannot be found.</p>
|
|
887
|
-
*/
|
|
888
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
889
|
-
readonly name: "ResourceNotFoundException";
|
|
890
|
-
readonly $fault: "client";
|
|
891
|
-
Message?: string;
|
|
892
|
-
/**
|
|
893
|
-
* @internal
|
|
894
|
-
*/
|
|
895
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
896
|
-
}
|
|
897
1009
|
export interface DescribeGroupRequest {
|
|
898
1010
|
/**
|
|
899
1011
|
* <p>The identifier for the organization under which the group exists.</p>
|
|
@@ -923,7 +1035,7 @@ export interface DescribeGroupResponse {
|
|
|
923
1035
|
*/
|
|
924
1036
|
Email?: string;
|
|
925
1037
|
/**
|
|
926
|
-
* <p>The state of the user: enabled (registered to
|
|
1038
|
+
* <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or
|
|
927
1039
|
* never registered to WorkMail).</p>
|
|
928
1040
|
*/
|
|
929
1041
|
State?: EntityState | string;
|
|
@@ -1039,7 +1151,7 @@ export interface DescribeOrganizationResponse {
|
|
|
1039
1151
|
*/
|
|
1040
1152
|
State?: string;
|
|
1041
1153
|
/**
|
|
1042
|
-
* <p>The identifier for the directory associated with an
|
|
1154
|
+
* <p>The identifier for the directory associated with an WorkMail organization.</p>
|
|
1043
1155
|
*/
|
|
1044
1156
|
DirectoryId?: string;
|
|
1045
1157
|
/**
|
|
@@ -1098,7 +1210,7 @@ export interface DescribeResourceResponse {
|
|
|
1098
1210
|
*/
|
|
1099
1211
|
BookingOptions?: BookingOptions;
|
|
1100
1212
|
/**
|
|
1101
|
-
* <p>The state of the resource: enabled (registered to
|
|
1213
|
+
* <p>The state of the resource: enabled (registered to WorkMail), disabled (deregistered
|
|
1102
1214
|
* or never registered to WorkMail), or deleted.</p>
|
|
1103
1215
|
*/
|
|
1104
1216
|
State?: EntityState | string;
|
|
@@ -1146,25 +1258,25 @@ export interface DescribeUserResponse {
|
|
|
1146
1258
|
*/
|
|
1147
1259
|
DisplayName?: string;
|
|
1148
1260
|
/**
|
|
1149
|
-
* <p>The state of a user: enabled (registered to
|
|
1261
|
+
* <p>The state of a user: enabled (registered to WorkMail) or disabled (deregistered or
|
|
1150
1262
|
* never registered to WorkMail).</p>
|
|
1151
1263
|
*/
|
|
1152
1264
|
State?: EntityState | string;
|
|
1153
1265
|
/**
|
|
1154
1266
|
* <p>In certain cases, other entities are modeled as users. If interoperability is
|
|
1155
|
-
* enabled, resources are imported into
|
|
1267
|
+
* enabled, resources are imported into WorkMail as users. Because different WorkMail
|
|
1156
1268
|
* organizations rely on different directory types, administrators can distinguish between an
|
|
1157
1269
|
* unregistered user (account is disabled and has a user role) and the directory
|
|
1158
1270
|
* administrators. The values are USER, RESOURCE, and SYSTEM_USER.</p>
|
|
1159
1271
|
*/
|
|
1160
1272
|
UserRole?: UserRole | string;
|
|
1161
1273
|
/**
|
|
1162
|
-
* <p>The date and time at which the user was enabled for
|
|
1274
|
+
* <p>The date and time at which the user was enabled for WorkMailusage, in UNIX epoch
|
|
1163
1275
|
* time format.</p>
|
|
1164
1276
|
*/
|
|
1165
1277
|
EnabledDate?: Date;
|
|
1166
1278
|
/**
|
|
1167
|
-
* <p>The date and time at which the user was disabled for
|
|
1279
|
+
* <p>The date and time at which the user was disabled for WorkMail usage, in UNIX epoch
|
|
1168
1280
|
* time format.</p>
|
|
1169
1281
|
*/
|
|
1170
1282
|
DisabledDate?: Date;
|
|
@@ -1287,7 +1399,11 @@ export interface GetAccessControlEffectRequest {
|
|
|
1287
1399
|
/**
|
|
1288
1400
|
* <p>The user ID.</p>
|
|
1289
1401
|
*/
|
|
1290
|
-
UserId
|
|
1402
|
+
UserId?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>The impersonation role ID.</p>
|
|
1405
|
+
*/
|
|
1406
|
+
ImpersonationRoleId?: string;
|
|
1291
1407
|
}
|
|
1292
1408
|
export interface GetAccessControlEffectResponse {
|
|
1293
1409
|
/**
|
|
@@ -1323,6 +1439,104 @@ export interface GetDefaultRetentionPolicyResponse {
|
|
|
1323
1439
|
*/
|
|
1324
1440
|
FolderConfigurations?: FolderConfiguration[];
|
|
1325
1441
|
}
|
|
1442
|
+
export interface GetImpersonationRoleRequest {
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The WorkMail organization from which to retrieve the impersonation role.</p>
|
|
1445
|
+
*/
|
|
1446
|
+
OrganizationId: string | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>The impersonation role ID to retrieve.</p>
|
|
1449
|
+
*/
|
|
1450
|
+
ImpersonationRoleId: string | undefined;
|
|
1451
|
+
}
|
|
1452
|
+
export interface GetImpersonationRoleResponse {
|
|
1453
|
+
/**
|
|
1454
|
+
* <p>The impersonation role ID.</p>
|
|
1455
|
+
*/
|
|
1456
|
+
ImpersonationRoleId?: string;
|
|
1457
|
+
/**
|
|
1458
|
+
* <p>The impersonation role name.</p>
|
|
1459
|
+
*/
|
|
1460
|
+
Name?: string;
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>The impersonation role type.</p>
|
|
1463
|
+
*/
|
|
1464
|
+
Type?: ImpersonationRoleType | string;
|
|
1465
|
+
/**
|
|
1466
|
+
* <p>The impersonation role description.</p>
|
|
1467
|
+
*/
|
|
1468
|
+
Description?: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* <p>The list of rules for the given impersonation role.</p>
|
|
1471
|
+
*/
|
|
1472
|
+
Rules?: ImpersonationRule[];
|
|
1473
|
+
/**
|
|
1474
|
+
* <p>The date when the impersonation role was created.</p>
|
|
1475
|
+
*/
|
|
1476
|
+
DateCreated?: Date;
|
|
1477
|
+
/**
|
|
1478
|
+
* <p>The date when the impersonation role was last modified.</p>
|
|
1479
|
+
*/
|
|
1480
|
+
DateModified?: Date;
|
|
1481
|
+
}
|
|
1482
|
+
export interface GetImpersonationRoleEffectRequest {
|
|
1483
|
+
/**
|
|
1484
|
+
* <p>The WorkMail organization where the impersonation role is defined.</p>
|
|
1485
|
+
*/
|
|
1486
|
+
OrganizationId: string | undefined;
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>The impersonation role ID to test.</p>
|
|
1489
|
+
*/
|
|
1490
|
+
ImpersonationRoleId: string | undefined;
|
|
1491
|
+
/**
|
|
1492
|
+
* <p>The WorkMail organization user chosen to test the impersonation role. The following identity
|
|
1493
|
+
* formats are available:</p>
|
|
1494
|
+
* <ul>
|
|
1495
|
+
* <li>
|
|
1496
|
+
* <p>User ID: <code>12345678-1234-1234-1234-123456789012</code> or <code>S-1-1-12-1234567890-123456789-123456789-1234</code>
|
|
1497
|
+
* </p>
|
|
1498
|
+
* </li>
|
|
1499
|
+
* <li>
|
|
1500
|
+
* <p>Email address: <code>user@domain.tld</code>
|
|
1501
|
+
* </p>
|
|
1502
|
+
* </li>
|
|
1503
|
+
* <li>
|
|
1504
|
+
* <p>User name: <code>user</code>
|
|
1505
|
+
* </p>
|
|
1506
|
+
* </li>
|
|
1507
|
+
* </ul>
|
|
1508
|
+
*/
|
|
1509
|
+
TargetUser: string | undefined;
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* <p>The impersonation rule that matched the input.</p>
|
|
1513
|
+
*/
|
|
1514
|
+
export interface ImpersonationMatchedRule {
|
|
1515
|
+
/**
|
|
1516
|
+
* <p>The ID of the rule that matched the input</p>
|
|
1517
|
+
*/
|
|
1518
|
+
ImpersonationRuleId?: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* <p>The name of the rule that matched the input.</p>
|
|
1521
|
+
*/
|
|
1522
|
+
Name?: string;
|
|
1523
|
+
}
|
|
1524
|
+
export interface GetImpersonationRoleEffectResponse {
|
|
1525
|
+
/**
|
|
1526
|
+
* <p>The impersonation role type.</p>
|
|
1527
|
+
*/
|
|
1528
|
+
Type?: ImpersonationRoleType | string;
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>
|
|
1531
|
+
* <code></code>Effect of the impersonation role on the target user based on its rules. Available
|
|
1532
|
+
* effects are <code>ALLOW</code> or <code>DENY</code>.</p>
|
|
1533
|
+
*/
|
|
1534
|
+
Effect?: AccessEffect | string;
|
|
1535
|
+
/**
|
|
1536
|
+
* <p>A list of the rules that match the input and produce the configured effect.</p>
|
|
1537
|
+
*/
|
|
1538
|
+
MatchedRules?: ImpersonationMatchedRule[];
|
|
1539
|
+
}
|
|
1326
1540
|
export interface GetMailboxDetailsRequest {
|
|
1327
1541
|
/**
|
|
1328
1542
|
* <p>The identifier for the organization that contains the user whose mailbox details are
|
|
@@ -1346,7 +1560,7 @@ export interface GetMailboxDetailsResponse {
|
|
|
1346
1560
|
}
|
|
1347
1561
|
export interface GetMailDomainRequest {
|
|
1348
1562
|
/**
|
|
1349
|
-
* <p>The
|
|
1563
|
+
* <p>The WorkMail organization for which the domain is retrieved.</p>
|
|
1350
1564
|
*/
|
|
1351
1565
|
OrganizationId: string | undefined;
|
|
1352
1566
|
/**
|
|
@@ -1356,7 +1570,7 @@ export interface GetMailDomainRequest {
|
|
|
1356
1570
|
}
|
|
1357
1571
|
export interface GetMailDomainResponse {
|
|
1358
1572
|
/**
|
|
1359
|
-
* <p>A list of the DNS records that
|
|
1573
|
+
* <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
|
|
1360
1574
|
* email traffic to SES. See admin guide for more details.</p>
|
|
1361
1575
|
*/
|
|
1362
1576
|
Records?: DnsRecord[];
|
|
@@ -1379,7 +1593,7 @@ export interface GetMailDomainResponse {
|
|
|
1379
1593
|
}
|
|
1380
1594
|
export interface GetMobileDeviceAccessEffectRequest {
|
|
1381
1595
|
/**
|
|
1382
|
-
* <p>The
|
|
1596
|
+
* <p>The WorkMail organization to simulate the access effect for.</p>
|
|
1383
1597
|
*/
|
|
1384
1598
|
OrganizationId: string | undefined;
|
|
1385
1599
|
/**
|
|
@@ -1414,7 +1628,7 @@ export interface MobileDeviceAccessMatchedRule {
|
|
|
1414
1628
|
}
|
|
1415
1629
|
export interface GetMobileDeviceAccessEffectResponse {
|
|
1416
1630
|
/**
|
|
1417
|
-
* <p>The effect of the simulated access, <code>ALLOW</code> or <code>DENY</code>, after evaluating mobile device access rules in the
|
|
1631
|
+
* <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
|
|
1418
1632
|
* user parameters.</p>
|
|
1419
1633
|
*/
|
|
1420
1634
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
@@ -1425,7 +1639,7 @@ export interface GetMobileDeviceAccessEffectResponse {
|
|
|
1425
1639
|
}
|
|
1426
1640
|
export interface GetMobileDeviceAccessOverrideRequest {
|
|
1427
1641
|
/**
|
|
1428
|
-
* <p>The
|
|
1642
|
+
* <p>The WorkMail organization to which you want to apply the override.</p>
|
|
1429
1643
|
*/
|
|
1430
1644
|
OrganizationId: string | undefined;
|
|
1431
1645
|
/**
|
|
@@ -1478,7 +1692,7 @@ export interface GetMobileDeviceAccessOverrideResponse {
|
|
|
1478
1692
|
DateModified?: Date;
|
|
1479
1693
|
}
|
|
1480
1694
|
/**
|
|
1481
|
-
* <p>The representation of an
|
|
1695
|
+
* <p>The representation of an WorkMail group.</p>
|
|
1482
1696
|
*/
|
|
1483
1697
|
export interface Group {
|
|
1484
1698
|
/**
|
|
@@ -1498,14 +1712,39 @@ export interface Group {
|
|
|
1498
1712
|
*/
|
|
1499
1713
|
State?: EntityState | string;
|
|
1500
1714
|
/**
|
|
1501
|
-
* <p>The date indicating when the group was enabled for
|
|
1715
|
+
* <p>The date indicating when the group was enabled for WorkMail use.</p>
|
|
1502
1716
|
*/
|
|
1503
1717
|
EnabledDate?: Date;
|
|
1504
1718
|
/**
|
|
1505
|
-
* <p>The date indicating when the group was disabled from
|
|
1719
|
+
* <p>The date indicating when the group was disabled from WorkMail use.</p>
|
|
1506
1720
|
*/
|
|
1507
1721
|
DisabledDate?: Date;
|
|
1508
1722
|
}
|
|
1723
|
+
/**
|
|
1724
|
+
* <p>An impersonation role for the given WorkMail organization.</p>
|
|
1725
|
+
*/
|
|
1726
|
+
export interface ImpersonationRole {
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>The identifier of the impersonation role.</p>
|
|
1729
|
+
*/
|
|
1730
|
+
ImpersonationRoleId?: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* <p>The impersonation role name.</p>
|
|
1733
|
+
*/
|
|
1734
|
+
Name?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* <p>The impersonation role type.</p>
|
|
1737
|
+
*/
|
|
1738
|
+
Type?: ImpersonationRoleType | string;
|
|
1739
|
+
/**
|
|
1740
|
+
* <p>The date when the impersonation role was created.</p>
|
|
1741
|
+
*/
|
|
1742
|
+
DateCreated?: Date;
|
|
1743
|
+
/**
|
|
1744
|
+
* <p>The date when the impersonation role was last modified.</p>
|
|
1745
|
+
*/
|
|
1746
|
+
DateModified?: Date;
|
|
1747
|
+
}
|
|
1509
1748
|
/**
|
|
1510
1749
|
* <p>The configuration for a resource isn't valid. A resource must either be able to
|
|
1511
1750
|
* auto-respond to requests or have at least one delegate associated that can do so on its
|
|
@@ -1606,7 +1845,7 @@ export interface ListAliasesResponse {
|
|
|
1606
1845
|
}
|
|
1607
1846
|
export interface ListAvailabilityConfigurationsRequest {
|
|
1608
1847
|
/**
|
|
1609
|
-
* <p>The
|
|
1848
|
+
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code>'s will be
|
|
1610
1849
|
* listed.</p>
|
|
1611
1850
|
*/
|
|
1612
1851
|
OrganizationId: string | undefined;
|
|
@@ -1621,7 +1860,7 @@ export interface ListAvailabilityConfigurationsRequest {
|
|
|
1621
1860
|
}
|
|
1622
1861
|
export interface ListAvailabilityConfigurationsResponse {
|
|
1623
1862
|
/**
|
|
1624
|
-
* <p>The list of <code>AvailabilityConfiguration</code>'s that exist for the specified
|
|
1863
|
+
* <p>The list of <code>AvailabilityConfiguration</code>'s that exist for the specified WorkMail organization.</p>
|
|
1625
1864
|
*/
|
|
1626
1865
|
AvailabilityConfigurations?: AvailabilityConfiguration[];
|
|
1627
1866
|
/**
|
|
@@ -1670,11 +1909,11 @@ export interface Member {
|
|
|
1670
1909
|
*/
|
|
1671
1910
|
State?: EntityState | string;
|
|
1672
1911
|
/**
|
|
1673
|
-
* <p>The date indicating when the member was enabled for
|
|
1912
|
+
* <p>The date indicating when the member was enabled for WorkMail use.</p>
|
|
1674
1913
|
*/
|
|
1675
1914
|
EnabledDate?: Date;
|
|
1676
1915
|
/**
|
|
1677
|
-
* <p>The date indicating when the member was disabled from
|
|
1916
|
+
* <p>The date indicating when the member was disabled from WorkMail use.</p>
|
|
1678
1917
|
*/
|
|
1679
1918
|
DisabledDate?: Date;
|
|
1680
1919
|
}
|
|
@@ -1715,6 +1954,32 @@ export interface ListGroupsResponse {
|
|
|
1715
1954
|
*/
|
|
1716
1955
|
NextToken?: string;
|
|
1717
1956
|
}
|
|
1957
|
+
export interface ListImpersonationRolesRequest {
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>The WorkMail organization to which the listed impersonation roles belong.</p>
|
|
1960
|
+
*/
|
|
1961
|
+
OrganizationId: string | undefined;
|
|
1962
|
+
/**
|
|
1963
|
+
* <p>The token used to retrieve the next page of results. The first call doesn't require a
|
|
1964
|
+
* token.</p>
|
|
1965
|
+
*/
|
|
1966
|
+
NextToken?: string;
|
|
1967
|
+
/**
|
|
1968
|
+
* <p>The maximum number of results returned in a single call.</p>
|
|
1969
|
+
*/
|
|
1970
|
+
MaxResults?: number;
|
|
1971
|
+
}
|
|
1972
|
+
export interface ListImpersonationRolesResponse {
|
|
1973
|
+
/**
|
|
1974
|
+
* <p>The list of impersonation roles under the given WorkMail organization.</p>
|
|
1975
|
+
*/
|
|
1976
|
+
Roles?: ImpersonationRole[];
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The token to retrieve the next page of results. The value is <code>null</code> when
|
|
1979
|
+
* there are no results to return.</p>
|
|
1980
|
+
*/
|
|
1981
|
+
NextToken?: string;
|
|
1982
|
+
}
|
|
1718
1983
|
export interface ListMailboxExportJobsRequest {
|
|
1719
1984
|
/**
|
|
1720
1985
|
* <p>The organization ID.</p>
|
|
@@ -1802,7 +2067,7 @@ export interface ListMailboxPermissionsResponse {
|
|
|
1802
2067
|
}
|
|
1803
2068
|
export interface ListMailDomainsRequest {
|
|
1804
2069
|
/**
|
|
1805
|
-
* <p>The
|
|
2070
|
+
* <p>The WorkMail organization for which to list domains.</p>
|
|
1806
2071
|
*/
|
|
1807
2072
|
OrganizationId: string | undefined;
|
|
1808
2073
|
/**
|
|
@@ -1829,7 +2094,7 @@ export interface MailDomainSummary {
|
|
|
1829
2094
|
}
|
|
1830
2095
|
export interface ListMailDomainsResponse {
|
|
1831
2096
|
/**
|
|
1832
|
-
* <p>The list of mail domain summaries, specifying domains that exist in the specified
|
|
2097
|
+
* <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>
|
|
1833
2098
|
*/
|
|
1834
2099
|
MailDomains?: MailDomainSummary[];
|
|
1835
2100
|
/**
|
|
@@ -1839,7 +2104,7 @@ export interface ListMailDomainsResponse {
|
|
|
1839
2104
|
}
|
|
1840
2105
|
export interface ListMobileDeviceAccessOverridesRequest {
|
|
1841
2106
|
/**
|
|
1842
|
-
* <p>The
|
|
2107
|
+
* <p>The WorkMail organization under which to list mobile device access overrides.</p>
|
|
1843
2108
|
*/
|
|
1844
2109
|
OrganizationId: string | undefined;
|
|
1845
2110
|
/**
|
|
@@ -1904,7 +2169,7 @@ export interface MobileDeviceAccessOverride {
|
|
|
1904
2169
|
}
|
|
1905
2170
|
export interface ListMobileDeviceAccessOverridesResponse {
|
|
1906
2171
|
/**
|
|
1907
|
-
* <p>The list of mobile device access overrides that exist for the specified
|
|
2172
|
+
* <p>The list of mobile device access overrides that exist for the specified WorkMail organization and user.</p>
|
|
1908
2173
|
*/
|
|
1909
2174
|
Overrides?: MobileDeviceAccessOverride[];
|
|
1910
2175
|
/**
|
|
@@ -1914,16 +2179,16 @@ export interface ListMobileDeviceAccessOverridesResponse {
|
|
|
1914
2179
|
}
|
|
1915
2180
|
export interface ListMobileDeviceAccessRulesRequest {
|
|
1916
2181
|
/**
|
|
1917
|
-
* <p>The
|
|
2182
|
+
* <p>The WorkMail organization for which to list the rules.</p>
|
|
1918
2183
|
*/
|
|
1919
2184
|
OrganizationId: string | undefined;
|
|
1920
2185
|
}
|
|
1921
2186
|
/**
|
|
1922
|
-
* <p>A rule that controls access to mobile devices for an
|
|
2187
|
+
* <p>A rule that controls access to mobile devices for an WorkMail group.</p>
|
|
1923
2188
|
*/
|
|
1924
2189
|
export interface MobileDeviceAccessRule {
|
|
1925
2190
|
/**
|
|
1926
|
-
* <p>The ID assigned to a mobile access rule
|
|
2191
|
+
* <p>The ID assigned to a mobile access rule.</p>
|
|
1927
2192
|
*/
|
|
1928
2193
|
MobileDeviceAccessRuleId?: string;
|
|
1929
2194
|
/**
|
|
@@ -1939,7 +2204,7 @@ export interface MobileDeviceAccessRule {
|
|
|
1939
2204
|
*/
|
|
1940
2205
|
Effect?: MobileDeviceAccessRuleEffect | string;
|
|
1941
2206
|
/**
|
|
1942
|
-
* <p>Device types that a rule will match
|
|
2207
|
+
* <p>Device types that a rule will match.</p>
|
|
1943
2208
|
*/
|
|
1944
2209
|
DeviceTypes?: string[];
|
|
1945
2210
|
/**
|
|
@@ -1981,7 +2246,7 @@ export interface MobileDeviceAccessRule {
|
|
|
1981
2246
|
}
|
|
1982
2247
|
export interface ListMobileDeviceAccessRulesResponse {
|
|
1983
2248
|
/**
|
|
1984
|
-
* <p>The list of mobile device access rules that exist under the specified
|
|
2249
|
+
* <p>The list of mobile device access rules that exist under the specified WorkMail organization.</p>
|
|
1985
2250
|
*/
|
|
1986
2251
|
Rules?: MobileDeviceAccessRule[];
|
|
1987
2252
|
}
|
|
@@ -2063,7 +2328,7 @@ export interface ListResourceDelegatesResponse {
|
|
|
2063
2328
|
/**
|
|
2064
2329
|
* <p>The token used to paginate through the delegates associated with a resource. While
|
|
2065
2330
|
* results are still available, it has an associated value. When the last page is reached, the
|
|
2066
|
-
* token is empty
|
|
2331
|
+
* token is empty.</p>
|
|
2067
2332
|
*/
|
|
2068
2333
|
NextToken?: string;
|
|
2069
2334
|
}
|
|
@@ -2107,11 +2372,11 @@ export interface Resource {
|
|
|
2107
2372
|
*/
|
|
2108
2373
|
State?: EntityState | string;
|
|
2109
2374
|
/**
|
|
2110
|
-
* <p>The date indicating when the resource was enabled for
|
|
2375
|
+
* <p>The date indicating when the resource was enabled for WorkMail use.</p>
|
|
2111
2376
|
*/
|
|
2112
2377
|
EnabledDate?: Date;
|
|
2113
2378
|
/**
|
|
2114
|
-
* <p>The date indicating when the resource was disabled from
|
|
2379
|
+
* <p>The date indicating when the resource was disabled from WorkMail use.</p>
|
|
2115
2380
|
*/
|
|
2116
2381
|
DisabledDate?: Date;
|
|
2117
2382
|
}
|
|
@@ -2168,7 +2433,7 @@ export interface ListUsersRequest {
|
|
|
2168
2433
|
MaxResults?: number;
|
|
2169
2434
|
}
|
|
2170
2435
|
/**
|
|
2171
|
-
* <p>The representation of an
|
|
2436
|
+
* <p>The representation of an WorkMail user.</p>
|
|
2172
2437
|
*/
|
|
2173
2438
|
export interface User {
|
|
2174
2439
|
/**
|
|
@@ -2196,11 +2461,11 @@ export interface User {
|
|
|
2196
2461
|
*/
|
|
2197
2462
|
UserRole?: UserRole | string;
|
|
2198
2463
|
/**
|
|
2199
|
-
* <p>The date indicating when the user was enabled for
|
|
2464
|
+
* <p>The date indicating when the user was enabled for WorkMail use.</p>
|
|
2200
2465
|
*/
|
|
2201
2466
|
EnabledDate?: Date;
|
|
2202
2467
|
/**
|
|
2203
|
-
* <p>The date indicating when the user was disabled from
|
|
2468
|
+
* <p>The date indicating when the user was disabled from WorkMail use.</p>
|
|
2204
2469
|
*/
|
|
2205
2470
|
DisabledDate?: Date;
|
|
2206
2471
|
}
|
|
@@ -2260,6 +2525,14 @@ export interface PutAccessControlRuleRequest {
|
|
|
2260
2525
|
* <p>The identifier of the organization.</p>
|
|
2261
2526
|
*/
|
|
2262
2527
|
OrganizationId: string | undefined;
|
|
2528
|
+
/**
|
|
2529
|
+
* <p>Impersonation role IDs to include in the rule.</p>
|
|
2530
|
+
*/
|
|
2531
|
+
ImpersonationRoleIds?: string[];
|
|
2532
|
+
/**
|
|
2533
|
+
* <p>Impersonation role IDs to exclude from the rule.</p>
|
|
2534
|
+
*/
|
|
2535
|
+
NotImpersonationRoleIds?: string[];
|
|
2263
2536
|
}
|
|
2264
2537
|
export interface PutAccessControlRuleResponse {
|
|
2265
2538
|
}
|
|
@@ -2281,7 +2554,7 @@ export interface PutEmailMonitoringConfigurationResponse {
|
|
|
2281
2554
|
}
|
|
2282
2555
|
export interface PutInboundDmarcSettingsRequest {
|
|
2283
2556
|
/**
|
|
2284
|
-
* <p>The ID of the organization that you are applying the DMARC policy to
|
|
2557
|
+
* <p>The ID of the organization that you are applying the DMARC policy to.</p>
|
|
2285
2558
|
*/
|
|
2286
2559
|
OrganizationId: string | undefined;
|
|
2287
2560
|
/**
|
|
@@ -2321,7 +2594,7 @@ export interface PutMailboxPermissionsResponse {
|
|
|
2321
2594
|
}
|
|
2322
2595
|
export interface PutMobileDeviceAccessOverrideRequest {
|
|
2323
2596
|
/**
|
|
2324
|
-
* <p>Identifies the
|
|
2597
|
+
* <p>Identifies the WorkMail organization for which you create the override.</p>
|
|
2325
2598
|
*/
|
|
2326
2599
|
OrganizationId: string | undefined;
|
|
2327
2600
|
/**
|
|
@@ -2387,11 +2660,11 @@ export interface RegisterMailDomainRequest {
|
|
|
2387
2660
|
*/
|
|
2388
2661
|
ClientToken?: string;
|
|
2389
2662
|
/**
|
|
2390
|
-
* <p>The
|
|
2663
|
+
* <p>The WorkMail organization under which you're creating the domain.</p>
|
|
2391
2664
|
*/
|
|
2392
2665
|
OrganizationId: string | undefined;
|
|
2393
2666
|
/**
|
|
2394
|
-
* <p>The name of the mail domain to create in
|
|
2667
|
+
* <p>The name of the mail domain to create in WorkMail and SES.</p>
|
|
2395
2668
|
*/
|
|
2396
2669
|
DomainName: string | undefined;
|
|
2397
2670
|
}
|
|
@@ -2499,7 +2772,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
2499
2772
|
}
|
|
2500
2773
|
export interface TestAvailabilityConfigurationRequest {
|
|
2501
2774
|
/**
|
|
2502
|
-
* <p>The
|
|
2775
|
+
* <p>The WorkMail organization where the availability provider will be tested.</p>
|
|
2503
2776
|
*/
|
|
2504
2777
|
OrganizationId: string | undefined;
|
|
2505
2778
|
/**
|
|
@@ -2539,7 +2812,7 @@ export interface UntagResourceResponse {
|
|
|
2539
2812
|
}
|
|
2540
2813
|
export interface UpdateAvailabilityConfigurationRequest {
|
|
2541
2814
|
/**
|
|
2542
|
-
* <p>The
|
|
2815
|
+
* <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be
|
|
2543
2816
|
* updated.</p>
|
|
2544
2817
|
*/
|
|
2545
2818
|
OrganizationId: string | undefined;
|
|
@@ -2564,7 +2837,7 @@ export interface UpdateAvailabilityConfigurationResponse {
|
|
|
2564
2837
|
}
|
|
2565
2838
|
export interface UpdateDefaultMailDomainRequest {
|
|
2566
2839
|
/**
|
|
2567
|
-
* <p>The
|
|
2840
|
+
* <p>The WorkMail organization for which to list domains.</p>
|
|
2568
2841
|
*/
|
|
2569
2842
|
OrganizationId: string | undefined;
|
|
2570
2843
|
/**
|
|
@@ -2574,6 +2847,34 @@ export interface UpdateDefaultMailDomainRequest {
|
|
|
2574
2847
|
}
|
|
2575
2848
|
export interface UpdateDefaultMailDomainResponse {
|
|
2576
2849
|
}
|
|
2850
|
+
export interface UpdateImpersonationRoleRequest {
|
|
2851
|
+
/**
|
|
2852
|
+
* <p>The WorkMail organization that contains the impersonation role to update.</p>
|
|
2853
|
+
*/
|
|
2854
|
+
OrganizationId: string | undefined;
|
|
2855
|
+
/**
|
|
2856
|
+
* <p>The ID of the impersonation role to update.</p>
|
|
2857
|
+
*/
|
|
2858
|
+
ImpersonationRoleId: string | undefined;
|
|
2859
|
+
/**
|
|
2860
|
+
* <p>The updated impersonation role name.</p>
|
|
2861
|
+
*/
|
|
2862
|
+
Name: string | undefined;
|
|
2863
|
+
/**
|
|
2864
|
+
* <p>The updated impersonation role type.</p>
|
|
2865
|
+
*/
|
|
2866
|
+
Type: ImpersonationRoleType | string | undefined;
|
|
2867
|
+
/**
|
|
2868
|
+
* <p>The updated impersonation role description.</p>
|
|
2869
|
+
*/
|
|
2870
|
+
Description?: string;
|
|
2871
|
+
/**
|
|
2872
|
+
* <p>The updated list of rules.</p>
|
|
2873
|
+
*/
|
|
2874
|
+
Rules: ImpersonationRule[] | undefined;
|
|
2875
|
+
}
|
|
2876
|
+
export interface UpdateImpersonationRoleResponse {
|
|
2877
|
+
}
|
|
2577
2878
|
export interface UpdateMailboxQuotaRequest {
|
|
2578
2879
|
/**
|
|
2579
2880
|
* <p>The identifier for the organization that contains the user for whom to update the
|
|
@@ -2593,7 +2894,7 @@ export interface UpdateMailboxQuotaResponse {
|
|
|
2593
2894
|
}
|
|
2594
2895
|
export interface UpdateMobileDeviceAccessRuleRequest {
|
|
2595
2896
|
/**
|
|
2596
|
-
* <p>The
|
|
2897
|
+
* <p>The WorkMail organization under which the rule will be updated.</p>
|
|
2597
2898
|
*/
|
|
2598
2899
|
OrganizationId: string | undefined;
|
|
2599
2900
|
/**
|
|
@@ -2704,6 +3005,14 @@ export declare const AssociateMemberToGroupRequestFilterSensitiveLog: (obj: Asso
|
|
|
2704
3005
|
* @internal
|
|
2705
3006
|
*/
|
|
2706
3007
|
export declare const AssociateMemberToGroupResponseFilterSensitiveLog: (obj: AssociateMemberToGroupResponse) => any;
|
|
3008
|
+
/**
|
|
3009
|
+
* @internal
|
|
3010
|
+
*/
|
|
3011
|
+
export declare const AssumeImpersonationRoleRequestFilterSensitiveLog: (obj: AssumeImpersonationRoleRequest) => any;
|
|
3012
|
+
/**
|
|
3013
|
+
* @internal
|
|
3014
|
+
*/
|
|
3015
|
+
export declare const AssumeImpersonationRoleResponseFilterSensitiveLog: (obj: AssumeImpersonationRoleResponse) => any;
|
|
2707
3016
|
/**
|
|
2708
3017
|
* @internal
|
|
2709
3018
|
*/
|
|
@@ -2756,6 +3065,18 @@ export declare const CreateGroupRequestFilterSensitiveLog: (obj: CreateGroupRequ
|
|
|
2756
3065
|
* @internal
|
|
2757
3066
|
*/
|
|
2758
3067
|
export declare const CreateGroupResponseFilterSensitiveLog: (obj: CreateGroupResponse) => any;
|
|
3068
|
+
/**
|
|
3069
|
+
* @internal
|
|
3070
|
+
*/
|
|
3071
|
+
export declare const ImpersonationRuleFilterSensitiveLog: (obj: ImpersonationRule) => any;
|
|
3072
|
+
/**
|
|
3073
|
+
* @internal
|
|
3074
|
+
*/
|
|
3075
|
+
export declare const CreateImpersonationRoleRequestFilterSensitiveLog: (obj: CreateImpersonationRoleRequest) => any;
|
|
3076
|
+
/**
|
|
3077
|
+
* @internal
|
|
3078
|
+
*/
|
|
3079
|
+
export declare const CreateImpersonationRoleResponseFilterSensitiveLog: (obj: CreateImpersonationRoleResponse) => any;
|
|
2759
3080
|
/**
|
|
2760
3081
|
* @internal
|
|
2761
3082
|
*/
|
|
@@ -2836,6 +3157,14 @@ export declare const DeleteGroupRequestFilterSensitiveLog: (obj: DeleteGroupRequ
|
|
|
2836
3157
|
* @internal
|
|
2837
3158
|
*/
|
|
2838
3159
|
export declare const DeleteGroupResponseFilterSensitiveLog: (obj: DeleteGroupResponse) => any;
|
|
3160
|
+
/**
|
|
3161
|
+
* @internal
|
|
3162
|
+
*/
|
|
3163
|
+
export declare const DeleteImpersonationRoleRequestFilterSensitiveLog: (obj: DeleteImpersonationRoleRequest) => any;
|
|
3164
|
+
/**
|
|
3165
|
+
* @internal
|
|
3166
|
+
*/
|
|
3167
|
+
export declare const DeleteImpersonationRoleResponseFilterSensitiveLog: (obj: DeleteImpersonationRoleResponse) => any;
|
|
2839
3168
|
/**
|
|
2840
3169
|
* @internal
|
|
2841
3170
|
*/
|
|
@@ -3004,6 +3333,26 @@ export declare const GetDefaultRetentionPolicyRequestFilterSensitiveLog: (obj: G
|
|
|
3004
3333
|
* @internal
|
|
3005
3334
|
*/
|
|
3006
3335
|
export declare const GetDefaultRetentionPolicyResponseFilterSensitiveLog: (obj: GetDefaultRetentionPolicyResponse) => any;
|
|
3336
|
+
/**
|
|
3337
|
+
* @internal
|
|
3338
|
+
*/
|
|
3339
|
+
export declare const GetImpersonationRoleRequestFilterSensitiveLog: (obj: GetImpersonationRoleRequest) => any;
|
|
3340
|
+
/**
|
|
3341
|
+
* @internal
|
|
3342
|
+
*/
|
|
3343
|
+
export declare const GetImpersonationRoleResponseFilterSensitiveLog: (obj: GetImpersonationRoleResponse) => any;
|
|
3344
|
+
/**
|
|
3345
|
+
* @internal
|
|
3346
|
+
*/
|
|
3347
|
+
export declare const GetImpersonationRoleEffectRequestFilterSensitiveLog: (obj: GetImpersonationRoleEffectRequest) => any;
|
|
3348
|
+
/**
|
|
3349
|
+
* @internal
|
|
3350
|
+
*/
|
|
3351
|
+
export declare const ImpersonationMatchedRuleFilterSensitiveLog: (obj: ImpersonationMatchedRule) => any;
|
|
3352
|
+
/**
|
|
3353
|
+
* @internal
|
|
3354
|
+
*/
|
|
3355
|
+
export declare const GetImpersonationRoleEffectResponseFilterSensitiveLog: (obj: GetImpersonationRoleEffectResponse) => any;
|
|
3007
3356
|
/**
|
|
3008
3357
|
* @internal
|
|
3009
3358
|
*/
|
|
@@ -3044,6 +3393,10 @@ export declare const GetMobileDeviceAccessOverrideResponseFilterSensitiveLog: (o
|
|
|
3044
3393
|
* @internal
|
|
3045
3394
|
*/
|
|
3046
3395
|
export declare const GroupFilterSensitiveLog: (obj: Group) => any;
|
|
3396
|
+
/**
|
|
3397
|
+
* @internal
|
|
3398
|
+
*/
|
|
3399
|
+
export declare const ImpersonationRoleFilterSensitiveLog: (obj: ImpersonationRole) => any;
|
|
3047
3400
|
/**
|
|
3048
3401
|
* @internal
|
|
3049
3402
|
*/
|
|
@@ -3092,6 +3445,14 @@ export declare const ListGroupsRequestFilterSensitiveLog: (obj: ListGroupsReques
|
|
|
3092
3445
|
* @internal
|
|
3093
3446
|
*/
|
|
3094
3447
|
export declare const ListGroupsResponseFilterSensitiveLog: (obj: ListGroupsResponse) => any;
|
|
3448
|
+
/**
|
|
3449
|
+
* @internal
|
|
3450
|
+
*/
|
|
3451
|
+
export declare const ListImpersonationRolesRequestFilterSensitiveLog: (obj: ListImpersonationRolesRequest) => any;
|
|
3452
|
+
/**
|
|
3453
|
+
* @internal
|
|
3454
|
+
*/
|
|
3455
|
+
export declare const ListImpersonationRolesResponseFilterSensitiveLog: (obj: ListImpersonationRolesResponse) => any;
|
|
3095
3456
|
/**
|
|
3096
3457
|
* @internal
|
|
3097
3458
|
*/
|
|
@@ -3324,6 +3685,14 @@ export declare const UpdateDefaultMailDomainRequestFilterSensitiveLog: (obj: Upd
|
|
|
3324
3685
|
* @internal
|
|
3325
3686
|
*/
|
|
3326
3687
|
export declare const UpdateDefaultMailDomainResponseFilterSensitiveLog: (obj: UpdateDefaultMailDomainResponse) => any;
|
|
3688
|
+
/**
|
|
3689
|
+
* @internal
|
|
3690
|
+
*/
|
|
3691
|
+
export declare const UpdateImpersonationRoleRequestFilterSensitiveLog: (obj: UpdateImpersonationRoleRequest) => any;
|
|
3692
|
+
/**
|
|
3693
|
+
* @internal
|
|
3694
|
+
*/
|
|
3695
|
+
export declare const UpdateImpersonationRoleResponseFilterSensitiveLog: (obj: UpdateImpersonationRoleResponse) => any;
|
|
3327
3696
|
/**
|
|
3328
3697
|
* @internal
|
|
3329
3698
|
*/
|