@aws-sdk/client-workmail 3.533.0 → 3.540.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.
Files changed (179) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/WorkMail.d.ts +2 -1
  6. package/dist-types/WorkMailClient.d.ts +1 -1
  7. package/dist-types/commands/AssociateDelegateToResourceCommand.d.ts +2 -1
  8. package/dist-types/commands/AssociateMemberToGroupCommand.d.ts +2 -1
  9. package/dist-types/commands/AssumeImpersonationRoleCommand.d.ts +2 -1
  10. package/dist-types/commands/CancelMailboxExportJobCommand.d.ts +2 -1
  11. package/dist-types/commands/CreateAliasCommand.d.ts +2 -1
  12. package/dist-types/commands/CreateAvailabilityConfigurationCommand.d.ts +2 -1
  13. package/dist-types/commands/CreateGroupCommand.d.ts +2 -1
  14. package/dist-types/commands/CreateImpersonationRoleCommand.d.ts +2 -1
  15. package/dist-types/commands/CreateMobileDeviceAccessRuleCommand.d.ts +2 -1
  16. package/dist-types/commands/CreateOrganizationCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateResourceCommand.d.ts +2 -1
  18. package/dist-types/commands/CreateUserCommand.d.ts +2 -1
  19. package/dist-types/commands/DeleteAccessControlRuleCommand.d.ts +2 -1
  20. package/dist-types/commands/DeleteAliasCommand.d.ts +2 -1
  21. package/dist-types/commands/DeleteAvailabilityConfigurationCommand.d.ts +2 -1
  22. package/dist-types/commands/DeleteEmailMonitoringConfigurationCommand.d.ts +2 -1
  23. package/dist-types/commands/DeleteGroupCommand.d.ts +2 -1
  24. package/dist-types/commands/DeleteImpersonationRoleCommand.d.ts +2 -1
  25. package/dist-types/commands/DeleteMailboxPermissionsCommand.d.ts +2 -1
  26. package/dist-types/commands/DeleteMobileDeviceAccessOverrideCommand.d.ts +2 -1
  27. package/dist-types/commands/DeleteMobileDeviceAccessRuleCommand.d.ts +2 -1
  28. package/dist-types/commands/DeleteOrganizationCommand.d.ts +2 -1
  29. package/dist-types/commands/DeleteResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +2 -1
  31. package/dist-types/commands/DeleteUserCommand.d.ts +2 -1
  32. package/dist-types/commands/DeregisterFromWorkMailCommand.d.ts +2 -1
  33. package/dist-types/commands/DeregisterMailDomainCommand.d.ts +2 -1
  34. package/dist-types/commands/DescribeEmailMonitoringConfigurationCommand.d.ts +2 -1
  35. package/dist-types/commands/DescribeEntityCommand.d.ts +2 -1
  36. package/dist-types/commands/DescribeGroupCommand.d.ts +2 -1
  37. package/dist-types/commands/DescribeInboundDmarcSettingsCommand.d.ts +2 -1
  38. package/dist-types/commands/DescribeMailboxExportJobCommand.d.ts +2 -1
  39. package/dist-types/commands/DescribeOrganizationCommand.d.ts +2 -1
  40. package/dist-types/commands/DescribeResourceCommand.d.ts +2 -1
  41. package/dist-types/commands/DescribeUserCommand.d.ts +2 -1
  42. package/dist-types/commands/DisassociateDelegateFromResourceCommand.d.ts +2 -1
  43. package/dist-types/commands/DisassociateMemberFromGroupCommand.d.ts +2 -1
  44. package/dist-types/commands/GetAccessControlEffectCommand.d.ts +2 -1
  45. package/dist-types/commands/GetDefaultRetentionPolicyCommand.d.ts +2 -1
  46. package/dist-types/commands/GetImpersonationRoleCommand.d.ts +2 -1
  47. package/dist-types/commands/GetImpersonationRoleEffectCommand.d.ts +2 -1
  48. package/dist-types/commands/GetMailDomainCommand.d.ts +2 -1
  49. package/dist-types/commands/GetMailboxDetailsCommand.d.ts +2 -1
  50. package/dist-types/commands/GetMobileDeviceAccessEffectCommand.d.ts +2 -1
  51. package/dist-types/commands/GetMobileDeviceAccessOverrideCommand.d.ts +2 -1
  52. package/dist-types/commands/ListAccessControlRulesCommand.d.ts +2 -1
  53. package/dist-types/commands/ListAliasesCommand.d.ts +2 -1
  54. package/dist-types/commands/ListAvailabilityConfigurationsCommand.d.ts +2 -1
  55. package/dist-types/commands/ListGroupMembersCommand.d.ts +2 -1
  56. package/dist-types/commands/ListGroupsCommand.d.ts +2 -1
  57. package/dist-types/commands/ListGroupsForEntityCommand.d.ts +2 -1
  58. package/dist-types/commands/ListImpersonationRolesCommand.d.ts +2 -1
  59. package/dist-types/commands/ListMailDomainsCommand.d.ts +2 -1
  60. package/dist-types/commands/ListMailboxExportJobsCommand.d.ts +2 -1
  61. package/dist-types/commands/ListMailboxPermissionsCommand.d.ts +2 -1
  62. package/dist-types/commands/ListMobileDeviceAccessOverridesCommand.d.ts +2 -1
  63. package/dist-types/commands/ListMobileDeviceAccessRulesCommand.d.ts +2 -1
  64. package/dist-types/commands/ListOrganizationsCommand.d.ts +2 -1
  65. package/dist-types/commands/ListResourceDelegatesCommand.d.ts +2 -1
  66. package/dist-types/commands/ListResourcesCommand.d.ts +2 -1
  67. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  68. package/dist-types/commands/ListUsersCommand.d.ts +2 -1
  69. package/dist-types/commands/PutAccessControlRuleCommand.d.ts +2 -1
  70. package/dist-types/commands/PutEmailMonitoringConfigurationCommand.d.ts +2 -1
  71. package/dist-types/commands/PutInboundDmarcSettingsCommand.d.ts +2 -1
  72. package/dist-types/commands/PutMailboxPermissionsCommand.d.ts +2 -1
  73. package/dist-types/commands/PutMobileDeviceAccessOverrideCommand.d.ts +2 -1
  74. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +2 -1
  75. package/dist-types/commands/RegisterMailDomainCommand.d.ts +2 -1
  76. package/dist-types/commands/RegisterToWorkMailCommand.d.ts +2 -1
  77. package/dist-types/commands/ResetPasswordCommand.d.ts +2 -1
  78. package/dist-types/commands/StartMailboxExportJobCommand.d.ts +2 -1
  79. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  80. package/dist-types/commands/TestAvailabilityConfigurationCommand.d.ts +2 -1
  81. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  82. package/dist-types/commands/UpdateAvailabilityConfigurationCommand.d.ts +2 -1
  83. package/dist-types/commands/UpdateDefaultMailDomainCommand.d.ts +2 -1
  84. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
  85. package/dist-types/commands/UpdateImpersonationRoleCommand.d.ts +2 -1
  86. package/dist-types/commands/UpdateMailboxQuotaCommand.d.ts +2 -1
  87. package/dist-types/commands/UpdateMobileDeviceAccessRuleCommand.d.ts +2 -1
  88. package/dist-types/commands/UpdatePrimaryEmailAddressCommand.d.ts +2 -1
  89. package/dist-types/commands/UpdateResourceCommand.d.ts +2 -1
  90. package/dist-types/commands/UpdateUserCommand.d.ts +2 -1
  91. package/dist-types/index.d.ts +0 -1
  92. package/dist-types/models/models_0.d.ts +636 -636
  93. package/dist-types/ts3.4/WorkMail.d.ts +1 -0
  94. package/dist-types/ts3.4/commands/AssociateDelegateToResourceCommand.d.ts +9 -0
  95. package/dist-types/ts3.4/commands/AssociateMemberToGroupCommand.d.ts +9 -0
  96. package/dist-types/ts3.4/commands/AssumeImpersonationRoleCommand.d.ts +9 -0
  97. package/dist-types/ts3.4/commands/CancelMailboxExportJobCommand.d.ts +9 -0
  98. package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +9 -0
  99. package/dist-types/ts3.4/commands/CreateAvailabilityConfigurationCommand.d.ts +9 -0
  100. package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +9 -0
  101. package/dist-types/ts3.4/commands/CreateImpersonationRoleCommand.d.ts +9 -0
  102. package/dist-types/ts3.4/commands/CreateMobileDeviceAccessRuleCommand.d.ts +9 -0
  103. package/dist-types/ts3.4/commands/CreateOrganizationCommand.d.ts +9 -0
  104. package/dist-types/ts3.4/commands/CreateResourceCommand.d.ts +9 -0
  105. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +9 -0
  106. package/dist-types/ts3.4/commands/DeleteAccessControlRuleCommand.d.ts +9 -0
  107. package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +9 -0
  108. package/dist-types/ts3.4/commands/DeleteAvailabilityConfigurationCommand.d.ts +9 -0
  109. package/dist-types/ts3.4/commands/DeleteEmailMonitoringConfigurationCommand.d.ts +9 -0
  110. package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +9 -0
  111. package/dist-types/ts3.4/commands/DeleteImpersonationRoleCommand.d.ts +9 -0
  112. package/dist-types/ts3.4/commands/DeleteMailboxPermissionsCommand.d.ts +9 -0
  113. package/dist-types/ts3.4/commands/DeleteMobileDeviceAccessOverrideCommand.d.ts +9 -0
  114. package/dist-types/ts3.4/commands/DeleteMobileDeviceAccessRuleCommand.d.ts +9 -0
  115. package/dist-types/ts3.4/commands/DeleteOrganizationCommand.d.ts +9 -0
  116. package/dist-types/ts3.4/commands/DeleteResourceCommand.d.ts +9 -0
  117. package/dist-types/ts3.4/commands/DeleteRetentionPolicyCommand.d.ts +9 -0
  118. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +9 -0
  119. package/dist-types/ts3.4/commands/DeregisterFromWorkMailCommand.d.ts +9 -0
  120. package/dist-types/ts3.4/commands/DeregisterMailDomainCommand.d.ts +9 -0
  121. package/dist-types/ts3.4/commands/DescribeEmailMonitoringConfigurationCommand.d.ts +9 -0
  122. package/dist-types/ts3.4/commands/DescribeEntityCommand.d.ts +9 -0
  123. package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +9 -0
  124. package/dist-types/ts3.4/commands/DescribeInboundDmarcSettingsCommand.d.ts +9 -0
  125. package/dist-types/ts3.4/commands/DescribeMailboxExportJobCommand.d.ts +9 -0
  126. package/dist-types/ts3.4/commands/DescribeOrganizationCommand.d.ts +9 -0
  127. package/dist-types/ts3.4/commands/DescribeResourceCommand.d.ts +9 -0
  128. package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +9 -0
  129. package/dist-types/ts3.4/commands/DisassociateDelegateFromResourceCommand.d.ts +9 -0
  130. package/dist-types/ts3.4/commands/DisassociateMemberFromGroupCommand.d.ts +9 -0
  131. package/dist-types/ts3.4/commands/GetAccessControlEffectCommand.d.ts +9 -0
  132. package/dist-types/ts3.4/commands/GetDefaultRetentionPolicyCommand.d.ts +9 -0
  133. package/dist-types/ts3.4/commands/GetImpersonationRoleCommand.d.ts +9 -0
  134. package/dist-types/ts3.4/commands/GetImpersonationRoleEffectCommand.d.ts +9 -0
  135. package/dist-types/ts3.4/commands/GetMailDomainCommand.d.ts +9 -0
  136. package/dist-types/ts3.4/commands/GetMailboxDetailsCommand.d.ts +9 -0
  137. package/dist-types/ts3.4/commands/GetMobileDeviceAccessEffectCommand.d.ts +9 -0
  138. package/dist-types/ts3.4/commands/GetMobileDeviceAccessOverrideCommand.d.ts +9 -0
  139. package/dist-types/ts3.4/commands/ListAccessControlRulesCommand.d.ts +9 -0
  140. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +9 -0
  141. package/dist-types/ts3.4/commands/ListAvailabilityConfigurationsCommand.d.ts +9 -0
  142. package/dist-types/ts3.4/commands/ListGroupMembersCommand.d.ts +9 -0
  143. package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +9 -0
  144. package/dist-types/ts3.4/commands/ListGroupsForEntityCommand.d.ts +9 -0
  145. package/dist-types/ts3.4/commands/ListImpersonationRolesCommand.d.ts +9 -0
  146. package/dist-types/ts3.4/commands/ListMailDomainsCommand.d.ts +9 -0
  147. package/dist-types/ts3.4/commands/ListMailboxExportJobsCommand.d.ts +9 -0
  148. package/dist-types/ts3.4/commands/ListMailboxPermissionsCommand.d.ts +9 -0
  149. package/dist-types/ts3.4/commands/ListMobileDeviceAccessOverridesCommand.d.ts +9 -0
  150. package/dist-types/ts3.4/commands/ListMobileDeviceAccessRulesCommand.d.ts +9 -0
  151. package/dist-types/ts3.4/commands/ListOrganizationsCommand.d.ts +9 -0
  152. package/dist-types/ts3.4/commands/ListResourceDelegatesCommand.d.ts +9 -0
  153. package/dist-types/ts3.4/commands/ListResourcesCommand.d.ts +9 -0
  154. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  155. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +9 -0
  156. package/dist-types/ts3.4/commands/PutAccessControlRuleCommand.d.ts +9 -0
  157. package/dist-types/ts3.4/commands/PutEmailMonitoringConfigurationCommand.d.ts +9 -0
  158. package/dist-types/ts3.4/commands/PutInboundDmarcSettingsCommand.d.ts +9 -0
  159. package/dist-types/ts3.4/commands/PutMailboxPermissionsCommand.d.ts +9 -0
  160. package/dist-types/ts3.4/commands/PutMobileDeviceAccessOverrideCommand.d.ts +9 -0
  161. package/dist-types/ts3.4/commands/PutRetentionPolicyCommand.d.ts +9 -0
  162. package/dist-types/ts3.4/commands/RegisterMailDomainCommand.d.ts +9 -0
  163. package/dist-types/ts3.4/commands/RegisterToWorkMailCommand.d.ts +9 -0
  164. package/dist-types/ts3.4/commands/ResetPasswordCommand.d.ts +9 -0
  165. package/dist-types/ts3.4/commands/StartMailboxExportJobCommand.d.ts +9 -0
  166. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  167. package/dist-types/ts3.4/commands/TestAvailabilityConfigurationCommand.d.ts +9 -0
  168. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  169. package/dist-types/ts3.4/commands/UpdateAvailabilityConfigurationCommand.d.ts +9 -0
  170. package/dist-types/ts3.4/commands/UpdateDefaultMailDomainCommand.d.ts +9 -0
  171. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +9 -0
  172. package/dist-types/ts3.4/commands/UpdateImpersonationRoleCommand.d.ts +9 -0
  173. package/dist-types/ts3.4/commands/UpdateMailboxQuotaCommand.d.ts +9 -0
  174. package/dist-types/ts3.4/commands/UpdateMobileDeviceAccessRuleCommand.d.ts +9 -0
  175. package/dist-types/ts3.4/commands/UpdatePrimaryEmailAddressCommand.d.ts +9 -0
  176. package/dist-types/ts3.4/commands/UpdateResourceCommand.d.ts +9 -0
  177. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +9 -0
  178. package/dist-types/ts3.4/index.d.ts +0 -1
  179. package/package.json +40 -40
@@ -13,77 +13,77 @@ export declare const AccessControlRuleEffect: {
13
13
  */
14
14
  export type AccessControlRuleEffect = (typeof AccessControlRuleEffect)[keyof typeof AccessControlRuleEffect];
15
15
  /**
16
- * @public
17
16
  * <p>A rule that controls access to an WorkMail organization.</p>
17
+ * @public
18
18
  */
19
19
  export interface AccessControlRule {
20
20
  /**
21
- * @public
22
21
  * <p>The rule name.</p>
22
+ * @public
23
23
  */
24
24
  Name?: string;
25
25
  /**
26
- * @public
27
26
  * <p>The rule effect.</p>
27
+ * @public
28
28
  */
29
29
  Effect?: AccessControlRuleEffect;
30
30
  /**
31
- * @public
32
31
  * <p>The rule description.</p>
32
+ * @public
33
33
  */
34
34
  Description?: string;
35
35
  /**
36
- * @public
37
36
  * <p>IPv4 CIDR ranges to include in the rule.</p>
37
+ * @public
38
38
  */
39
39
  IpRanges?: string[];
40
40
  /**
41
- * @public
42
41
  * <p>IPv4 CIDR ranges to exclude from the rule.</p>
42
+ * @public
43
43
  */
44
44
  NotIpRanges?: string[];
45
45
  /**
46
- * @public
47
46
  * <p>Access protocol actions to include in the rule. Valid values include
48
47
  * <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
49
48
  * <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
49
+ * @public
50
50
  */
51
51
  Actions?: string[];
52
52
  /**
53
- * @public
54
53
  * <p>Access protocol actions to exclude from the rule. Valid values include
55
54
  * <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
56
55
  * <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
56
+ * @public
57
57
  */
58
58
  NotActions?: string[];
59
59
  /**
60
- * @public
61
60
  * <p>User IDs to include in the rule.</p>
61
+ * @public
62
62
  */
63
63
  UserIds?: string[];
64
64
  /**
65
- * @public
66
65
  * <p>User IDs to exclude from the rule.</p>
66
+ * @public
67
67
  */
68
68
  NotUserIds?: string[];
69
69
  /**
70
- * @public
71
70
  * <p>The date that the rule was created.</p>
71
+ * @public
72
72
  */
73
73
  DateCreated?: Date;
74
74
  /**
75
- * @public
76
75
  * <p>The date that the rule was modified.</p>
76
+ * @public
77
77
  */
78
78
  DateModified?: Date;
79
79
  /**
80
- * @public
81
80
  * <p>Impersonation role IDs to include in the rule.</p>
81
+ * @public
82
82
  */
83
83
  ImpersonationRoleIds?: string[];
84
84
  /**
85
- * @public
86
85
  * <p>Impersonation role IDs to exclude from the rule.</p>
86
+ * @public
87
87
  */
88
88
  NotImpersonationRoleIds?: string[];
89
89
  }
@@ -104,12 +104,11 @@ export type AccessEffect = (typeof AccessEffect)[keyof typeof AccessEffect];
104
104
  */
105
105
  export interface AssociateDelegateToResourceRequest {
106
106
  /**
107
- * @public
108
107
  * <p>The organization under which the resource exists.</p>
108
+ * @public
109
109
  */
110
110
  OrganizationId: string | undefined;
111
111
  /**
112
- * @public
113
112
  * <p>The resource for which members (users or groups) are associated.</p>
114
113
  * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
115
114
  * <ul>
@@ -123,10 +122,10 @@ export interface AssociateDelegateToResourceRequest {
123
122
  * <p>Resource name: resource</p>
124
123
  * </li>
125
124
  * </ul>
125
+ * @public
126
126
  */
127
127
  ResourceId: string | undefined;
128
128
  /**
129
- * @public
130
129
  * <p>The member (user or group) to associate to the resource.</p>
131
130
  * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
132
131
  * <ul>
@@ -140,6 +139,7 @@ export interface AssociateDelegateToResourceRequest {
140
139
  * <p>Entity: entity</p>
141
140
  * </li>
142
141
  * </ul>
142
+ * @public
143
143
  */
144
144
  EntityId: string | undefined;
145
145
  }
@@ -149,9 +149,9 @@ export interface AssociateDelegateToResourceRequest {
149
149
  export interface AssociateDelegateToResourceResponse {
150
150
  }
151
151
  /**
152
- * @public
153
152
  * <p>The identifier supplied for the user, group, or resource does not exist in your
154
153
  * organization.</p>
154
+ * @public
155
155
  */
156
156
  export declare class EntityNotFoundException extends __BaseException {
157
157
  readonly name: "EntityNotFoundException";
@@ -163,9 +163,9 @@ export declare class EntityNotFoundException extends __BaseException {
163
163
  constructor(opts: __ExceptionOptionType<EntityNotFoundException, __BaseException>);
164
164
  }
165
165
  /**
166
- * @public
167
166
  * <p>You are performing an operation on a user, group, or resource that isn't in the
168
167
  * expected state, such as trying to delete an active user.</p>
168
+ * @public
169
169
  */
170
170
  export declare class EntityStateException extends __BaseException {
171
171
  readonly name: "EntityStateException";
@@ -177,8 +177,8 @@ export declare class EntityStateException extends __BaseException {
177
177
  constructor(opts: __ExceptionOptionType<EntityStateException, __BaseException>);
178
178
  }
179
179
  /**
180
- * @public
181
180
  * <p>One or more of the input parameters don't match the service's restrictions.</p>
181
+ * @public
182
182
  */
183
183
  export declare class InvalidParameterException extends __BaseException {
184
184
  readonly name: "InvalidParameterException";
@@ -190,9 +190,9 @@ export declare class InvalidParameterException extends __BaseException {
190
190
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
191
191
  }
192
192
  /**
193
- * @public
194
193
  * <p>An operation received a valid organization identifier that either doesn't belong or
195
194
  * exist in the system.</p>
195
+ * @public
196
196
  */
197
197
  export declare class OrganizationNotFoundException extends __BaseException {
198
198
  readonly name: "OrganizationNotFoundException";
@@ -204,9 +204,9 @@ export declare class OrganizationNotFoundException extends __BaseException {
204
204
  constructor(opts: __ExceptionOptionType<OrganizationNotFoundException, __BaseException>);
205
205
  }
206
206
  /**
207
- * @public
208
207
  * <p>The organization must have a valid state to perform certain
209
208
  * operations on the organization or its members.</p>
209
+ * @public
210
210
  */
211
211
  export declare class OrganizationStateException extends __BaseException {
212
212
  readonly name: "OrganizationStateException";
@@ -218,8 +218,8 @@ export declare class OrganizationStateException extends __BaseException {
218
218
  constructor(opts: __ExceptionOptionType<OrganizationStateException, __BaseException>);
219
219
  }
220
220
  /**
221
- * @public
222
221
  * <p>You can't perform a write operation against a read-only directory.</p>
222
+ * @public
223
223
  */
224
224
  export declare class UnsupportedOperationException extends __BaseException {
225
225
  readonly name: "UnsupportedOperationException";
@@ -235,12 +235,11 @@ export declare class UnsupportedOperationException extends __BaseException {
235
235
  */
236
236
  export interface AssociateMemberToGroupRequest {
237
237
  /**
238
- * @public
239
238
  * <p>The organization under which the group exists.</p>
239
+ * @public
240
240
  */
241
241
  OrganizationId: string | undefined;
242
242
  /**
243
- * @public
244
243
  * <p>The group to which the member (user or group) is associated.</p>
245
244
  * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
246
245
  * <ul>
@@ -254,10 +253,10 @@ export interface AssociateMemberToGroupRequest {
254
253
  * <p>Group name: group</p>
255
254
  * </li>
256
255
  * </ul>
256
+ * @public
257
257
  */
258
258
  GroupId: string | undefined;
259
259
  /**
260
- * @public
261
260
  * <p>The member (user or group) to associate to the group.</p>
262
261
  * <p>The member ID can accept <i>UserID or GroupId</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
263
262
  * <ul>
@@ -271,6 +270,7 @@ export interface AssociateMemberToGroupRequest {
271
270
  * <p>Member name: member</p>
272
271
  * </li>
273
272
  * </ul>
273
+ * @public
274
274
  */
275
275
  MemberId: string | undefined;
276
276
  }
@@ -280,8 +280,8 @@ export interface AssociateMemberToGroupRequest {
280
280
  export interface AssociateMemberToGroupResponse {
281
281
  }
282
282
  /**
283
- * @public
284
283
  * <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
284
+ * @public
285
285
  */
286
286
  export declare class DirectoryServiceAuthenticationFailedException extends __BaseException {
287
287
  readonly name: "DirectoryServiceAuthenticationFailedException";
@@ -293,8 +293,8 @@ export declare class DirectoryServiceAuthenticationFailedException extends __Bas
293
293
  constructor(opts: __ExceptionOptionType<DirectoryServiceAuthenticationFailedException, __BaseException>);
294
294
  }
295
295
  /**
296
- * @public
297
296
  * <p>The directory is unavailable. It might be located in another Region or deleted.</p>
297
+ * @public
298
298
  */
299
299
  export declare class DirectoryUnavailableException extends __BaseException {
300
300
  readonly name: "DirectoryUnavailableException";
@@ -310,13 +310,13 @@ export declare class DirectoryUnavailableException extends __BaseException {
310
310
  */
311
311
  export interface AssumeImpersonationRoleRequest {
312
312
  /**
313
- * @public
314
313
  * <p>The WorkMail organization under which the impersonation role will be assumed.</p>
314
+ * @public
315
315
  */
316
316
  OrganizationId: string | undefined;
317
317
  /**
318
- * @public
319
318
  * <p>The impersonation role ID to assume.</p>
319
+ * @public
320
320
  */
321
321
  ImpersonationRoleId: string | undefined;
322
322
  }
@@ -325,19 +325,19 @@ export interface AssumeImpersonationRoleRequest {
325
325
  */
326
326
  export interface AssumeImpersonationRoleResponse {
327
327
  /**
328
- * @public
329
328
  * <p>The authentication token for the impersonation role.</p>
329
+ * @public
330
330
  */
331
331
  Token?: string;
332
332
  /**
333
- * @public
334
333
  * <p>The authentication token's validity, in seconds.</p>
334
+ * @public
335
335
  */
336
336
  ExpiresIn?: number;
337
337
  }
338
338
  /**
339
- * @public
340
339
  * <p>The resource cannot be found.</p>
340
+ * @public
341
341
  */
342
342
  export declare class ResourceNotFoundException extends __BaseException {
343
343
  readonly name: "ResourceNotFoundException";
@@ -349,30 +349,30 @@ export declare class ResourceNotFoundException extends __BaseException {
349
349
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
350
350
  }
351
351
  /**
352
- * @public
353
352
  * <p>Describes an EWS based availability provider when returned from the service. It does not
354
353
  * contain the password of the endpoint.</p>
354
+ * @public
355
355
  */
356
356
  export interface RedactedEwsAvailabilityProvider {
357
357
  /**
358
- * @public
359
358
  * <p>The endpoint of the remote EWS server.</p>
359
+ * @public
360
360
  */
361
361
  EwsEndpoint?: string;
362
362
  /**
363
- * @public
364
363
  * <p>The username used to authenticate the remote EWS server.</p>
364
+ * @public
365
365
  */
366
366
  EwsUsername?: string;
367
367
  }
368
368
  /**
369
- * @public
370
369
  * <p>Describes a Lambda based availability provider.</p>
370
+ * @public
371
371
  */
372
372
  export interface LambdaAvailabilityProvider {
373
373
  /**
374
- * @public
375
374
  * <p>The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.</p>
375
+ * @public
376
376
  */
377
377
  LambdaArn: string | undefined;
378
378
  }
@@ -389,64 +389,64 @@ export declare const AvailabilityProviderType: {
389
389
  */
390
390
  export type AvailabilityProviderType = (typeof AvailabilityProviderType)[keyof typeof AvailabilityProviderType];
391
391
  /**
392
- * @public
393
392
  * <p>List all the <code>AvailabilityConfiguration</code>'s for the given WorkMail
394
393
  * organization.</p>
394
+ * @public
395
395
  */
396
396
  export interface AvailabilityConfiguration {
397
397
  /**
398
- * @public
399
398
  * <p>Displays the domain to which the provider applies.</p>
399
+ * @public
400
400
  */
401
401
  DomainName?: string;
402
402
  /**
403
- * @public
404
403
  * <p>Displays the provider type that applies to this domain.</p>
404
+ * @public
405
405
  */
406
406
  ProviderType?: AvailabilityProviderType;
407
407
  /**
408
- * @public
409
408
  * <p>If <code>ProviderType</code> is <code>EWS</code>, then this field contains
410
409
  * <code>RedactedEwsAvailabilityProvider</code>. Otherwise, it is not required.</p>
410
+ * @public
411
411
  */
412
412
  EwsProvider?: RedactedEwsAvailabilityProvider;
413
413
  /**
414
- * @public
415
414
  * <p>If ProviderType is <code>LAMBDA</code> then this field contains
416
415
  * <code>LambdaAvailabilityProvider</code>. Otherwise, it is not required.</p>
416
+ * @public
417
417
  */
418
418
  LambdaProvider?: LambdaAvailabilityProvider;
419
419
  /**
420
- * @public
421
420
  * <p>The date and time at which the availability configuration was created.</p>
421
+ * @public
422
422
  */
423
423
  DateCreated?: Date;
424
424
  /**
425
- * @public
426
425
  * <p>The date and time at which the availability configuration was last modified.</p>
426
+ * @public
427
427
  */
428
428
  DateModified?: Date;
429
429
  }
430
430
  /**
431
- * @public
432
431
  * <p>At least one delegate must be associated to the resource to disable automatic replies
433
432
  * from the resource.</p>
433
+ * @public
434
434
  */
435
435
  export interface BookingOptions {
436
436
  /**
437
- * @public
438
437
  * <p>The resource's ability to automatically reply to requests. If disabled, delegates
439
438
  * must be associated to the resource.</p>
439
+ * @public
440
440
  */
441
441
  AutoAcceptRequests?: boolean;
442
442
  /**
443
- * @public
444
443
  * <p>The resource's ability to automatically decline any recurring requests.</p>
444
+ * @public
445
445
  */
446
446
  AutoDeclineRecurringRequests?: boolean;
447
447
  /**
448
- * @public
449
448
  * <p>The resource's ability to automatically decline any conflicting requests.</p>
449
+ * @public
450
450
  */
451
451
  AutoDeclineConflictingRequests?: boolean;
452
452
  }
@@ -455,18 +455,18 @@ export interface BookingOptions {
455
455
  */
456
456
  export interface CancelMailboxExportJobRequest {
457
457
  /**
458
- * @public
459
458
  * <p>The idempotency token for the client request.</p>
459
+ * @public
460
460
  */
461
461
  ClientToken?: string;
462
462
  /**
463
- * @public
464
463
  * <p>The job ID.</p>
464
+ * @public
465
465
  */
466
466
  JobId: string | undefined;
467
467
  /**
468
- * @public
469
468
  * <p>The organization ID.</p>
469
+ * @public
470
470
  */
471
471
  OrganizationId: string | undefined;
472
472
  }
@@ -480,18 +480,18 @@ export interface CancelMailboxExportJobResponse {
480
480
  */
481
481
  export interface CreateAliasRequest {
482
482
  /**
483
- * @public
484
483
  * <p>The organization under which the member (user or group) exists.</p>
484
+ * @public
485
485
  */
486
486
  OrganizationId: string | undefined;
487
487
  /**
488
- * @public
489
488
  * <p>The member (user or group) to which this alias is added.</p>
489
+ * @public
490
490
  */
491
491
  EntityId: string | undefined;
492
492
  /**
493
- * @public
494
493
  * <p>The alias to add to the member set.</p>
494
+ * @public
495
495
  */
496
496
  Alias: string | undefined;
497
497
  }
@@ -501,9 +501,9 @@ export interface CreateAliasRequest {
501
501
  export interface CreateAliasResponse {
502
502
  }
503
503
  /**
504
- * @public
505
504
  * <p>The email address that you're trying to assign is already created for a different
506
505
  * user, group, or resource.</p>
506
+ * @public
507
507
  */
508
508
  export declare class EmailAddressInUseException extends __BaseException {
509
509
  readonly name: "EmailAddressInUseException";
@@ -515,8 +515,8 @@ export declare class EmailAddressInUseException extends __BaseException {
515
515
  constructor(opts: __ExceptionOptionType<EmailAddressInUseException, __BaseException>);
516
516
  }
517
517
  /**
518
- * @public
519
518
  * <p>The request exceeds the limit of the resource.</p>
519
+ * @public
520
520
  */
521
521
  export declare class LimitExceededException extends __BaseException {
522
522
  readonly name: "LimitExceededException";
@@ -528,8 +528,8 @@ export declare class LimitExceededException extends __BaseException {
528
528
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
529
529
  }
530
530
  /**
531
- * @public
532
531
  * <p>The domain specified is not found in your organization.</p>
532
+ * @public
533
533
  */
534
534
  export declare class MailDomainNotFoundException extends __BaseException {
535
535
  readonly name: "MailDomainNotFoundException";
@@ -541,9 +541,9 @@ export declare class MailDomainNotFoundException extends __BaseException {
541
541
  constructor(opts: __ExceptionOptionType<MailDomainNotFoundException, __BaseException>);
542
542
  }
543
543
  /**
544
- * @public
545
544
  * <p>After a domain has been added to the organization, it must be verified. The domain is
546
545
  * not yet verified.</p>
546
+ * @public
547
547
  */
548
548
  export declare class MailDomainStateException extends __BaseException {
549
549
  readonly name: "MailDomainStateException";
@@ -555,23 +555,23 @@ export declare class MailDomainStateException extends __BaseException {
555
555
  constructor(opts: __ExceptionOptionType<MailDomainStateException, __BaseException>);
556
556
  }
557
557
  /**
558
- * @public
559
558
  * <p>Describes an EWS based availability provider. This is only used as input to the service.</p>
559
+ * @public
560
560
  */
561
561
  export interface EwsAvailabilityProvider {
562
562
  /**
563
- * @public
564
563
  * <p>The endpoint of the remote EWS server.</p>
564
+ * @public
565
565
  */
566
566
  EwsEndpoint: string | undefined;
567
567
  /**
568
- * @public
569
568
  * <p>The username used to authenticate the remote EWS server.</p>
569
+ * @public
570
570
  */
571
571
  EwsUsername: string | undefined;
572
572
  /**
573
- * @public
574
573
  * <p>The password used to authenticate the remote EWS server.</p>
574
+ * @public
575
575
  */
576
576
  EwsPassword: string | undefined;
577
577
  }
@@ -580,28 +580,28 @@ export interface EwsAvailabilityProvider {
580
580
  */
581
581
  export interface CreateAvailabilityConfigurationRequest {
582
582
  /**
583
- * @public
584
583
  * <p>An idempotent token that ensures that an API request is executed only once.</p>
584
+ * @public
585
585
  */
586
586
  ClientToken?: string;
587
587
  /**
588
- * @public
589
588
  * <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be created.</p>
589
+ * @public
590
590
  */
591
591
  OrganizationId: string | undefined;
592
592
  /**
593
- * @public
594
593
  * <p>The domain to which the provider applies.</p>
594
+ * @public
595
595
  */
596
596
  DomainName: string | undefined;
597
597
  /**
598
- * @public
599
598
  * <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>
599
+ * @public
600
600
  */
601
601
  EwsProvider?: EwsAvailabilityProvider;
602
602
  /**
603
- * @public
604
603
  * <p>Lambda availability provider definition. The request must contain exactly one provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>.</p>
604
+ * @public
605
605
  */
606
606
  LambdaProvider?: LambdaAvailabilityProvider;
607
607
  }
@@ -611,8 +611,8 @@ export interface CreateAvailabilityConfigurationRequest {
611
611
  export interface CreateAvailabilityConfigurationResponse {
612
612
  }
613
613
  /**
614
- * @public
615
614
  * <p>The user, group, or resource name isn't unique in WorkMail.</p>
615
+ * @public
616
616
  */
617
617
  export declare class NameAvailabilityException extends __BaseException {
618
618
  readonly name: "NameAvailabilityException";
@@ -628,18 +628,18 @@ export declare class NameAvailabilityException extends __BaseException {
628
628
  */
629
629
  export interface CreateGroupRequest {
630
630
  /**
631
- * @public
632
631
  * <p>The organization under which the group is to be created.</p>
632
+ * @public
633
633
  */
634
634
  OrganizationId: string | undefined;
635
635
  /**
636
- * @public
637
636
  * <p>The name of the group.</p>
637
+ * @public
638
638
  */
639
639
  Name: string | undefined;
640
640
  /**
641
- * @public
642
641
  * <p>If this parameter is enabled, the group will be hidden from the address book.</p>
642
+ * @public
643
643
  */
644
644
  HiddenFromGlobalAddressList?: boolean;
645
645
  }
@@ -648,14 +648,14 @@ export interface CreateGroupRequest {
648
648
  */
649
649
  export interface CreateGroupResponse {
650
650
  /**
651
- * @public
652
651
  * <p>The identifier of the group.</p>
652
+ * @public
653
653
  */
654
654
  GroupId?: string;
655
655
  }
656
656
  /**
657
- * @public
658
657
  * <p>This user, group, or resource name is not allowed in WorkMail.</p>
658
+ * @public
659
659
  */
660
660
  export declare class ReservedNameException extends __BaseException {
661
661
  readonly name: "ReservedNameException";
@@ -667,39 +667,39 @@ export declare class ReservedNameException extends __BaseException {
667
667
  constructor(opts: __ExceptionOptionType<ReservedNameException, __BaseException>);
668
668
  }
669
669
  /**
670
- * @public
671
670
  * <p>The rules for the given impersonation role.</p>
671
+ * @public
672
672
  */
673
673
  export interface ImpersonationRule {
674
674
  /**
675
- * @public
676
675
  * <p>The identifier of the rule.</p>
676
+ * @public
677
677
  */
678
678
  ImpersonationRuleId: string | undefined;
679
679
  /**
680
- * @public
681
680
  * <p>The rule name.</p>
681
+ * @public
682
682
  */
683
683
  Name?: string;
684
684
  /**
685
- * @public
686
685
  * <p>The rule description.</p>
686
+ * @public
687
687
  */
688
688
  Description?: string;
689
689
  /**
690
- * @public
691
690
  * <p>The effect of the rule when it matches the input. Allowed effect values are
692
691
  * <code>ALLOW</code> or <code>DENY</code>.</p>
692
+ * @public
693
693
  */
694
694
  Effect: AccessEffect | undefined;
695
695
  /**
696
- * @public
697
696
  * <p>A list of user IDs that match the rule.</p>
697
+ * @public
698
698
  */
699
699
  TargetUsers?: string[];
700
700
  /**
701
- * @public
702
701
  * <p>A list of user IDs that don't match the rule.</p>
702
+ * @public
703
703
  */
704
704
  NotTargetUsers?: string[];
705
705
  }
@@ -720,34 +720,34 @@ export type ImpersonationRoleType = (typeof ImpersonationRoleType)[keyof typeof
720
720
  */
721
721
  export interface CreateImpersonationRoleRequest {
722
722
  /**
723
- * @public
724
723
  * <p>The idempotency token for the client request.</p>
724
+ * @public
725
725
  */
726
726
  ClientToken?: string;
727
727
  /**
728
- * @public
729
728
  * <p>The WorkMail organization to create the new impersonation role within.</p>
729
+ * @public
730
730
  */
731
731
  OrganizationId: string | undefined;
732
732
  /**
733
- * @public
734
733
  * <p>The name of the new impersonation role.</p>
734
+ * @public
735
735
  */
736
736
  Name: string | undefined;
737
737
  /**
738
- * @public
739
738
  * <p>The impersonation role's type. The available impersonation role types are
740
739
  * <code>READ_ONLY</code> or <code>FULL_ACCESS</code>.</p>
740
+ * @public
741
741
  */
742
742
  Type: ImpersonationRoleType | undefined;
743
743
  /**
744
- * @public
745
744
  * <p>The description of the new impersonation role.</p>
745
+ * @public
746
746
  */
747
747
  Description?: string;
748
748
  /**
749
- * @public
750
749
  * <p>The list of rules for the impersonation role.</p>
750
+ * @public
751
751
  */
752
752
  Rules: ImpersonationRule[] | undefined;
753
753
  }
@@ -756,8 +756,8 @@ export interface CreateImpersonationRoleRequest {
756
756
  */
757
757
  export interface CreateImpersonationRoleResponse {
758
758
  /**
759
- * @public
760
759
  * <p>The new impersonation role ID.</p>
760
+ * @public
761
761
  */
762
762
  ImpersonationRoleId?: string;
763
763
  }
@@ -778,68 +778,68 @@ export type MobileDeviceAccessRuleEffect = (typeof MobileDeviceAccessRuleEffect)
778
778
  */
779
779
  export interface CreateMobileDeviceAccessRuleRequest {
780
780
  /**
781
- * @public
782
781
  * <p>The WorkMail organization under which the rule will be created.</p>
782
+ * @public
783
783
  */
784
784
  OrganizationId: string | undefined;
785
785
  /**
786
- * @public
787
786
  * <p>The idempotency token for the client request.</p>
787
+ * @public
788
788
  */
789
789
  ClientToken?: string;
790
790
  /**
791
- * @public
792
791
  * <p>The rule name.</p>
792
+ * @public
793
793
  */
794
794
  Name: string | undefined;
795
795
  /**
796
- * @public
797
796
  * <p>The rule description.</p>
797
+ * @public
798
798
  */
799
799
  Description?: string;
800
800
  /**
801
- * @public
802
801
  * <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
802
+ * @public
803
803
  */
804
804
  Effect: MobileDeviceAccessRuleEffect | undefined;
805
805
  /**
806
- * @public
807
806
  * <p>Device types that the rule will match.</p>
807
+ * @public
808
808
  */
809
809
  DeviceTypes?: string[];
810
810
  /**
811
- * @public
812
811
  * <p>Device types that the rule <b>will not</b> match. All other device types will match.</p>
812
+ * @public
813
813
  */
814
814
  NotDeviceTypes?: string[];
815
815
  /**
816
- * @public
817
816
  * <p>Device models that the rule will match.</p>
817
+ * @public
818
818
  */
819
819
  DeviceModels?: string[];
820
820
  /**
821
- * @public
822
821
  * <p>Device models that the rule <b>will not</b> match. All other device models will match.</p>
822
+ * @public
823
823
  */
824
824
  NotDeviceModels?: string[];
825
825
  /**
826
- * @public
827
826
  * <p>Device operating systems that the rule will match.</p>
827
+ * @public
828
828
  */
829
829
  DeviceOperatingSystems?: string[];
830
830
  /**
831
- * @public
832
831
  * <p>Device operating systems that the rule <b>will not</b> match. All other device operating systems will match.</p>
832
+ * @public
833
833
  */
834
834
  NotDeviceOperatingSystems?: string[];
835
835
  /**
836
- * @public
837
836
  * <p>Device user agents that the rule will match.</p>
837
+ * @public
838
838
  */
839
839
  DeviceUserAgents?: string[];
840
840
  /**
841
- * @public
842
841
  * <p>Device user agents that the rule <b>will not</b> match. All other device user agents will match.</p>
842
+ * @public
843
843
  */
844
844
  NotDeviceUserAgents?: string[];
845
845
  }
@@ -848,25 +848,25 @@ export interface CreateMobileDeviceAccessRuleRequest {
848
848
  */
849
849
  export interface CreateMobileDeviceAccessRuleResponse {
850
850
  /**
851
- * @public
852
851
  * <p>The identifier for the newly created mobile device access rule.</p>
852
+ * @public
853
853
  */
854
854
  MobileDeviceAccessRuleId?: string;
855
855
  }
856
856
  /**
857
- * @public
858
857
  * <p>The domain to associate with an WorkMail organization.</p>
859
858
  * <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>
859
+ * @public
860
860
  */
861
861
  export interface Domain {
862
862
  /**
863
- * @public
864
863
  * <p>The fully qualified domain name.</p>
864
+ * @public
865
865
  */
866
866
  DomainName: string | undefined;
867
867
  /**
868
- * @public
869
868
  * <p>The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.</p>
869
+ * @public
870
870
  */
871
871
  HostedZoneId?: string;
872
872
  }
@@ -875,35 +875,35 @@ export interface Domain {
875
875
  */
876
876
  export interface CreateOrganizationRequest {
877
877
  /**
878
- * @public
879
878
  * <p>The AWS Directory Service directory ID.</p>
879
+ * @public
880
880
  */
881
881
  DirectoryId?: string;
882
882
  /**
883
- * @public
884
883
  * <p>The organization alias.</p>
884
+ * @public
885
885
  */
886
886
  Alias: string | undefined;
887
887
  /**
888
- * @public
889
888
  * <p>The idempotency token associated with the request.</p>
889
+ * @public
890
890
  */
891
891
  ClientToken?: string;
892
892
  /**
893
- * @public
894
893
  * <p>The email domains to associate with the organization.</p>
894
+ * @public
895
895
  */
896
896
  Domains?: Domain[];
897
897
  /**
898
- * @public
899
898
  * <p>The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.</p>
899
+ * @public
900
900
  */
901
901
  KmsKeyArn?: string;
902
902
  /**
903
- * @public
904
903
  * <p>When <code>true</code>, allows organization interoperability between WorkMail and
905
904
  * Microsoft Exchange. If <code>true</code>, you must include a AD Connector directory ID in
906
905
  * the request.</p>
906
+ * @public
907
907
  */
908
908
  EnableInteroperability?: boolean;
909
909
  }
@@ -912,14 +912,14 @@ export interface CreateOrganizationRequest {
912
912
  */
913
913
  export interface CreateOrganizationResponse {
914
914
  /**
915
- * @public
916
915
  * <p>The organization ID.</p>
916
+ * @public
917
917
  */
918
918
  OrganizationId?: string;
919
919
  }
920
920
  /**
921
- * @public
922
921
  * <p>The directory is already in use by another WorkMail organization in the same account and Region.</p>
922
+ * @public
923
923
  */
924
924
  export declare class DirectoryInUseException extends __BaseException {
925
925
  readonly name: "DirectoryInUseException";
@@ -947,30 +947,30 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
947
947
  */
948
948
  export interface CreateResourceRequest {
949
949
  /**
950
- * @public
951
950
  * <p>The identifier associated with the organization for which the resource is
952
951
  * created.</p>
952
+ * @public
953
953
  */
954
954
  OrganizationId: string | undefined;
955
955
  /**
956
- * @public
957
956
  * <p>The name of the new resource.</p>
957
+ * @public
958
958
  */
959
959
  Name: string | undefined;
960
960
  /**
961
- * @public
962
961
  * <p>The type of the new resource. The available types are <code>equipment</code> and
963
962
  * <code>room</code>.</p>
963
+ * @public
964
964
  */
965
965
  Type: ResourceType | undefined;
966
966
  /**
967
- * @public
968
967
  * <p>Resource description.</p>
968
+ * @public
969
969
  */
970
970
  Description?: string;
971
971
  /**
972
- * @public
973
972
  * <p>If this parameter is enabled, the resource will be hidden from the address book.</p>
973
+ * @public
974
974
  */
975
975
  HiddenFromGlobalAddressList?: boolean;
976
976
  }
@@ -979,8 +979,8 @@ export interface CreateResourceRequest {
979
979
  */
980
980
  export interface CreateResourceResponse {
981
981
  /**
982
- * @public
983
982
  * <p>The identifier of the new resource.</p>
983
+ * @public
984
984
  */
985
985
  ResourceId?: string;
986
986
  }
@@ -1003,44 +1003,44 @@ export type UserRole = (typeof UserRole)[keyof typeof UserRole];
1003
1003
  */
1004
1004
  export interface CreateUserRequest {
1005
1005
  /**
1006
- * @public
1007
1006
  * <p>The identifier of the organization for which the user is created.</p>
1007
+ * @public
1008
1008
  */
1009
1009
  OrganizationId: string | undefined;
1010
1010
  /**
1011
- * @public
1012
1011
  * <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>
1012
+ * @public
1013
1013
  */
1014
1014
  Name: string | undefined;
1015
1015
  /**
1016
- * @public
1017
1016
  * <p>The display name for the new user.</p>
1017
+ * @public
1018
1018
  */
1019
1019
  DisplayName: string | undefined;
1020
1020
  /**
1021
- * @public
1022
1021
  * <p>The password for the new user.</p>
1022
+ * @public
1023
1023
  */
1024
1024
  Password?: string;
1025
1025
  /**
1026
- * @public
1027
1026
  * <p>The role of the new user.</p>
1028
1027
  * <p>You cannot pass <i>SYSTEM_USER</i> or <i>RESOURCE</i> role in a single request. When a user role is not selected, the default role of <i>USER</i> is selected.</p>
1028
+ * @public
1029
1029
  */
1030
1030
  Role?: UserRole;
1031
1031
  /**
1032
- * @public
1033
1032
  * <p>The first name of the new user.</p>
1033
+ * @public
1034
1034
  */
1035
1035
  FirstName?: string;
1036
1036
  /**
1037
- * @public
1038
1037
  * <p>The last name of the new user. </p>
1038
+ * @public
1039
1039
  */
1040
1040
  LastName?: string;
1041
1041
  /**
1042
- * @public
1043
1042
  * <p>If this parameter is enabled, the user will be hidden from the address book.</p>
1043
+ * @public
1044
1044
  */
1045
1045
  HiddenFromGlobalAddressList?: boolean;
1046
1046
  }
@@ -1049,15 +1049,15 @@ export interface CreateUserRequest {
1049
1049
  */
1050
1050
  export interface CreateUserResponse {
1051
1051
  /**
1052
- * @public
1053
1052
  * <p>The identifier for the new user.</p>
1053
+ * @public
1054
1054
  */
1055
1055
  UserId?: string;
1056
1056
  }
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>The supplied password doesn't match the minimum security constraints, such as length
1060
1059
  * or use of special characters.</p>
1060
+ * @public
1061
1061
  */
1062
1062
  export declare class InvalidPasswordException extends __BaseException {
1063
1063
  readonly name: "InvalidPasswordException";
@@ -1081,19 +1081,19 @@ export declare const MemberType: {
1081
1081
  */
1082
1082
  export type MemberType = (typeof MemberType)[keyof typeof MemberType];
1083
1083
  /**
1084
- * @public
1085
1084
  * <p>The name of the attribute, which is one of the values defined in the UserAttribute
1086
1085
  * enumeration.</p>
1086
+ * @public
1087
1087
  */
1088
1088
  export interface Delegate {
1089
1089
  /**
1090
- * @public
1091
1090
  * <p>The identifier for the user or group associated as the resource's delegate.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  Id: string | undefined;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>The type of the delegate: user or group.</p>
1096
+ * @public
1097
1097
  */
1098
1098
  Type: MemberType | undefined;
1099
1099
  }
@@ -1102,13 +1102,13 @@ export interface Delegate {
1102
1102
  */
1103
1103
  export interface DeleteAccessControlRuleRequest {
1104
1104
  /**
1105
- * @public
1106
1105
  * <p>The identifier for the organization.</p>
1106
+ * @public
1107
1107
  */
1108
1108
  OrganizationId: string | undefined;
1109
1109
  /**
1110
- * @public
1111
1110
  * <p>The name of the access control rule.</p>
1111
+ * @public
1112
1112
  */
1113
1113
  Name: string | undefined;
1114
1114
  }
@@ -1122,20 +1122,20 @@ export interface DeleteAccessControlRuleResponse {
1122
1122
  */
1123
1123
  export interface DeleteAliasRequest {
1124
1124
  /**
1125
- * @public
1126
1125
  * <p>The identifier for the organization under which the user exists.</p>
1126
+ * @public
1127
1127
  */
1128
1128
  OrganizationId: string | undefined;
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>The identifier for the member (user or group) from which to have the aliases
1132
1131
  * removed.</p>
1132
+ * @public
1133
1133
  */
1134
1134
  EntityId: string | undefined;
1135
1135
  /**
1136
- * @public
1137
1136
  * <p>The aliases to be removed from the user's set of aliases. Duplicate entries in the
1138
1137
  * list are collapsed into single entries (the list is transformed into a set).</p>
1138
+ * @public
1139
1139
  */
1140
1140
  Alias: string | undefined;
1141
1141
  }
@@ -1149,13 +1149,13 @@ export interface DeleteAliasResponse {
1149
1149
  */
1150
1150
  export interface DeleteAvailabilityConfigurationRequest {
1151
1151
  /**
1152
- * @public
1153
1152
  * <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be deleted.</p>
1153
+ * @public
1154
1154
  */
1155
1155
  OrganizationId: string | undefined;
1156
1156
  /**
1157
- * @public
1158
1157
  * <p>The domain for which the <code>AvailabilityConfiguration</code> will be deleted.</p>
1158
+ * @public
1159
1159
  */
1160
1160
  DomainName: string | undefined;
1161
1161
  }
@@ -1169,8 +1169,8 @@ export interface DeleteAvailabilityConfigurationResponse {
1169
1169
  */
1170
1170
  export interface DeleteEmailMonitoringConfigurationRequest {
1171
1171
  /**
1172
- * @public
1173
1172
  * <p>The ID of the organization from which the email monitoring configuration is deleted.</p>
1173
+ * @public
1174
1174
  */
1175
1175
  OrganizationId: string | undefined;
1176
1176
  }
@@ -1184,12 +1184,11 @@ export interface DeleteEmailMonitoringConfigurationResponse {
1184
1184
  */
1185
1185
  export interface DeleteGroupRequest {
1186
1186
  /**
1187
- * @public
1188
1187
  * <p>The organization that contains the group.</p>
1188
+ * @public
1189
1189
  */
1190
1190
  OrganizationId: string | undefined;
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The identifier of the group to be deleted.</p>
1194
1193
  * <p>The identifier can be the <i>GroupId</i>, or <i>Groupname</i>. The following identity formats are available:</p>
1195
1194
  * <ul>
@@ -1200,6 +1199,7 @@ export interface DeleteGroupRequest {
1200
1199
  * <p>Group name: group</p>
1201
1200
  * </li>
1202
1201
  * </ul>
1202
+ * @public
1203
1203
  */
1204
1204
  GroupId: string | undefined;
1205
1205
  }
@@ -1213,13 +1213,13 @@ export interface DeleteGroupResponse {
1213
1213
  */
1214
1214
  export interface DeleteImpersonationRoleRequest {
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>The WorkMail organization from which to delete the impersonation role.</p>
1217
+ * @public
1218
1218
  */
1219
1219
  OrganizationId: string | undefined;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The ID of the impersonation role to delete.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  ImpersonationRoleId: string | undefined;
1225
1225
  }
@@ -1233,13 +1233,12 @@ export interface DeleteImpersonationRoleResponse {
1233
1233
  */
1234
1234
  export interface DeleteMailboxPermissionsRequest {
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>The identifier of the organization under which the member (user or group)
1238
1237
  * exists.</p>
1238
+ * @public
1239
1239
  */
1240
1240
  OrganizationId: string | undefined;
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The identifier of the entity that owns the mailbox.</p>
1244
1243
  * <p>The identifier can be <i>UserId or Group Id</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
1245
1244
  * <ul>
@@ -1253,10 +1252,10 @@ export interface DeleteMailboxPermissionsRequest {
1253
1252
  * <p>Entity name: entity</p>
1254
1253
  * </li>
1255
1254
  * </ul>
1255
+ * @public
1256
1256
  */
1257
1257
  EntityId: string | undefined;
1258
1258
  /**
1259
- * @public
1260
1259
  * <p>The identifier of the entity for which to delete granted permissions.</p>
1261
1260
  * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
1262
1261
  * <ul>
@@ -1270,6 +1269,7 @@ export interface DeleteMailboxPermissionsRequest {
1270
1269
  * <p>Grantee name: grantee</p>
1271
1270
  * </li>
1272
1271
  * </ul>
1272
+ * @public
1273
1273
  */
1274
1274
  GranteeId: string | undefined;
1275
1275
  }
@@ -1283,12 +1283,11 @@ export interface DeleteMailboxPermissionsResponse {
1283
1283
  */
1284
1284
  export interface DeleteMobileDeviceAccessOverrideRequest {
1285
1285
  /**
1286
- * @public
1287
1286
  * <p>The WorkMail organization for which the access override will be deleted.</p>
1287
+ * @public
1288
1288
  */
1289
1289
  OrganizationId: string | undefined;
1290
1290
  /**
1291
- * @public
1292
1291
  * <p>The WorkMail user for which you want to delete the override. Accepts the following types of user identities:</p>
1293
1292
  * <ul>
1294
1293
  * <li>
@@ -1304,11 +1303,12 @@ export interface DeleteMobileDeviceAccessOverrideRequest {
1304
1303
  * </p>
1305
1304
  * </li>
1306
1305
  * </ul>
1306
+ * @public
1307
1307
  */
1308
1308
  UserId: string | undefined;
1309
1309
  /**
1310
- * @public
1311
1310
  * <p>The mobile device for which you delete the override. <code>DeviceId</code> is case insensitive.</p>
1311
+ * @public
1312
1312
  */
1313
1313
  DeviceId: string | undefined;
1314
1314
  }
@@ -1322,13 +1322,13 @@ export interface DeleteMobileDeviceAccessOverrideResponse {
1322
1322
  */
1323
1323
  export interface DeleteMobileDeviceAccessRuleRequest {
1324
1324
  /**
1325
- * @public
1326
1325
  * <p>The WorkMail organization under which the rule will be deleted.</p>
1326
+ * @public
1327
1327
  */
1328
1328
  OrganizationId: string | undefined;
1329
1329
  /**
1330
- * @public
1331
1330
  * <p>The identifier of the rule to be deleted.</p>
1331
+ * @public
1332
1332
  */
1333
1333
  MobileDeviceAccessRuleId: string | undefined;
1334
1334
  }
@@ -1342,23 +1342,23 @@ export interface DeleteMobileDeviceAccessRuleResponse {
1342
1342
  */
1343
1343
  export interface DeleteOrganizationRequest {
1344
1344
  /**
1345
- * @public
1346
1345
  * <p>The idempotency token associated with the request.</p>
1346
+ * @public
1347
1347
  */
1348
1348
  ClientToken?: string;
1349
1349
  /**
1350
- * @public
1351
1350
  * <p>The organization ID.</p>
1351
+ * @public
1352
1352
  */
1353
1353
  OrganizationId: string | undefined;
1354
1354
  /**
1355
- * @public
1356
1355
  * <p>If true, deletes the AWS Directory Service directory associated with the organization.</p>
1356
+ * @public
1357
1357
  */
1358
1358
  DeleteDirectory: boolean | undefined;
1359
1359
  /**
1360
- * @public
1361
1360
  * <p>Deletes a WorkMail organization even if the organization has enabled users.</p>
1361
+ * @public
1362
1362
  */
1363
1363
  ForceDelete?: boolean;
1364
1364
  }
@@ -1367,13 +1367,13 @@ export interface DeleteOrganizationRequest {
1367
1367
  */
1368
1368
  export interface DeleteOrganizationResponse {
1369
1369
  /**
1370
- * @public
1371
1370
  * <p>The organization ID.</p>
1371
+ * @public
1372
1372
  */
1373
1373
  OrganizationId?: string;
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>The state of the organization.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  State?: string;
1379
1379
  }
@@ -1382,13 +1382,12 @@ export interface DeleteOrganizationResponse {
1382
1382
  */
1383
1383
  export interface DeleteResourceRequest {
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>The identifier associated with the organization from which the resource is
1387
1386
  * deleted.</p>
1387
+ * @public
1388
1388
  */
1389
1389
  OrganizationId: string | undefined;
1390
1390
  /**
1391
- * @public
1392
1391
  * <p>The identifier of the resource to be deleted.</p>
1393
1392
  * <p>The identifier can accept <i>ResourceId</i>, or <i>Resourcename</i>. The following identity formats are available:</p>
1394
1393
  * <ul>
@@ -1399,6 +1398,7 @@ export interface DeleteResourceRequest {
1399
1398
  * <p>Resource name: resource</p>
1400
1399
  * </li>
1401
1400
  * </ul>
1401
+ * @public
1402
1402
  */
1403
1403
  ResourceId: string | undefined;
1404
1404
  }
@@ -1412,13 +1412,13 @@ export interface DeleteResourceResponse {
1412
1412
  */
1413
1413
  export interface DeleteRetentionPolicyRequest {
1414
1414
  /**
1415
- * @public
1416
1415
  * <p>The organization ID.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  OrganizationId: string | undefined;
1419
1419
  /**
1420
- * @public
1421
1420
  * <p>The retention policy ID.</p>
1421
+ * @public
1422
1422
  */
1423
1423
  Id: string | undefined;
1424
1424
  }
@@ -1432,12 +1432,11 @@ export interface DeleteRetentionPolicyResponse {
1432
1432
  */
1433
1433
  export interface DeleteUserRequest {
1434
1434
  /**
1435
- * @public
1436
1435
  * <p>The organization that contains the user to be deleted.</p>
1436
+ * @public
1437
1437
  */
1438
1438
  OrganizationId: string | undefined;
1439
1439
  /**
1440
- * @public
1441
1440
  * <p>The identifier of the user to be deleted.</p>
1442
1441
  * <p>The identifier can be the <i>UserId</i> or <i>Username</i>. The following identity formats are available:</p>
1443
1442
  * <ul>
@@ -1448,6 +1447,7 @@ export interface DeleteUserRequest {
1448
1447
  * <p>User name: user</p>
1449
1448
  * </li>
1450
1449
  * </ul>
1450
+ * @public
1451
1451
  */
1452
1452
  UserId: string | undefined;
1453
1453
  }
@@ -1461,12 +1461,11 @@ export interface DeleteUserResponse {
1461
1461
  */
1462
1462
  export interface DeregisterFromWorkMailRequest {
1463
1463
  /**
1464
- * @public
1465
1464
  * <p>The identifier for the organization under which the WorkMail entity exists.</p>
1465
+ * @public
1466
1466
  */
1467
1467
  OrganizationId: string | undefined;
1468
1468
  /**
1469
- * @public
1470
1469
  * <p>The identifier for the member to be updated.</p>
1471
1470
  * <p>The identifier can be <i>UserId, ResourceId, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
1472
1471
  * <ul>
@@ -1480,6 +1479,7 @@ export interface DeregisterFromWorkMailRequest {
1480
1479
  * <p>Entity name: entity</p>
1481
1480
  * </li>
1482
1481
  * </ul>
1482
+ * @public
1483
1483
  */
1484
1484
  EntityId: string | undefined;
1485
1485
  }
@@ -1493,13 +1493,13 @@ export interface DeregisterFromWorkMailResponse {
1493
1493
  */
1494
1494
  export interface DeregisterMailDomainRequest {
1495
1495
  /**
1496
- * @public
1497
1496
  * <p>The WorkMail organization for which the domain will be deregistered.</p>
1497
+ * @public
1498
1498
  */
1499
1499
  OrganizationId: string | undefined;
1500
1500
  /**
1501
- * @public
1502
1501
  * <p>The domain to deregister in WorkMail and SES.</p>
1502
+ * @public
1503
1503
  */
1504
1504
  DomainName: string | undefined;
1505
1505
  }
@@ -1509,9 +1509,9 @@ export interface DeregisterMailDomainRequest {
1509
1509
  export interface DeregisterMailDomainResponse {
1510
1510
  }
1511
1511
  /**
1512
- * @public
1513
1512
  * <p>You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to
1514
1513
  * <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html">CreateReceiptRule</a>.</p>
1514
+ * @public
1515
1515
  */
1516
1516
  export declare class InvalidCustomSesConfigurationException extends __BaseException {
1517
1517
  readonly name: "InvalidCustomSesConfigurationException";
@@ -1523,8 +1523,8 @@ export declare class InvalidCustomSesConfigurationException extends __BaseExcept
1523
1523
  constructor(opts: __ExceptionOptionType<InvalidCustomSesConfigurationException, __BaseException>);
1524
1524
  }
1525
1525
  /**
1526
- * @public
1527
1526
  * <p>The domain you're trying to change is in use by another user or organization in your account. See the error message for details.</p>
1527
+ * @public
1528
1528
  */
1529
1529
  export declare class MailDomainInUseException extends __BaseException {
1530
1530
  readonly name: "MailDomainInUseException";
@@ -1540,8 +1540,8 @@ export declare class MailDomainInUseException extends __BaseException {
1540
1540
  */
1541
1541
  export interface DescribeEmailMonitoringConfigurationRequest {
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>The ID of the organization for which the email monitoring configuration is described.</p>
1544
+ * @public
1545
1545
  */
1546
1546
  OrganizationId: string | undefined;
1547
1547
  }
@@ -1550,13 +1550,13 @@ export interface DescribeEmailMonitoringConfigurationRequest {
1550
1550
  */
1551
1551
  export interface DescribeEmailMonitoringConfigurationResponse {
1552
1552
  /**
1553
- * @public
1554
1553
  * <p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>
1554
+ * @public
1555
1555
  */
1556
1556
  RoleArn?: string;
1557
1557
  /**
1558
- * @public
1559
1558
  * <p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>
1559
+ * @public
1560
1560
  */
1561
1561
  LogGroupArn?: string;
1562
1562
  }
@@ -1565,13 +1565,13 @@ export interface DescribeEmailMonitoringConfigurationResponse {
1565
1565
  */
1566
1566
  export interface DescribeEntityRequest {
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>The identifier for the organization under which the entity exists.</p>
1569
+ * @public
1570
1570
  */
1571
1571
  OrganizationId: string | undefined;
1572
1572
  /**
1573
- * @public
1574
1573
  * <p>The email under which the entity exists.</p>
1574
+ * @public
1575
1575
  */
1576
1576
  Email: string | undefined;
1577
1577
  }
@@ -1593,18 +1593,18 @@ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
1593
1593
  */
1594
1594
  export interface DescribeEntityResponse {
1595
1595
  /**
1596
- * @public
1597
1596
  * <p>The entity ID under which the entity exists.</p>
1597
+ * @public
1598
1598
  */
1599
1599
  EntityId?: string;
1600
1600
  /**
1601
- * @public
1602
1601
  * <p>Username, GroupName, or ResourceName based on entity type.</p>
1602
+ * @public
1603
1603
  */
1604
1604
  Name?: string;
1605
1605
  /**
1606
- * @public
1607
1606
  * <p>Entity type.</p>
1607
+ * @public
1608
1608
  */
1609
1609
  Type?: EntityType;
1610
1610
  }
@@ -1613,12 +1613,11 @@ export interface DescribeEntityResponse {
1613
1613
  */
1614
1614
  export interface DescribeGroupRequest {
1615
1615
  /**
1616
- * @public
1617
1616
  * <p>The identifier for the organization under which the group exists.</p>
1617
+ * @public
1618
1618
  */
1619
1619
  OrganizationId: string | undefined;
1620
1620
  /**
1621
- * @public
1622
1621
  * <p>The identifier for the group to be described.</p>
1623
1622
  * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
1624
1623
  * <ul>
@@ -1632,6 +1631,7 @@ export interface DescribeGroupRequest {
1632
1631
  * <p>Group name: group</p>
1633
1632
  * </li>
1634
1633
  * </ul>
1634
+ * @public
1635
1635
  */
1636
1636
  GroupId: string | undefined;
1637
1637
  }
@@ -1653,41 +1653,41 @@ export type EntityState = (typeof EntityState)[keyof typeof EntityState];
1653
1653
  */
1654
1654
  export interface DescribeGroupResponse {
1655
1655
  /**
1656
- * @public
1657
1656
  * <p>The identifier of the described group.</p>
1657
+ * @public
1658
1658
  */
1659
1659
  GroupId?: string;
1660
1660
  /**
1661
- * @public
1662
1661
  * <p>The name of the described group.</p>
1662
+ * @public
1663
1663
  */
1664
1664
  Name?: string;
1665
1665
  /**
1666
- * @public
1667
1666
  * <p>The email of the described group.</p>
1667
+ * @public
1668
1668
  */
1669
1669
  Email?: string;
1670
1670
  /**
1671
- * @public
1672
1671
  * <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or
1673
1672
  * never registered to WorkMail).</p>
1673
+ * @public
1674
1674
  */
1675
1675
  State?: EntityState;
1676
1676
  /**
1677
- * @public
1678
1677
  * <p>The date and time when a user was registered to WorkMail, in UNIX epoch time
1679
1678
  * format.</p>
1679
+ * @public
1680
1680
  */
1681
1681
  EnabledDate?: Date;
1682
1682
  /**
1683
- * @public
1684
1683
  * <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time
1685
1684
  * format.</p>
1685
+ * @public
1686
1686
  */
1687
1687
  DisabledDate?: Date;
1688
1688
  /**
1689
- * @public
1690
1689
  * <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
1690
+ * @public
1691
1691
  */
1692
1692
  HiddenFromGlobalAddressList?: boolean;
1693
1693
  }
@@ -1696,8 +1696,8 @@ export interface DescribeGroupResponse {
1696
1696
  */
1697
1697
  export interface DescribeInboundDmarcSettingsRequest {
1698
1698
  /**
1699
- * @public
1700
1699
  * <p>Lists the ID of the given organization.</p>
1700
+ * @public
1701
1701
  */
1702
1702
  OrganizationId: string | undefined;
1703
1703
  }
@@ -1706,8 +1706,8 @@ export interface DescribeInboundDmarcSettingsRequest {
1706
1706
  */
1707
1707
  export interface DescribeInboundDmarcSettingsResponse {
1708
1708
  /**
1709
- * @public
1710
1709
  * <p>Lists the enforcement setting of the applied policy.</p>
1710
+ * @public
1711
1711
  */
1712
1712
  Enforced?: boolean;
1713
1713
  }
@@ -1716,13 +1716,13 @@ export interface DescribeInboundDmarcSettingsResponse {
1716
1716
  */
1717
1717
  export interface DescribeMailboxExportJobRequest {
1718
1718
  /**
1719
- * @public
1720
1719
  * <p>The mailbox export job ID.</p>
1720
+ * @public
1721
1721
  */
1722
1722
  JobId: string | undefined;
1723
1723
  /**
1724
- * @public
1725
1724
  * <p>The organization ID.</p>
1725
+ * @public
1726
1726
  */
1727
1727
  OrganizationId: string | undefined;
1728
1728
  }
@@ -1745,66 +1745,66 @@ export type MailboxExportJobState = (typeof MailboxExportJobState)[keyof typeof
1745
1745
  */
1746
1746
  export interface DescribeMailboxExportJobResponse {
1747
1747
  /**
1748
- * @public
1749
1748
  * <p>The identifier of the user or resource associated with the mailbox.</p>
1749
+ * @public
1750
1750
  */
1751
1751
  EntityId?: string;
1752
1752
  /**
1753
- * @public
1754
1753
  * <p>The mailbox export job description.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  Description?: string;
1757
1757
  /**
1758
- * @public
1759
1758
  * <p>The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple
1760
1759
  * Storage Service (Amazon S3) bucket.</p>
1760
+ * @public
1761
1761
  */
1762
1762
  RoleArn?: string;
1763
1763
  /**
1764
- * @public
1765
1764
  * <p>The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)
1766
1765
  * key that encrypts the exported mailbox content.</p>
1766
+ * @public
1767
1767
  */
1768
1768
  KmsKeyArn?: string;
1769
1769
  /**
1770
- * @public
1771
1770
  * <p>The name of the S3 bucket.</p>
1771
+ * @public
1772
1772
  */
1773
1773
  S3BucketName?: string;
1774
1774
  /**
1775
- * @public
1776
1775
  * <p>The S3 bucket prefix.</p>
1776
+ * @public
1777
1777
  */
1778
1778
  S3Prefix?: string;
1779
1779
  /**
1780
- * @public
1781
1780
  * <p>The path to the S3 bucket and file that the mailbox export job is exporting
1782
1781
  * to.</p>
1782
+ * @public
1783
1783
  */
1784
1784
  S3Path?: string;
1785
1785
  /**
1786
- * @public
1787
1786
  * <p>The estimated progress of the mailbox export job, in percentage points.</p>
1787
+ * @public
1788
1788
  */
1789
1789
  EstimatedProgress?: number;
1790
1790
  /**
1791
- * @public
1792
1791
  * <p>The state of the mailbox export job.</p>
1792
+ * @public
1793
1793
  */
1794
1794
  State?: MailboxExportJobState;
1795
1795
  /**
1796
- * @public
1797
1796
  * <p>Error information for failed mailbox export jobs.</p>
1797
+ * @public
1798
1798
  */
1799
1799
  ErrorInfo?: string;
1800
1800
  /**
1801
- * @public
1802
1801
  * <p>The mailbox export job start timestamp.</p>
1802
+ * @public
1803
1803
  */
1804
1804
  StartTime?: Date;
1805
1805
  /**
1806
- * @public
1807
1806
  * <p>The mailbox export job end timestamp.</p>
1807
+ * @public
1808
1808
  */
1809
1809
  EndTime?: Date;
1810
1810
  }
@@ -1813,8 +1813,8 @@ export interface DescribeMailboxExportJobResponse {
1813
1813
  */
1814
1814
  export interface DescribeOrganizationRequest {
1815
1815
  /**
1816
- * @public
1817
1816
  * <p>The identifier for the organization to be described.</p>
1817
+ * @public
1818
1818
  */
1819
1819
  OrganizationId: string | undefined;
1820
1820
  }
@@ -1823,60 +1823,60 @@ export interface DescribeOrganizationRequest {
1823
1823
  */
1824
1824
  export interface DescribeOrganizationResponse {
1825
1825
  /**
1826
- * @public
1827
1826
  * <p>The identifier of an organization.</p>
1827
+ * @public
1828
1828
  */
1829
1829
  OrganizationId?: string;
1830
1830
  /**
1831
- * @public
1832
1831
  * <p>The alias for an organization.</p>
1832
+ * @public
1833
1833
  */
1834
1834
  Alias?: string;
1835
1835
  /**
1836
- * @public
1837
1836
  * <p>The state of an organization.</p>
1837
+ * @public
1838
1838
  */
1839
1839
  State?: string;
1840
1840
  /**
1841
- * @public
1842
1841
  * <p>The identifier for the directory associated with an WorkMail organization.</p>
1842
+ * @public
1843
1843
  */
1844
1844
  DirectoryId?: string;
1845
1845
  /**
1846
- * @public
1847
1846
  * <p>The type of directory associated with the WorkMail organization.</p>
1847
+ * @public
1848
1848
  */
1849
1849
  DirectoryType?: string;
1850
1850
  /**
1851
- * @public
1852
1851
  * <p>The default mail domain associated with the organization.</p>
1852
+ * @public
1853
1853
  */
1854
1854
  DefaultMailDomain?: string;
1855
1855
  /**
1856
- * @public
1857
1856
  * <p>The date at which the organization became usable in the WorkMail context, in UNIX epoch
1858
1857
  * time format.</p>
1858
+ * @public
1859
1859
  */
1860
1860
  CompletedDate?: Date;
1861
1861
  /**
1862
- * @public
1863
1862
  * <p>(Optional) The error message indicating if unexpected behavior was encountered with
1864
1863
  * regards to the organization.</p>
1864
+ * @public
1865
1865
  */
1866
1866
  ErrorMessage?: string;
1867
1867
  /**
1868
- * @public
1869
1868
  * <p>The Amazon Resource Name (ARN) of the organization.</p>
1869
+ * @public
1870
1870
  */
1871
1871
  ARN?: string;
1872
1872
  /**
1873
- * @public
1874
1873
  * <p>The user ID of the migration admin if migration is enabled for the organization.</p>
1874
+ * @public
1875
1875
  */
1876
1876
  MigrationAdmin?: string;
1877
1877
  /**
1878
- * @public
1879
1878
  * <p>Indicates if interoperability is enabled for this organization.</p>
1879
+ * @public
1880
1880
  */
1881
1881
  InteroperabilityEnabled?: boolean;
1882
1882
  }
@@ -1885,13 +1885,12 @@ export interface DescribeOrganizationResponse {
1885
1885
  */
1886
1886
  export interface DescribeResourceRequest {
1887
1887
  /**
1888
- * @public
1889
1888
  * <p>The identifier associated with the organization for which the resource is
1890
1889
  * described.</p>
1890
+ * @public
1891
1891
  */
1892
1892
  OrganizationId: string | undefined;
1893
1893
  /**
1894
- * @public
1895
1894
  * <p>The identifier of the resource to be described.</p>
1896
1895
  * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
1897
1896
  * <ul>
@@ -1905,6 +1904,7 @@ export interface DescribeResourceRequest {
1905
1904
  * <p>Resource name: resource</p>
1906
1905
  * </li>
1907
1906
  * </ul>
1907
+ * @public
1908
1908
  */
1909
1909
  ResourceId: string | undefined;
1910
1910
  }
@@ -1913,56 +1913,56 @@ export interface DescribeResourceRequest {
1913
1913
  */
1914
1914
  export interface DescribeResourceResponse {
1915
1915
  /**
1916
- * @public
1917
1916
  * <p>The identifier of the described resource.</p>
1917
+ * @public
1918
1918
  */
1919
1919
  ResourceId?: string;
1920
1920
  /**
1921
- * @public
1922
1921
  * <p>The email of the described resource.</p>
1922
+ * @public
1923
1923
  */
1924
1924
  Email?: string;
1925
1925
  /**
1926
- * @public
1927
1926
  * <p>The name of the described resource.</p>
1927
+ * @public
1928
1928
  */
1929
1929
  Name?: string;
1930
1930
  /**
1931
- * @public
1932
1931
  * <p>The type of the described resource.</p>
1932
+ * @public
1933
1933
  */
1934
1934
  Type?: ResourceType;
1935
1935
  /**
1936
- * @public
1937
1936
  * <p>The booking options for the described resource.</p>
1937
+ * @public
1938
1938
  */
1939
1939
  BookingOptions?: BookingOptions;
1940
1940
  /**
1941
- * @public
1942
1941
  * <p>The state of the resource: enabled (registered to WorkMail), disabled (deregistered
1943
1942
  * or never registered to WorkMail), or deleted.</p>
1943
+ * @public
1944
1944
  */
1945
1945
  State?: EntityState;
1946
1946
  /**
1947
- * @public
1948
1947
  * <p>The date and time when a resource was enabled for WorkMail, in UNIX epoch time
1949
1948
  * format.</p>
1949
+ * @public
1950
1950
  */
1951
1951
  EnabledDate?: Date;
1952
1952
  /**
1953
- * @public
1954
1953
  * <p>The date and time when a resource was disabled from WorkMail, in UNIX epoch time
1955
1954
  * format.</p>
1955
+ * @public
1956
1956
  */
1957
1957
  DisabledDate?: Date;
1958
1958
  /**
1959
- * @public
1960
1959
  * <p>Description of the resource.</p>
1960
+ * @public
1961
1961
  */
1962
1962
  Description?: string;
1963
1963
  /**
1964
- * @public
1965
1964
  * <p>If enabled, the resource is hidden from the global address list.</p>
1965
+ * @public
1966
1966
  */
1967
1967
  HiddenFromGlobalAddressList?: boolean;
1968
1968
  }
@@ -1971,12 +1971,11 @@ export interface DescribeResourceResponse {
1971
1971
  */
1972
1972
  export interface DescribeUserRequest {
1973
1973
  /**
1974
- * @public
1975
1974
  * <p>The identifier for the organization under which the user exists.</p>
1975
+ * @public
1976
1976
  */
1977
1977
  OrganizationId: string | undefined;
1978
1978
  /**
1979
- * @public
1980
1979
  * <p>The identifier for the user to be described.</p>
1981
1980
  * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
1982
1981
  * <ul>
@@ -1991,6 +1990,7 @@ export interface DescribeUserRequest {
1991
1990
  * </li>
1992
1991
  * </ul>
1993
1992
  * <p></p>
1993
+ * @public
1994
1994
  */
1995
1995
  UserId: string | undefined;
1996
1996
  }
@@ -1999,125 +1999,125 @@ export interface DescribeUserRequest {
1999
1999
  */
2000
2000
  export interface DescribeUserResponse {
2001
2001
  /**
2002
- * @public
2003
2002
  * <p>The identifier for the described user.</p>
2003
+ * @public
2004
2004
  */
2005
2005
  UserId?: string;
2006
2006
  /**
2007
- * @public
2008
2007
  * <p>The name for the user.</p>
2008
+ * @public
2009
2009
  */
2010
2010
  Name?: string;
2011
2011
  /**
2012
- * @public
2013
2012
  * <p>The email of the user.</p>
2013
+ * @public
2014
2014
  */
2015
2015
  Email?: string;
2016
2016
  /**
2017
- * @public
2018
2017
  * <p>The display name of the user.</p>
2018
+ * @public
2019
2019
  */
2020
2020
  DisplayName?: string;
2021
2021
  /**
2022
- * @public
2023
2022
  * <p>The state of a user: enabled (registered to WorkMail) or disabled (deregistered or
2024
2023
  * never registered to WorkMail).</p>
2024
+ * @public
2025
2025
  */
2026
2026
  State?: EntityState;
2027
2027
  /**
2028
- * @public
2029
2028
  * <p>In certain cases, other entities are modeled as users. If interoperability is
2030
2029
  * enabled, resources are imported into WorkMail as users. Because different WorkMail
2031
2030
  * organizations rely on different directory types, administrators can distinguish between an
2032
2031
  * unregistered user (account is disabled and has a user role) and the directory
2033
2032
  * administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.</p>
2033
+ * @public
2034
2034
  */
2035
2035
  UserRole?: UserRole;
2036
2036
  /**
2037
- * @public
2038
2037
  * <p>The date and time at which the user was enabled for WorkMailusage, in UNIX epoch
2039
2038
  * time format.</p>
2039
+ * @public
2040
2040
  */
2041
2041
  EnabledDate?: Date;
2042
2042
  /**
2043
- * @public
2044
2043
  * <p>The date and time at which the user was disabled for WorkMail usage, in UNIX epoch
2045
2044
  * time format.</p>
2045
+ * @public
2046
2046
  */
2047
2047
  DisabledDate?: Date;
2048
2048
  /**
2049
- * @public
2050
2049
  * <p>The date when the mailbox was created for the user.</p>
2050
+ * @public
2051
2051
  */
2052
2052
  MailboxProvisionedDate?: Date;
2053
2053
  /**
2054
- * @public
2055
2054
  * <p>The date when the mailbox was removed for the user.</p>
2055
+ * @public
2056
2056
  */
2057
2057
  MailboxDeprovisionedDate?: Date;
2058
2058
  /**
2059
- * @public
2060
2059
  * <p>First name of the user.</p>
2060
+ * @public
2061
2061
  */
2062
2062
  FirstName?: string;
2063
2063
  /**
2064
- * @public
2065
2064
  * <p>Last name of the user.</p>
2065
+ * @public
2066
2066
  */
2067
2067
  LastName?: string;
2068
2068
  /**
2069
- * @public
2070
2069
  * <p>If enabled, the user is hidden from the global address list.</p>
2070
+ * @public
2071
2071
  */
2072
2072
  HiddenFromGlobalAddressList?: boolean;
2073
2073
  /**
2074
- * @public
2075
2074
  * <p>Initials of the user.</p>
2075
+ * @public
2076
2076
  */
2077
2077
  Initials?: string;
2078
2078
  /**
2079
- * @public
2080
2079
  * <p>User's contact number.</p>
2080
+ * @public
2081
2081
  */
2082
2082
  Telephone?: string;
2083
2083
  /**
2084
- * @public
2085
2084
  * <p>Street where the user is located.</p>
2085
+ * @public
2086
2086
  */
2087
2087
  Street?: string;
2088
2088
  /**
2089
- * @public
2090
2089
  * <p>Job title of the user.</p>
2090
+ * @public
2091
2091
  */
2092
2092
  JobTitle?: string;
2093
2093
  /**
2094
- * @public
2095
2094
  * <p>City where the user is located.</p>
2095
+ * @public
2096
2096
  */
2097
2097
  City?: string;
2098
2098
  /**
2099
- * @public
2100
2099
  * <p>Company of the user.</p>
2100
+ * @public
2101
2101
  */
2102
2102
  Company?: string;
2103
2103
  /**
2104
- * @public
2105
2104
  * <p>Zip code of the user.</p>
2105
+ * @public
2106
2106
  */
2107
2107
  ZipCode?: string;
2108
2108
  /**
2109
- * @public
2110
2109
  * <p>Department of the user.</p>
2110
+ * @public
2111
2111
  */
2112
2112
  Department?: string;
2113
2113
  /**
2114
- * @public
2115
2114
  * <p>Country where the user is located.</p>
2115
+ * @public
2116
2116
  */
2117
2117
  Country?: string;
2118
2118
  /**
2119
- * @public
2120
2119
  * <p>Office where the user is located.</p>
2120
+ * @public
2121
2121
  */
2122
2122
  Office?: string;
2123
2123
  }
@@ -2126,12 +2126,11 @@ export interface DescribeUserResponse {
2126
2126
  */
2127
2127
  export interface DisassociateDelegateFromResourceRequest {
2128
2128
  /**
2129
- * @public
2130
2129
  * <p>The identifier for the organization under which the resource exists.</p>
2130
+ * @public
2131
2131
  */
2132
2132
  OrganizationId: string | undefined;
2133
2133
  /**
2134
- * @public
2135
2134
  * <p>The identifier of the resource from which delegates' set members are removed.
2136
2135
  * </p>
2137
2136
  * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
@@ -2146,10 +2145,10 @@ export interface DisassociateDelegateFromResourceRequest {
2146
2145
  * <p>Resource name: resource</p>
2147
2146
  * </li>
2148
2147
  * </ul>
2148
+ * @public
2149
2149
  */
2150
2150
  ResourceId: string | undefined;
2151
2151
  /**
2152
- * @public
2153
2152
  * <p>The identifier for the member (user, group) to be removed from the resource's
2154
2153
  * delegates.</p>
2155
2154
  * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
@@ -2164,6 +2163,7 @@ export interface DisassociateDelegateFromResourceRequest {
2164
2163
  * <p>Entity: entity</p>
2165
2164
  * </li>
2166
2165
  * </ul>
2166
+ * @public
2167
2167
  */
2168
2168
  EntityId: string | undefined;
2169
2169
  }
@@ -2177,12 +2177,11 @@ export interface DisassociateDelegateFromResourceResponse {
2177
2177
  */
2178
2178
  export interface DisassociateMemberFromGroupRequest {
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>The identifier for the organization under which the group exists.</p>
2181
+ * @public
2182
2182
  */
2183
2183
  OrganizationId: string | undefined;
2184
2184
  /**
2185
- * @public
2186
2185
  * <p>The identifier for the group from which members are removed.</p>
2187
2186
  * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
2188
2187
  * <ul>
@@ -2196,10 +2195,10 @@ export interface DisassociateMemberFromGroupRequest {
2196
2195
  * <p>Group name: group</p>
2197
2196
  * </li>
2198
2197
  * </ul>
2198
+ * @public
2199
2199
  */
2200
2200
  GroupId: string | undefined;
2201
2201
  /**
2202
- * @public
2203
2202
  * <p>The identifier for the member to be removed from the group.</p>
2204
2203
  * <p>The member ID can accept <i>UserID or GroupId</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
2205
2204
  * <ul>
@@ -2213,6 +2212,7 @@ export interface DisassociateMemberFromGroupRequest {
2213
2212
  * <p>Member name: member</p>
2214
2213
  * </li>
2215
2214
  * </ul>
2215
+ * @public
2216
2216
  */
2217
2217
  MemberId: string | undefined;
2218
2218
  }
@@ -2222,23 +2222,23 @@ export interface DisassociateMemberFromGroupRequest {
2222
2222
  export interface DisassociateMemberFromGroupResponse {
2223
2223
  }
2224
2224
  /**
2225
- * @public
2226
2225
  * <p>A DNS record uploaded to your DNS provider.</p>
2226
+ * @public
2227
2227
  */
2228
2228
  export interface DnsRecord {
2229
2229
  /**
2230
- * @public
2231
2230
  * <p>The RFC 1035 record type. Possible values: <code>CNAME</code>, <code>A</code>, <code>MX</code>.</p>
2231
+ * @public
2232
2232
  */
2233
2233
  Type?: string;
2234
2234
  /**
2235
- * @public
2236
2235
  * <p>The DNS hostname.- For example, <code>domain.example.com</code>.</p>
2236
+ * @public
2237
2237
  */
2238
2238
  Hostname?: string;
2239
2239
  /**
2240
- * @public
2241
2240
  * <p>The value returned by the DNS for a query to that hostname and record type.</p>
2241
+ * @public
2242
2242
  */
2243
2243
  Value?: string;
2244
2244
  }
@@ -2256,9 +2256,9 @@ export declare const DnsRecordVerificationStatus: {
2256
2256
  */
2257
2257
  export type DnsRecordVerificationStatus = (typeof DnsRecordVerificationStatus)[keyof typeof DnsRecordVerificationStatus];
2258
2258
  /**
2259
- * @public
2260
2259
  * <p>The user, group, or resource that you're trying to register is already
2261
2260
  * registered.</p>
2261
+ * @public
2262
2262
  */
2263
2263
  export declare class EntityAlreadyRegisteredException extends __BaseException {
2264
2264
  readonly name: "EntityAlreadyRegisteredException";
@@ -2298,25 +2298,25 @@ export declare const FolderName: {
2298
2298
  */
2299
2299
  export type FolderName = (typeof FolderName)[keyof typeof FolderName];
2300
2300
  /**
2301
- * @public
2302
2301
  * <p>The configuration applied to an organization's folders by its retention
2303
2302
  * policy.</p>
2303
+ * @public
2304
2304
  */
2305
2305
  export interface FolderConfiguration {
2306
2306
  /**
2307
- * @public
2308
2307
  * <p>The folder name.</p>
2308
+ * @public
2309
2309
  */
2310
2310
  Name: FolderName | undefined;
2311
2311
  /**
2312
- * @public
2313
2312
  * <p>The action to take on the folder contents at the end of the folder configuration
2314
2313
  * period.</p>
2314
+ * @public
2315
2315
  */
2316
2316
  Action: RetentionAction | undefined;
2317
2317
  /**
2318
- * @public
2319
2318
  * <p>The number of days for which the folder-configuration action applies.</p>
2319
+ * @public
2320
2320
  */
2321
2321
  Period?: number;
2322
2322
  }
@@ -2325,30 +2325,30 @@ export interface FolderConfiguration {
2325
2325
  */
2326
2326
  export interface GetAccessControlEffectRequest {
2327
2327
  /**
2328
- * @public
2329
2328
  * <p>The identifier for the organization.</p>
2329
+ * @public
2330
2330
  */
2331
2331
  OrganizationId: string | undefined;
2332
2332
  /**
2333
- * @public
2334
2333
  * <p>The IPv4 address.</p>
2334
+ * @public
2335
2335
  */
2336
2336
  IpAddress: string | undefined;
2337
2337
  /**
2338
- * @public
2339
2338
  * <p>The access protocol action. Valid values include <code>ActiveSync</code>,
2340
2339
  * <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>,
2341
2340
  * <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
2341
+ * @public
2342
2342
  */
2343
2343
  Action: string | undefined;
2344
2344
  /**
2345
- * @public
2346
2345
  * <p>The user ID.</p>
2346
+ * @public
2347
2347
  */
2348
2348
  UserId?: string;
2349
2349
  /**
2350
- * @public
2351
2350
  * <p>The impersonation role ID.</p>
2351
+ * @public
2352
2352
  */
2353
2353
  ImpersonationRoleId?: string;
2354
2354
  }
@@ -2357,13 +2357,13 @@ export interface GetAccessControlEffectRequest {
2357
2357
  */
2358
2358
  export interface GetAccessControlEffectResponse {
2359
2359
  /**
2360
- * @public
2361
2360
  * <p>The rule effect.</p>
2361
+ * @public
2362
2362
  */
2363
2363
  Effect?: AccessControlRuleEffect;
2364
2364
  /**
2365
- * @public
2366
2365
  * <p>The rules that match the given parameters, resulting in an effect.</p>
2366
+ * @public
2367
2367
  */
2368
2368
  MatchedRules?: string[];
2369
2369
  }
@@ -2372,8 +2372,8 @@ export interface GetAccessControlEffectResponse {
2372
2372
  */
2373
2373
  export interface GetDefaultRetentionPolicyRequest {
2374
2374
  /**
2375
- * @public
2376
2375
  * <p>The organization ID.</p>
2376
+ * @public
2377
2377
  */
2378
2378
  OrganizationId: string | undefined;
2379
2379
  }
@@ -2382,23 +2382,23 @@ export interface GetDefaultRetentionPolicyRequest {
2382
2382
  */
2383
2383
  export interface GetDefaultRetentionPolicyResponse {
2384
2384
  /**
2385
- * @public
2386
2385
  * <p>The retention policy ID.</p>
2386
+ * @public
2387
2387
  */
2388
2388
  Id?: string;
2389
2389
  /**
2390
- * @public
2391
2390
  * <p>The retention policy name.</p>
2391
+ * @public
2392
2392
  */
2393
2393
  Name?: string;
2394
2394
  /**
2395
- * @public
2396
2395
  * <p>The retention policy description.</p>
2396
+ * @public
2397
2397
  */
2398
2398
  Description?: string;
2399
2399
  /**
2400
- * @public
2401
2400
  * <p>The retention policy folder configurations.</p>
2401
+ * @public
2402
2402
  */
2403
2403
  FolderConfigurations?: FolderConfiguration[];
2404
2404
  }
@@ -2407,13 +2407,13 @@ export interface GetDefaultRetentionPolicyResponse {
2407
2407
  */
2408
2408
  export interface GetImpersonationRoleRequest {
2409
2409
  /**
2410
- * @public
2411
2410
  * <p>The WorkMail organization from which to retrieve the impersonation role.</p>
2411
+ * @public
2412
2412
  */
2413
2413
  OrganizationId: string | undefined;
2414
2414
  /**
2415
- * @public
2416
2415
  * <p>The impersonation role ID to retrieve.</p>
2416
+ * @public
2417
2417
  */
2418
2418
  ImpersonationRoleId: string | undefined;
2419
2419
  }
@@ -2422,38 +2422,38 @@ export interface GetImpersonationRoleRequest {
2422
2422
  */
2423
2423
  export interface GetImpersonationRoleResponse {
2424
2424
  /**
2425
- * @public
2426
2425
  * <p>The impersonation role ID.</p>
2426
+ * @public
2427
2427
  */
2428
2428
  ImpersonationRoleId?: string;
2429
2429
  /**
2430
- * @public
2431
2430
  * <p>The impersonation role name.</p>
2431
+ * @public
2432
2432
  */
2433
2433
  Name?: string;
2434
2434
  /**
2435
- * @public
2436
2435
  * <p>The impersonation role type.</p>
2436
+ * @public
2437
2437
  */
2438
2438
  Type?: ImpersonationRoleType;
2439
2439
  /**
2440
- * @public
2441
2440
  * <p>The impersonation role description.</p>
2441
+ * @public
2442
2442
  */
2443
2443
  Description?: string;
2444
2444
  /**
2445
- * @public
2446
2445
  * <p>The list of rules for the given impersonation role.</p>
2446
+ * @public
2447
2447
  */
2448
2448
  Rules?: ImpersonationRule[];
2449
2449
  /**
2450
- * @public
2451
2450
  * <p>The date when the impersonation role was created.</p>
2451
+ * @public
2452
2452
  */
2453
2453
  DateCreated?: Date;
2454
2454
  /**
2455
- * @public
2456
2455
  * <p>The date when the impersonation role was last modified.</p>
2456
+ * @public
2457
2457
  */
2458
2458
  DateModified?: Date;
2459
2459
  }
@@ -2462,17 +2462,16 @@ export interface GetImpersonationRoleResponse {
2462
2462
  */
2463
2463
  export interface GetImpersonationRoleEffectRequest {
2464
2464
  /**
2465
- * @public
2466
2465
  * <p>The WorkMail organization where the impersonation role is defined.</p>
2466
+ * @public
2467
2467
  */
2468
2468
  OrganizationId: string | undefined;
2469
2469
  /**
2470
- * @public
2471
2470
  * <p>The impersonation role ID to test.</p>
2471
+ * @public
2472
2472
  */
2473
2473
  ImpersonationRoleId: string | undefined;
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>The WorkMail organization user chosen to test the impersonation role. The following identity
2477
2476
  * formats are available:</p>
2478
2477
  * <ul>
@@ -2489,22 +2488,23 @@ export interface GetImpersonationRoleEffectRequest {
2489
2488
  * </p>
2490
2489
  * </li>
2491
2490
  * </ul>
2491
+ * @public
2492
2492
  */
2493
2493
  TargetUser: string | undefined;
2494
2494
  }
2495
2495
  /**
2496
- * @public
2497
2496
  * <p>The impersonation rule that matched the input.</p>
2497
+ * @public
2498
2498
  */
2499
2499
  export interface ImpersonationMatchedRule {
2500
2500
  /**
2501
- * @public
2502
2501
  * <p>The ID of the rule that matched the input</p>
2502
+ * @public
2503
2503
  */
2504
2504
  ImpersonationRuleId?: string;
2505
2505
  /**
2506
- * @public
2507
2506
  * <p>The name of the rule that matched the input.</p>
2507
+ * @public
2508
2508
  */
2509
2509
  Name?: string;
2510
2510
  }
@@ -2513,20 +2513,20 @@ export interface ImpersonationMatchedRule {
2513
2513
  */
2514
2514
  export interface GetImpersonationRoleEffectResponse {
2515
2515
  /**
2516
- * @public
2517
2516
  * <p>The impersonation role type.</p>
2517
+ * @public
2518
2518
  */
2519
2519
  Type?: ImpersonationRoleType;
2520
2520
  /**
2521
- * @public
2522
2521
  * <p>
2523
2522
  * <code></code>Effect of the impersonation role on the target user based on its rules. Available
2524
2523
  * effects are <code>ALLOW</code> or <code>DENY</code>.</p>
2524
+ * @public
2525
2525
  */
2526
2526
  Effect?: AccessEffect;
2527
2527
  /**
2528
- * @public
2529
2528
  * <p>A list of the rules that match the input and produce the configured effect.</p>
2529
+ * @public
2530
2530
  */
2531
2531
  MatchedRules?: ImpersonationMatchedRule[];
2532
2532
  }
@@ -2535,13 +2535,12 @@ export interface GetImpersonationRoleEffectResponse {
2535
2535
  */
2536
2536
  export interface GetMailboxDetailsRequest {
2537
2537
  /**
2538
- * @public
2539
2538
  * <p>The identifier for the organization that contains the user whose mailbox details are
2540
2539
  * being requested.</p>
2540
+ * @public
2541
2541
  */
2542
2542
  OrganizationId: string | undefined;
2543
2543
  /**
2544
- * @public
2545
2544
  * <p>The identifier for the user whose mailbox details are being requested.</p>
2546
2545
  * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
2547
2546
  * <ul>
@@ -2555,6 +2554,7 @@ export interface GetMailboxDetailsRequest {
2555
2554
  * <p>User name: user</p>
2556
2555
  * </li>
2557
2556
  * </ul>
2557
+ * @public
2558
2558
  */
2559
2559
  UserId: string | undefined;
2560
2560
  }
@@ -2563,13 +2563,13 @@ export interface GetMailboxDetailsRequest {
2563
2563
  */
2564
2564
  export interface GetMailboxDetailsResponse {
2565
2565
  /**
2566
- * @public
2567
2566
  * <p>The maximum allowed mailbox size, in MB, for the specified user.</p>
2567
+ * @public
2568
2568
  */
2569
2569
  MailboxQuota?: number;
2570
2570
  /**
2571
- * @public
2572
2571
  * <p>The current mailbox size, in MB, for the specified user.</p>
2572
+ * @public
2573
2573
  */
2574
2574
  MailboxSize?: number;
2575
2575
  }
@@ -2578,13 +2578,13 @@ export interface GetMailboxDetailsResponse {
2578
2578
  */
2579
2579
  export interface GetMailDomainRequest {
2580
2580
  /**
2581
- * @public
2582
2581
  * <p>The WorkMail organization for which the domain is retrieved.</p>
2582
+ * @public
2583
2583
  */
2584
2584
  OrganizationId: string | undefined;
2585
2585
  /**
2586
- * @public
2587
2586
  * <p>The domain from which you want to retrieve details.</p>
2587
+ * @public
2588
2588
  */
2589
2589
  DomainName: string | undefined;
2590
2590
  }
@@ -2593,29 +2593,29 @@ export interface GetMailDomainRequest {
2593
2593
  */
2594
2594
  export interface GetMailDomainResponse {
2595
2595
  /**
2596
- * @public
2597
2596
  * <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
2598
2597
  * email traffic to SES. See admin guide for more details.</p>
2598
+ * @public
2599
2599
  */
2600
2600
  Records?: DnsRecord[];
2601
2601
  /**
2602
- * @public
2603
2602
  * <p>Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.</p>
2603
+ * @public
2604
2604
  */
2605
2605
  IsTestDomain?: boolean;
2606
2606
  /**
2607
- * @public
2608
2607
  * <p>Specifies whether the domain is the default domain for your organization.</p>
2608
+ * @public
2609
2609
  */
2610
2610
  IsDefault?: boolean;
2611
2611
  /**
2612
- * @public
2613
2612
  * <p> Indicates the status of the domain ownership verification.</p>
2613
+ * @public
2614
2614
  */
2615
2615
  OwnershipVerificationStatus?: DnsRecordVerificationStatus;
2616
2616
  /**
2617
- * @public
2618
2617
  * <p>Indicates the status of a DKIM verification.</p>
2618
+ * @public
2619
2619
  */
2620
2620
  DkimVerificationStatus?: DnsRecordVerificationStatus;
2621
2621
  }
@@ -2624,44 +2624,44 @@ export interface GetMailDomainResponse {
2624
2624
  */
2625
2625
  export interface GetMobileDeviceAccessEffectRequest {
2626
2626
  /**
2627
- * @public
2628
2627
  * <p>The WorkMail organization to simulate the access effect for.</p>
2628
+ * @public
2629
2629
  */
2630
2630
  OrganizationId: string | undefined;
2631
2631
  /**
2632
- * @public
2633
2632
  * <p>Device type the simulated user will report.</p>
2633
+ * @public
2634
2634
  */
2635
2635
  DeviceType?: string;
2636
2636
  /**
2637
- * @public
2638
2637
  * <p>Device model the simulated user will report.</p>
2638
+ * @public
2639
2639
  */
2640
2640
  DeviceModel?: string;
2641
2641
  /**
2642
- * @public
2643
2642
  * <p>Device operating system the simulated user will report.</p>
2643
+ * @public
2644
2644
  */
2645
2645
  DeviceOperatingSystem?: string;
2646
2646
  /**
2647
- * @public
2648
2647
  * <p>Device user agent the simulated user will report.</p>
2648
+ * @public
2649
2649
  */
2650
2650
  DeviceUserAgent?: string;
2651
2651
  }
2652
2652
  /**
2653
- * @public
2654
2653
  * <p>The rule that a simulated user matches.</p>
2654
+ * @public
2655
2655
  */
2656
2656
  export interface MobileDeviceAccessMatchedRule {
2657
2657
  /**
2658
- * @public
2659
2658
  * <p>Identifier of the rule that a simulated user matches.</p>
2659
+ * @public
2660
2660
  */
2661
2661
  MobileDeviceAccessRuleId?: string;
2662
2662
  /**
2663
- * @public
2664
2663
  * <p>Name of a rule that a simulated user matches.</p>
2664
+ * @public
2665
2665
  */
2666
2666
  Name?: string;
2667
2667
  }
@@ -2670,14 +2670,14 @@ export interface MobileDeviceAccessMatchedRule {
2670
2670
  */
2671
2671
  export interface GetMobileDeviceAccessEffectResponse {
2672
2672
  /**
2673
- * @public
2674
2673
  * <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
2675
2674
  * user parameters.</p>
2675
+ * @public
2676
2676
  */
2677
2677
  Effect?: MobileDeviceAccessRuleEffect;
2678
2678
  /**
2679
- * @public
2680
2679
  * <p>A list of the rules which matched the simulated user input and produced the effect.</p>
2680
+ * @public
2681
2681
  */
2682
2682
  MatchedRules?: MobileDeviceAccessMatchedRule[];
2683
2683
  }
@@ -2686,12 +2686,11 @@ export interface GetMobileDeviceAccessEffectResponse {
2686
2686
  */
2687
2687
  export interface GetMobileDeviceAccessOverrideRequest {
2688
2688
  /**
2689
- * @public
2690
2689
  * <p>The WorkMail organization to which you want to apply the override.</p>
2690
+ * @public
2691
2691
  */
2692
2692
  OrganizationId: string | undefined;
2693
2693
  /**
2694
- * @public
2695
2694
  * <p>Identifies the WorkMail user for the override. Accepts the following types of user identities: </p>
2696
2695
  * <ul>
2697
2696
  * <li>
@@ -2707,11 +2706,12 @@ export interface GetMobileDeviceAccessOverrideRequest {
2707
2706
  * </p>
2708
2707
  * </li>
2709
2708
  * </ul>
2709
+ * @public
2710
2710
  */
2711
2711
  UserId: string | undefined;
2712
2712
  /**
2713
- * @public
2714
2713
  * <p>The mobile device to which the override applies. <code>DeviceId</code> is case insensitive.</p>
2714
+ * @public
2715
2715
  */
2716
2716
  DeviceId: string | undefined;
2717
2717
  }
@@ -2720,124 +2720,124 @@ export interface GetMobileDeviceAccessOverrideRequest {
2720
2720
  */
2721
2721
  export interface GetMobileDeviceAccessOverrideResponse {
2722
2722
  /**
2723
- * @public
2724
2723
  * <p>The WorkMail user to which the access override applies.</p>
2724
+ * @public
2725
2725
  */
2726
2726
  UserId?: string;
2727
2727
  /**
2728
- * @public
2729
2728
  * <p>The device to which the access override applies.</p>
2729
+ * @public
2730
2730
  */
2731
2731
  DeviceId?: string;
2732
2732
  /**
2733
- * @public
2734
2733
  * <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
2734
+ * @public
2735
2735
  */
2736
2736
  Effect?: MobileDeviceAccessRuleEffect;
2737
2737
  /**
2738
- * @public
2739
2738
  * <p>A description of the override.</p>
2739
+ * @public
2740
2740
  */
2741
2741
  Description?: string;
2742
2742
  /**
2743
- * @public
2744
2743
  * <p>The date the override was first created.</p>
2744
+ * @public
2745
2745
  */
2746
2746
  DateCreated?: Date;
2747
2747
  /**
2748
- * @public
2749
2748
  * <p>The date the description was last modified.</p>
2749
+ * @public
2750
2750
  */
2751
2751
  DateModified?: Date;
2752
2752
  }
2753
2753
  /**
2754
- * @public
2755
2754
  * <p>The representation of an WorkMail group.</p>
2755
+ * @public
2756
2756
  */
2757
2757
  export interface Group {
2758
2758
  /**
2759
- * @public
2760
2759
  * <p>The identifier of the group.</p>
2760
+ * @public
2761
2761
  */
2762
2762
  Id?: string;
2763
2763
  /**
2764
- * @public
2765
2764
  * <p>The email of the group.</p>
2765
+ * @public
2766
2766
  */
2767
2767
  Email?: string;
2768
2768
  /**
2769
- * @public
2770
2769
  * <p>The name of the group.</p>
2770
+ * @public
2771
2771
  */
2772
2772
  Name?: string;
2773
2773
  /**
2774
- * @public
2775
2774
  * <p>The state of the group, which can be ENABLED, DISABLED, or DELETED.</p>
2775
+ * @public
2776
2776
  */
2777
2777
  State?: EntityState;
2778
2778
  /**
2779
- * @public
2780
2779
  * <p>The date indicating when the group was enabled for WorkMail use.</p>
2780
+ * @public
2781
2781
  */
2782
2782
  EnabledDate?: Date;
2783
2783
  /**
2784
- * @public
2785
2784
  * <p>The date indicating when the group was disabled from WorkMail use.</p>
2785
+ * @public
2786
2786
  */
2787
2787
  DisabledDate?: Date;
2788
2788
  }
2789
2789
  /**
2790
- * @public
2791
2790
  * <p>The identifier that contains the Group ID and name of a group.</p>
2791
+ * @public
2792
2792
  */
2793
2793
  export interface GroupIdentifier {
2794
2794
  /**
2795
- * @public
2796
2795
  * <p>Group ID that matched the group.</p>
2796
+ * @public
2797
2797
  */
2798
2798
  GroupId?: string;
2799
2799
  /**
2800
- * @public
2801
2800
  * <p>Group name that matched the group.</p>
2801
+ * @public
2802
2802
  */
2803
2803
  GroupName?: string;
2804
2804
  }
2805
2805
  /**
2806
- * @public
2807
2806
  * <p>An impersonation role for the given WorkMail organization.</p>
2807
+ * @public
2808
2808
  */
2809
2809
  export interface ImpersonationRole {
2810
2810
  /**
2811
- * @public
2812
2811
  * <p>The identifier of the impersonation role.</p>
2812
+ * @public
2813
2813
  */
2814
2814
  ImpersonationRoleId?: string;
2815
2815
  /**
2816
- * @public
2817
2816
  * <p>The impersonation role name.</p>
2817
+ * @public
2818
2818
  */
2819
2819
  Name?: string;
2820
2820
  /**
2821
- * @public
2822
2821
  * <p>The impersonation role type.</p>
2822
+ * @public
2823
2823
  */
2824
2824
  Type?: ImpersonationRoleType;
2825
2825
  /**
2826
- * @public
2827
2826
  * <p>The date when the impersonation role was created.</p>
2827
+ * @public
2828
2828
  */
2829
2829
  DateCreated?: Date;
2830
2830
  /**
2831
- * @public
2832
2831
  * <p>The date when the impersonation role was last modified.</p>
2832
+ * @public
2833
2833
  */
2834
2834
  DateModified?: Date;
2835
2835
  }
2836
2836
  /**
2837
- * @public
2838
2837
  * <p>The configuration for a resource isn't valid. A resource must either be able to
2839
2838
  * auto-respond to requests or have at least one delegate associated that can do so on its
2840
2839
  * behalf.</p>
2840
+ * @public
2841
2841
  */
2842
2842
  export declare class InvalidConfigurationException extends __BaseException {
2843
2843
  readonly name: "InvalidConfigurationException";
@@ -2849,54 +2849,54 @@ export declare class InvalidConfigurationException extends __BaseException {
2849
2849
  constructor(opts: __ExceptionOptionType<InvalidConfigurationException, __BaseException>);
2850
2850
  }
2851
2851
  /**
2852
- * @public
2853
2852
  * <p>The details of a mailbox export job, including the user or resource ID associated
2854
2853
  * with the mailbox and the S3 bucket that the mailbox contents are exported to.</p>
2854
+ * @public
2855
2855
  */
2856
2856
  export interface MailboxExportJob {
2857
2857
  /**
2858
- * @public
2859
2858
  * <p>The identifier of the mailbox export job.</p>
2859
+ * @public
2860
2860
  */
2861
2861
  JobId?: string;
2862
2862
  /**
2863
- * @public
2864
2863
  * <p>The identifier of the user or resource associated with the mailbox.</p>
2864
+ * @public
2865
2865
  */
2866
2866
  EntityId?: string;
2867
2867
  /**
2868
- * @public
2869
2868
  * <p>The mailbox export job description.</p>
2869
+ * @public
2870
2870
  */
2871
2871
  Description?: string;
2872
2872
  /**
2873
- * @public
2874
2873
  * <p>The name of the S3 bucket.</p>
2874
+ * @public
2875
2875
  */
2876
2876
  S3BucketName?: string;
2877
2877
  /**
2878
- * @public
2879
2878
  * <p>The path to the S3 bucket and file that the mailbox export job exports to.</p>
2879
+ * @public
2880
2880
  */
2881
2881
  S3Path?: string;
2882
2882
  /**
2883
- * @public
2884
2883
  * <p>The estimated progress of the mailbox export job, in percentage points.</p>
2884
+ * @public
2885
2885
  */
2886
2886
  EstimatedProgress?: number;
2887
2887
  /**
2888
- * @public
2889
2888
  * <p>The state of the mailbox export job.</p>
2889
+ * @public
2890
2890
  */
2891
2891
  State?: MailboxExportJobState;
2892
2892
  /**
2893
- * @public
2894
2893
  * <p>The mailbox export job start timestamp.</p>
2894
+ * @public
2895
2895
  */
2896
2896
  StartTime?: Date;
2897
2897
  /**
2898
- * @public
2899
2898
  * <p>The mailbox export job end timestamp.</p>
2899
+ * @public
2900
2900
  */
2901
2901
  EndTime?: Date;
2902
2902
  }
@@ -2905,8 +2905,8 @@ export interface MailboxExportJob {
2905
2905
  */
2906
2906
  export interface ListAccessControlRulesRequest {
2907
2907
  /**
2908
- * @public
2909
2908
  * <p>The identifier for the organization.</p>
2909
+ * @public
2910
2910
  */
2911
2911
  OrganizationId: string | undefined;
2912
2912
  }
@@ -2915,8 +2915,8 @@ export interface ListAccessControlRulesRequest {
2915
2915
  */
2916
2916
  export interface ListAccessControlRulesResponse {
2917
2917
  /**
2918
- * @public
2919
2918
  * <p>The access control rules.</p>
2919
+ * @public
2920
2920
  */
2921
2921
  Rules?: AccessControlRule[];
2922
2922
  }
@@ -2925,24 +2925,24 @@ export interface ListAccessControlRulesResponse {
2925
2925
  */
2926
2926
  export interface ListAliasesRequest {
2927
2927
  /**
2928
- * @public
2929
2928
  * <p>The identifier for the organization under which the entity exists.</p>
2929
+ * @public
2930
2930
  */
2931
2931
  OrganizationId: string | undefined;
2932
2932
  /**
2933
- * @public
2934
2933
  * <p>The identifier for the entity for which to list the aliases.</p>
2934
+ * @public
2935
2935
  */
2936
2936
  EntityId: string | undefined;
2937
2937
  /**
2938
- * @public
2939
2938
  * <p>The token to use to retrieve the next page of results. The first call does not
2940
2939
  * contain any tokens.</p>
2940
+ * @public
2941
2941
  */
2942
2942
  NextToken?: string;
2943
2943
  /**
2944
- * @public
2945
2944
  * <p>The maximum number of results to return in a single call.</p>
2945
+ * @public
2946
2946
  */
2947
2947
  MaxResults?: number;
2948
2948
  }
@@ -2951,14 +2951,14 @@ export interface ListAliasesRequest {
2951
2951
  */
2952
2952
  export interface ListAliasesResponse {
2953
2953
  /**
2954
- * @public
2955
2954
  * <p>The entity's paginated aliases.</p>
2955
+ * @public
2956
2956
  */
2957
2957
  Aliases?: string[];
2958
2958
  /**
2959
- * @public
2960
2959
  * <p>The token to use to retrieve the next page of results. The value is "null" when there
2961
2960
  * are no more results to return.</p>
2961
+ * @public
2962
2962
  */
2963
2963
  NextToken?: string;
2964
2964
  }
@@ -2967,19 +2967,19 @@ export interface ListAliasesResponse {
2967
2967
  */
2968
2968
  export interface ListAvailabilityConfigurationsRequest {
2969
2969
  /**
2970
- * @public
2971
2970
  * <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code>'s will be
2972
2971
  * listed.</p>
2972
+ * @public
2973
2973
  */
2974
2974
  OrganizationId: string | undefined;
2975
2975
  /**
2976
- * @public
2977
2976
  * <p>The maximum number of results to return in a single call.</p>
2977
+ * @public
2978
2978
  */
2979
2979
  MaxResults?: number;
2980
2980
  /**
2981
- * @public
2982
2981
  * <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
2982
+ * @public
2983
2983
  */
2984
2984
  NextToken?: string;
2985
2985
  }
@@ -2988,13 +2988,13 @@ export interface ListAvailabilityConfigurationsRequest {
2988
2988
  */
2989
2989
  export interface ListAvailabilityConfigurationsResponse {
2990
2990
  /**
2991
- * @public
2992
2991
  * <p>The list of <code>AvailabilityConfiguration</code>'s that exist for the specified WorkMail organization.</p>
2992
+ * @public
2993
2993
  */
2994
2994
  AvailabilityConfigurations?: AvailabilityConfiguration[];
2995
2995
  /**
2996
- * @public
2997
2996
  * <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>
2997
+ * @public
2998
2998
  */
2999
2999
  NextToken?: string;
3000
3000
  }
@@ -3003,12 +3003,11 @@ export interface ListAvailabilityConfigurationsResponse {
3003
3003
  */
3004
3004
  export interface ListGroupMembersRequest {
3005
3005
  /**
3006
- * @public
3007
3006
  * <p>The identifier for the organization under which the group exists.</p>
3007
+ * @public
3008
3008
  */
3009
3009
  OrganizationId: string | undefined;
3010
3010
  /**
3011
- * @public
3012
3011
  * <p>The identifier for the group to which the members (users or groups) are
3013
3012
  * associated.</p>
3014
3013
  * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
@@ -3023,53 +3022,54 @@ export interface ListGroupMembersRequest {
3023
3022
  * <p>Group name: group</p>
3024
3023
  * </li>
3025
3024
  * </ul>
3025
+ * @public
3026
3026
  */
3027
3027
  GroupId: string | undefined;
3028
3028
  /**
3029
- * @public
3030
3029
  * <p> The token to use to retrieve the next page of results. The first call does not
3031
3030
  * contain any tokens.</p>
3031
+ * @public
3032
3032
  */
3033
3033
  NextToken?: string;
3034
3034
  /**
3035
- * @public
3036
3035
  * <p>The maximum number of results to return in a single call.</p>
3036
+ * @public
3037
3037
  */
3038
3038
  MaxResults?: number;
3039
3039
  }
3040
3040
  /**
3041
- * @public
3042
3041
  * <p>The representation of a user or group.</p>
3042
+ * @public
3043
3043
  */
3044
3044
  export interface Member {
3045
3045
  /**
3046
- * @public
3047
3046
  * <p>The identifier of the member.</p>
3047
+ * @public
3048
3048
  */
3049
3049
  Id?: string;
3050
3050
  /**
3051
- * @public
3052
3051
  * <p>The name of the member.</p>
3052
+ * @public
3053
3053
  */
3054
3054
  Name?: string;
3055
3055
  /**
3056
- * @public
3057
3056
  * <p>A member can be a user or group.</p>
3057
+ * @public
3058
3058
  */
3059
3059
  Type?: MemberType;
3060
3060
  /**
3061
- * @public
3062
3061
  * <p>The state of the member, which can be ENABLED, DISABLED, or DELETED.</p>
3062
+ * @public
3063
3063
  */
3064
3064
  State?: EntityState;
3065
3065
  /**
3066
- * @public
3067
3066
  * <p>The date indicating when the member was enabled for WorkMail use.</p>
3067
+ * @public
3068
3068
  */
3069
3069
  EnabledDate?: Date;
3070
3070
  /**
3071
- * @public
3072
3071
  * <p>The date indicating when the member was disabled from WorkMail use.</p>
3072
+ * @public
3073
3073
  */
3074
3074
  DisabledDate?: Date;
3075
3075
  }
@@ -3078,35 +3078,35 @@ export interface Member {
3078
3078
  */
3079
3079
  export interface ListGroupMembersResponse {
3080
3080
  /**
3081
- * @public
3082
3081
  * <p>The members associated to the group.</p>
3082
+ * @public
3083
3083
  */
3084
3084
  Members?: Member[];
3085
3085
  /**
3086
- * @public
3087
3086
  * <p>The token to use to retrieve the next page of results. The first call does not
3088
3087
  * contain any tokens.</p>
3088
+ * @public
3089
3089
  */
3090
3090
  NextToken?: string;
3091
3091
  }
3092
3092
  /**
3093
- * @public
3094
3093
  * <p> Filtering options for <i>ListGroups</i> operation. This is only used as input to Operation.</p>
3094
+ * @public
3095
3095
  */
3096
3096
  export interface ListGroupsFilters {
3097
3097
  /**
3098
- * @public
3099
3098
  * <p>Filters only groups with the provided name prefix.</p>
3099
+ * @public
3100
3100
  */
3101
3101
  NamePrefix?: string;
3102
3102
  /**
3103
- * @public
3104
3103
  * <p>Filters only groups with the provided primary email prefix.</p>
3104
+ * @public
3105
3105
  */
3106
3106
  PrimaryEmailPrefix?: string;
3107
3107
  /**
3108
- * @public
3109
3108
  * <p>Filters only groups with the provided state.</p>
3109
+ * @public
3110
3110
  */
3111
3111
  State?: EntityState;
3112
3112
  }
@@ -3115,24 +3115,24 @@ export interface ListGroupsFilters {
3115
3115
  */
3116
3116
  export interface ListGroupsRequest {
3117
3117
  /**
3118
- * @public
3119
3118
  * <p>The identifier for the organization under which the groups exist.</p>
3119
+ * @public
3120
3120
  */
3121
3121
  OrganizationId: string | undefined;
3122
3122
  /**
3123
- * @public
3124
3123
  * <p>The token to use to retrieve the next page of results. The first call does not
3125
3124
  * contain any tokens.</p>
3125
+ * @public
3126
3126
  */
3127
3127
  NextToken?: string;
3128
3128
  /**
3129
- * @public
3130
3129
  * <p>The maximum number of results to return in a single call.</p>
3130
+ * @public
3131
3131
  */
3132
3132
  MaxResults?: number;
3133
3133
  /**
3134
- * @public
3135
3134
  * <p>Limit the search results based on the filter criteria. Only one filter per request is supported.</p>
3135
+ * @public
3136
3136
  */
3137
3137
  Filters?: ListGroupsFilters;
3138
3138
  }
@@ -3141,25 +3141,25 @@ export interface ListGroupsRequest {
3141
3141
  */
3142
3142
  export interface ListGroupsResponse {
3143
3143
  /**
3144
- * @public
3145
3144
  * <p>The overview of groups for an organization.</p>
3145
+ * @public
3146
3146
  */
3147
3147
  Groups?: Group[];
3148
3148
  /**
3149
- * @public
3150
3149
  * <p>The token to use to retrieve the next page of results. The value is "null" when there
3151
3150
  * are no more results to return.</p>
3151
+ * @public
3152
3152
  */
3153
3153
  NextToken?: string;
3154
3154
  }
3155
3155
  /**
3156
- * @public
3157
3156
  * <p> Filtering options for <i>ListGroupsForEntity</i> operation. This is only used as input to Operation.</p>
3157
+ * @public
3158
3158
  */
3159
3159
  export interface ListGroupsForEntityFilters {
3160
3160
  /**
3161
- * @public
3162
3161
  * <p>Filters only group names that start with the provided name prefix.</p>
3162
+ * @public
3163
3163
  */
3164
3164
  GroupNamePrefix?: string;
3165
3165
  }
@@ -3168,12 +3168,11 @@ export interface ListGroupsForEntityFilters {
3168
3168
  */
3169
3169
  export interface ListGroupsForEntityRequest {
3170
3170
  /**
3171
- * @public
3172
3171
  * <p>The identifier for the organization under which the entity exists.</p>
3172
+ * @public
3173
3173
  */
3174
3174
  OrganizationId: string | undefined;
3175
3175
  /**
3176
- * @public
3177
3176
  * <p>The identifier for the entity.</p>
3178
3177
  * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
3179
3178
  * <ul>
@@ -3187,21 +3186,22 @@ export interface ListGroupsForEntityRequest {
3187
3186
  * <p>Entity name: entity</p>
3188
3187
  * </li>
3189
3188
  * </ul>
3189
+ * @public
3190
3190
  */
3191
3191
  EntityId: string | undefined;
3192
3192
  /**
3193
- * @public
3194
3193
  * <p>Limit the search results based on the filter criteria.</p>
3194
+ * @public
3195
3195
  */
3196
3196
  Filters?: ListGroupsForEntityFilters;
3197
3197
  /**
3198
- * @public
3199
3198
  * <p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p>
3199
+ * @public
3200
3200
  */
3201
3201
  NextToken?: string;
3202
3202
  /**
3203
- * @public
3204
3203
  * <p>The maximum number of results to return in a single call.</p>
3204
+ * @public
3205
3205
  */
3206
3206
  MaxResults?: number;
3207
3207
  }
@@ -3210,13 +3210,13 @@ export interface ListGroupsForEntityRequest {
3210
3210
  */
3211
3211
  export interface ListGroupsForEntityResponse {
3212
3212
  /**
3213
- * @public
3214
3213
  * <p>The overview of groups in an organization.</p>
3214
+ * @public
3215
3215
  */
3216
3216
  Groups?: GroupIdentifier[];
3217
3217
  /**
3218
- * @public
3219
3218
  * <p>The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.</p>
3219
+ * @public
3220
3220
  */
3221
3221
  NextToken?: string;
3222
3222
  }
@@ -3225,19 +3225,19 @@ export interface ListGroupsForEntityResponse {
3225
3225
  */
3226
3226
  export interface ListImpersonationRolesRequest {
3227
3227
  /**
3228
- * @public
3229
3228
  * <p>The WorkMail organization to which the listed impersonation roles belong.</p>
3229
+ * @public
3230
3230
  */
3231
3231
  OrganizationId: string | undefined;
3232
3232
  /**
3233
- * @public
3234
3233
  * <p>The token used to retrieve the next page of results. The first call doesn't require a
3235
3234
  * token.</p>
3235
+ * @public
3236
3236
  */
3237
3237
  NextToken?: string;
3238
3238
  /**
3239
- * @public
3240
3239
  * <p>The maximum number of results returned in a single call.</p>
3240
+ * @public
3241
3241
  */
3242
3242
  MaxResults?: number;
3243
3243
  }
@@ -3246,14 +3246,14 @@ export interface ListImpersonationRolesRequest {
3246
3246
  */
3247
3247
  export interface ListImpersonationRolesResponse {
3248
3248
  /**
3249
- * @public
3250
3249
  * <p>The list of impersonation roles under the given WorkMail organization.</p>
3250
+ * @public
3251
3251
  */
3252
3252
  Roles?: ImpersonationRole[];
3253
3253
  /**
3254
- * @public
3255
3254
  * <p>The token to retrieve the next page of results. The value is <code>null</code> when
3256
3255
  * there are no results to return.</p>
3256
+ * @public
3257
3257
  */
3258
3258
  NextToken?: string;
3259
3259
  }
@@ -3262,18 +3262,18 @@ export interface ListImpersonationRolesResponse {
3262
3262
  */
3263
3263
  export interface ListMailboxExportJobsRequest {
3264
3264
  /**
3265
- * @public
3266
3265
  * <p>The organization ID.</p>
3266
+ * @public
3267
3267
  */
3268
3268
  OrganizationId: string | undefined;
3269
3269
  /**
3270
- * @public
3271
3270
  * <p>The token to use to retrieve the next page of results.</p>
3271
+ * @public
3272
3272
  */
3273
3273
  NextToken?: string;
3274
3274
  /**
3275
- * @public
3276
3275
  * <p>The maximum number of results to return in a single call.</p>
3276
+ * @public
3277
3277
  */
3278
3278
  MaxResults?: number;
3279
3279
  }
@@ -3282,13 +3282,13 @@ export interface ListMailboxExportJobsRequest {
3282
3282
  */
3283
3283
  export interface ListMailboxExportJobsResponse {
3284
3284
  /**
3285
- * @public
3286
3285
  * <p>The mailbox export job details.</p>
3286
+ * @public
3287
3287
  */
3288
3288
  Jobs?: MailboxExportJob[];
3289
3289
  /**
3290
- * @public
3291
3290
  * <p>The token to use to retrieve the next page of results.</p>
3291
+ * @public
3292
3292
  */
3293
3293
  NextToken?: string;
3294
3294
  }
@@ -3297,13 +3297,12 @@ export interface ListMailboxExportJobsResponse {
3297
3297
  */
3298
3298
  export interface ListMailboxPermissionsRequest {
3299
3299
  /**
3300
- * @public
3301
3300
  * <p>The identifier of the organization under which the user, group, or resource
3302
3301
  * exists.</p>
3302
+ * @public
3303
3303
  */
3304
3304
  OrganizationId: string | undefined;
3305
3305
  /**
3306
- * @public
3307
3306
  * <p>The identifier of the user, or resource for which to list mailbox
3308
3307
  * permissions.</p>
3309
3308
  * <p>The entity ID can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>.</p>
@@ -3318,17 +3317,18 @@ export interface ListMailboxPermissionsRequest {
3318
3317
  * <p>Entity name: entity</p>
3319
3318
  * </li>
3320
3319
  * </ul>
3320
+ * @public
3321
3321
  */
3322
3322
  EntityId: string | undefined;
3323
3323
  /**
3324
- * @public
3325
3324
  * <p>The token to use to retrieve the next page of results. The first call does not
3326
3325
  * contain any tokens.</p>
3326
+ * @public
3327
3327
  */
3328
3328
  NextToken?: string;
3329
3329
  /**
3330
- * @public
3331
3330
  * <p>The maximum number of results to return in a single call.</p>
3331
+ * @public
3332
3332
  */
3333
3333
  MaxResults?: number;
3334
3334
  }
@@ -3346,30 +3346,30 @@ export declare const PermissionType: {
3346
3346
  */
3347
3347
  export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType];
3348
3348
  /**
3349
- * @public
3350
3349
  * <p>Permission granted to a user, group, or resource to access a certain aspect of
3351
3350
  * another user, group, or resource mailbox.</p>
3351
+ * @public
3352
3352
  */
3353
3353
  export interface Permission {
3354
3354
  /**
3355
- * @public
3356
3355
  * <p>The identifier of the user, group, or resource to which the permissions are
3357
3356
  * granted.</p>
3357
+ * @public
3358
3358
  */
3359
3359
  GranteeId: string | undefined;
3360
3360
  /**
3361
- * @public
3362
3361
  * <p>The type of user, group, or resource referred to in GranteeId.</p>
3362
+ * @public
3363
3363
  */
3364
3364
  GranteeType: MemberType | undefined;
3365
3365
  /**
3366
- * @public
3367
3366
  * <p>The permissions granted to the grantee. SEND_AS allows the grantee to send email as
3368
3367
  * the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF
3369
3368
  * allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not
3370
3369
  * mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full
3371
3370
  * access to the mailbox, irrespective of other folder-level permissions set on the
3372
3371
  * mailbox.</p>
3372
+ * @public
3373
3373
  */
3374
3374
  PermissionValues: PermissionType[] | undefined;
3375
3375
  }
@@ -3378,14 +3378,14 @@ export interface Permission {
3378
3378
  */
3379
3379
  export interface ListMailboxPermissionsResponse {
3380
3380
  /**
3381
- * @public
3382
3381
  * <p>One page of the user, group, or resource mailbox permissions.</p>
3382
+ * @public
3383
3383
  */
3384
3384
  Permissions?: Permission[];
3385
3385
  /**
3386
- * @public
3387
3386
  * <p>The token to use to retrieve the next page of results. The value is "null" when there
3388
3387
  * are no more results to return.</p>
3388
+ * @public
3389
3389
  */
3390
3390
  NextToken?: string;
3391
3391
  }
@@ -3394,34 +3394,34 @@ export interface ListMailboxPermissionsResponse {
3394
3394
  */
3395
3395
  export interface ListMailDomainsRequest {
3396
3396
  /**
3397
- * @public
3398
3397
  * <p>The WorkMail organization for which to list domains.</p>
3398
+ * @public
3399
3399
  */
3400
3400
  OrganizationId: string | undefined;
3401
3401
  /**
3402
- * @public
3403
3402
  * <p>The maximum number of results to return in a single call.</p>
3403
+ * @public
3404
3404
  */
3405
3405
  MaxResults?: number;
3406
3406
  /**
3407
- * @public
3408
3407
  * <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
3408
+ * @public
3409
3409
  */
3410
3410
  NextToken?: string;
3411
3411
  }
3412
3412
  /**
3413
- * @public
3414
3413
  * <p>The data for a given domain.</p>
3414
+ * @public
3415
3415
  */
3416
3416
  export interface MailDomainSummary {
3417
3417
  /**
3418
- * @public
3419
3418
  * <p>The domain name.</p>
3419
+ * @public
3420
3420
  */
3421
3421
  DomainName?: string;
3422
3422
  /**
3423
- * @public
3424
3423
  * <p>Whether the domain is default or not.</p>
3424
+ * @public
3425
3425
  */
3426
3426
  DefaultDomain?: boolean;
3427
3427
  }
@@ -3430,13 +3430,13 @@ export interface MailDomainSummary {
3430
3430
  */
3431
3431
  export interface ListMailDomainsResponse {
3432
3432
  /**
3433
- * @public
3434
3433
  * <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>
3434
+ * @public
3435
3435
  */
3436
3436
  MailDomains?: MailDomainSummary[];
3437
3437
  /**
3438
- * @public
3439
3438
  * <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>
3439
+ * @public
3440
3440
  */
3441
3441
  NextToken?: string;
3442
3442
  }
@@ -3445,12 +3445,11 @@ export interface ListMailDomainsResponse {
3445
3445
  */
3446
3446
  export interface ListMobileDeviceAccessOverridesRequest {
3447
3447
  /**
3448
- * @public
3449
3448
  * <p>The WorkMail organization under which to list mobile device access overrides.</p>
3449
+ * @public
3450
3450
  */
3451
3451
  OrganizationId: string | undefined;
3452
3452
  /**
3453
- * @public
3454
3453
  * <p>The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:</p>
3455
3454
  * <ul>
3456
3455
  * <li>
@@ -3466,57 +3465,58 @@ export interface ListMobileDeviceAccessOverridesRequest {
3466
3465
  * </p>
3467
3466
  * </li>
3468
3467
  * </ul>
3468
+ * @public
3469
3469
  */
3470
3470
  UserId?: string;
3471
3471
  /**
3472
- * @public
3473
3472
  * <p>The mobile device to which the access override applies.</p>
3473
+ * @public
3474
3474
  */
3475
3475
  DeviceId?: string;
3476
3476
  /**
3477
- * @public
3478
3477
  * <p>The token to use to retrieve the next page of results. The first call does not require a token.</p>
3478
+ * @public
3479
3479
  */
3480
3480
  NextToken?: string;
3481
3481
  /**
3482
- * @public
3483
3482
  * <p>The maximum number of results to return in a single call.</p>
3483
+ * @public
3484
3484
  */
3485
3485
  MaxResults?: number;
3486
3486
  }
3487
3487
  /**
3488
- * @public
3489
3488
  * <p>The override object.</p>
3489
+ * @public
3490
3490
  */
3491
3491
  export interface MobileDeviceAccessOverride {
3492
3492
  /**
3493
- * @public
3494
3493
  * <p>The WorkMail user to which the access override applies.</p>
3494
+ * @public
3495
3495
  */
3496
3496
  UserId?: string;
3497
3497
  /**
3498
- * @public
3499
3498
  * <p>The device to which the override applies.</p>
3499
+ * @public
3500
3500
  */
3501
3501
  DeviceId?: string;
3502
3502
  /**
3503
- * @public
3504
3503
  * <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
3504
+ * @public
3505
3505
  */
3506
3506
  Effect?: MobileDeviceAccessRuleEffect;
3507
3507
  /**
3508
- * @public
3509
3508
  * <p>A description of the override.</p>
3509
+ * @public
3510
3510
  */
3511
3511
  Description?: string;
3512
3512
  /**
3513
- * @public
3514
3513
  * <p>The date the override was first created.</p>
3514
+ * @public
3515
3515
  */
3516
3516
  DateCreated?: Date;
3517
3517
  /**
3518
- * @public
3519
3518
  * <p>The date the override was last modified.</p>
3519
+ * @public
3520
3520
  */
3521
3521
  DateModified?: Date;
3522
3522
  }
@@ -3525,13 +3525,13 @@ export interface MobileDeviceAccessOverride {
3525
3525
  */
3526
3526
  export interface ListMobileDeviceAccessOverridesResponse {
3527
3527
  /**
3528
- * @public
3529
3528
  * <p>The list of mobile device access overrides that exist for the specified WorkMail organization and user.</p>
3529
+ * @public
3530
3530
  */
3531
3531
  Overrides?: MobileDeviceAccessOverride[];
3532
3532
  /**
3533
- * @public
3534
3533
  * <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>
3534
+ * @public
3535
3535
  */
3536
3536
  NextToken?: string;
3537
3537
  }
@@ -3540,84 +3540,84 @@ export interface ListMobileDeviceAccessOverridesResponse {
3540
3540
  */
3541
3541
  export interface ListMobileDeviceAccessRulesRequest {
3542
3542
  /**
3543
- * @public
3544
3543
  * <p>The WorkMail organization for which to list the rules.</p>
3544
+ * @public
3545
3545
  */
3546
3546
  OrganizationId: string | undefined;
3547
3547
  }
3548
3548
  /**
3549
- * @public
3550
3549
  * <p>A rule that controls access to mobile devices for an WorkMail group.</p>
3550
+ * @public
3551
3551
  */
3552
3552
  export interface MobileDeviceAccessRule {
3553
3553
  /**
3554
- * @public
3555
3554
  * <p>The ID assigned to a mobile access rule.</p>
3555
+ * @public
3556
3556
  */
3557
3557
  MobileDeviceAccessRuleId?: string;
3558
3558
  /**
3559
- * @public
3560
3559
  * <p>The name of a mobile access rule.</p>
3560
+ * @public
3561
3561
  */
3562
3562
  Name?: string;
3563
3563
  /**
3564
- * @public
3565
3564
  * <p>The description of a mobile access rule.</p>
3565
+ * @public
3566
3566
  */
3567
3567
  Description?: string;
3568
3568
  /**
3569
- * @public
3570
3569
  * <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
3570
+ * @public
3571
3571
  */
3572
3572
  Effect?: MobileDeviceAccessRuleEffect;
3573
3573
  /**
3574
- * @public
3575
3574
  * <p>Device types that a rule will match.</p>
3575
+ * @public
3576
3576
  */
3577
3577
  DeviceTypes?: string[];
3578
3578
  /**
3579
- * @public
3580
3579
  * <p>Device types that a rule <b>will not</b> match. All other device types will match.</p>
3580
+ * @public
3581
3581
  */
3582
3582
  NotDeviceTypes?: string[];
3583
3583
  /**
3584
- * @public
3585
3584
  * <p>Device models that a rule will match.</p>
3585
+ * @public
3586
3586
  */
3587
3587
  DeviceModels?: string[];
3588
3588
  /**
3589
- * @public
3590
3589
  * <p>Device models that a rule <b>will not</b> match. All other device models will match.</p>
3590
+ * @public
3591
3591
  */
3592
3592
  NotDeviceModels?: string[];
3593
3593
  /**
3594
- * @public
3595
3594
  * <p>Device operating systems that a rule will match.</p>
3595
+ * @public
3596
3596
  */
3597
3597
  DeviceOperatingSystems?: string[];
3598
3598
  /**
3599
- * @public
3600
3599
  * <p>Device operating systems that a rule <b>will not</b> match. All other device types will match.</p>
3600
+ * @public
3601
3601
  */
3602
3602
  NotDeviceOperatingSystems?: string[];
3603
3603
  /**
3604
- * @public
3605
3604
  * <p>Device user agents that a rule will match.</p>
3605
+ * @public
3606
3606
  */
3607
3607
  DeviceUserAgents?: string[];
3608
3608
  /**
3609
- * @public
3610
3609
  * <p>Device user agents that a rule <b>will not</b> match. All other device user agents will match.</p>
3610
+ * @public
3611
3611
  */
3612
3612
  NotDeviceUserAgents?: string[];
3613
3613
  /**
3614
- * @public
3615
3614
  * <p>The date and time at which an access rule was created.</p>
3615
+ * @public
3616
3616
  */
3617
3617
  DateCreated?: Date;
3618
3618
  /**
3619
- * @public
3620
3619
  * <p>The date and time at which an access rule was modified.</p>
3620
+ * @public
3621
3621
  */
3622
3622
  DateModified?: Date;
3623
3623
  }
@@ -3626,8 +3626,8 @@ export interface MobileDeviceAccessRule {
3626
3626
  */
3627
3627
  export interface ListMobileDeviceAccessRulesResponse {
3628
3628
  /**
3629
- * @public
3630
3629
  * <p>The list of mobile device access rules that exist under the specified WorkMail organization.</p>
3630
+ * @public
3631
3631
  */
3632
3632
  Rules?: MobileDeviceAccessRule[];
3633
3633
  }
@@ -3636,47 +3636,47 @@ export interface ListMobileDeviceAccessRulesResponse {
3636
3636
  */
3637
3637
  export interface ListOrganizationsRequest {
3638
3638
  /**
3639
- * @public
3640
3639
  * <p>The token to use to retrieve the next page of results. The first call does not
3641
3640
  * contain any tokens.</p>
3641
+ * @public
3642
3642
  */
3643
3643
  NextToken?: string;
3644
3644
  /**
3645
- * @public
3646
3645
  * <p>The maximum number of results to return in a single call.</p>
3646
+ * @public
3647
3647
  */
3648
3648
  MaxResults?: number;
3649
3649
  }
3650
3650
  /**
3651
- * @public
3652
3651
  * <p>The representation of an organization.</p>
3652
+ * @public
3653
3653
  */
3654
3654
  export interface OrganizationSummary {
3655
3655
  /**
3656
- * @public
3657
3656
  * <p>The identifier associated with the organization.</p>
3657
+ * @public
3658
3658
  */
3659
3659
  OrganizationId?: string;
3660
3660
  /**
3661
- * @public
3662
3661
  * <p>The alias associated with the organization.</p>
3662
+ * @public
3663
3663
  */
3664
3664
  Alias?: string;
3665
3665
  /**
3666
- * @public
3667
3666
  * <p>The default email domain associated with the organization.</p>
3667
+ * @public
3668
3668
  */
3669
3669
  DefaultMailDomain?: string;
3670
3670
  /**
3671
- * @public
3672
3671
  * <p>The error message associated with the organization. It is only present if unexpected
3673
3672
  * behavior has occurred with regards to the organization. It provides insight or solutions
3674
3673
  * regarding unexpected behavior.</p>
3674
+ * @public
3675
3675
  */
3676
3676
  ErrorMessage?: string;
3677
3677
  /**
3678
- * @public
3679
3678
  * <p>The state associated with the organization.</p>
3679
+ * @public
3680
3680
  */
3681
3681
  State?: string;
3682
3682
  }
@@ -3685,15 +3685,15 @@ export interface OrganizationSummary {
3685
3685
  */
3686
3686
  export interface ListOrganizationsResponse {
3687
3687
  /**
3688
- * @public
3689
3688
  * <p>The overview of owned organizations presented as a list of organization
3690
3689
  * summaries.</p>
3690
+ * @public
3691
3691
  */
3692
3692
  OrganizationSummaries?: OrganizationSummary[];
3693
3693
  /**
3694
- * @public
3695
3694
  * <p>The token to use to retrieve the next page of results. The value is "null" when there
3696
3695
  * are no more results to return.</p>
3696
+ * @public
3697
3697
  */
3698
3698
  NextToken?: string;
3699
3699
  }
@@ -3702,13 +3702,12 @@ export interface ListOrganizationsResponse {
3702
3702
  */
3703
3703
  export interface ListResourceDelegatesRequest {
3704
3704
  /**
3705
- * @public
3706
3705
  * <p>The identifier for the organization that contains the resource for which delegates
3707
3706
  * are listed.</p>
3707
+ * @public
3708
3708
  */
3709
3709
  OrganizationId: string | undefined;
3710
3710
  /**
3711
- * @public
3712
3711
  * <p>The identifier for the resource whose delegates are listed.</p>
3713
3712
  * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
3714
3713
  * <ul>
@@ -3722,17 +3721,18 @@ export interface ListResourceDelegatesRequest {
3722
3721
  * <p>Resource name: resource</p>
3723
3722
  * </li>
3724
3723
  * </ul>
3724
+ * @public
3725
3725
  */
3726
3726
  ResourceId: string | undefined;
3727
3727
  /**
3728
- * @public
3729
3728
  * <p>The token used to paginate through the delegates associated with a
3730
3729
  * resource.</p>
3730
+ * @public
3731
3731
  */
3732
3732
  NextToken?: string;
3733
3733
  /**
3734
- * @public
3735
3734
  * <p>The number of maximum results in a page.</p>
3735
+ * @public
3736
3736
  */
3737
3737
  MaxResults?: number;
3738
3738
  }
@@ -3741,36 +3741,36 @@ export interface ListResourceDelegatesRequest {
3741
3741
  */
3742
3742
  export interface ListResourceDelegatesResponse {
3743
3743
  /**
3744
- * @public
3745
3744
  * <p>One page of the resource's delegates.</p>
3745
+ * @public
3746
3746
  */
3747
3747
  Delegates?: Delegate[];
3748
3748
  /**
3749
- * @public
3750
3749
  * <p>The token used to paginate through the delegates associated with a resource. While
3751
3750
  * results are still available, it has an associated value. When the last page is reached, the
3752
3751
  * token is empty.</p>
3752
+ * @public
3753
3753
  */
3754
3754
  NextToken?: string;
3755
3755
  }
3756
3756
  /**
3757
- * @public
3758
3757
  * <p>Filtering options for <i>ListResources</i> operation. This is only used as input to Operation.</p>
3758
+ * @public
3759
3759
  */
3760
3760
  export interface ListResourcesFilters {
3761
3761
  /**
3762
- * @public
3763
3762
  * <p>Filters only resource that start with the entered name prefix .</p>
3763
+ * @public
3764
3764
  */
3765
3765
  NamePrefix?: string;
3766
3766
  /**
3767
- * @public
3768
3767
  * <p>Filters only resource with the provided primary email prefix.</p>
3768
+ * @public
3769
3769
  */
3770
3770
  PrimaryEmailPrefix?: string;
3771
3771
  /**
3772
- * @public
3773
3772
  * <p>Filters only resource with the provided state.</p>
3773
+ * @public
3774
3774
  */
3775
3775
  State?: EntityState;
3776
3776
  }
@@ -3779,70 +3779,70 @@ export interface ListResourcesFilters {
3779
3779
  */
3780
3780
  export interface ListResourcesRequest {
3781
3781
  /**
3782
- * @public
3783
3782
  * <p>The identifier for the organization under which the resources exist.</p>
3783
+ * @public
3784
3784
  */
3785
3785
  OrganizationId: string | undefined;
3786
3786
  /**
3787
- * @public
3788
3787
  * <p>The token to use to retrieve the next page of results. The first call does not
3789
3788
  * contain any tokens.</p>
3789
+ * @public
3790
3790
  */
3791
3791
  NextToken?: string;
3792
3792
  /**
3793
- * @public
3794
3793
  * <p>The maximum number of results to return in a single call.</p>
3794
+ * @public
3795
3795
  */
3796
3796
  MaxResults?: number;
3797
3797
  /**
3798
- * @public
3799
3798
  * <p>Limit the resource search results based on the filter criteria. You can only use one filter per request.</p>
3799
+ * @public
3800
3800
  */
3801
3801
  Filters?: ListResourcesFilters;
3802
3802
  }
3803
3803
  /**
3804
- * @public
3805
3804
  * <p>The representation of a resource.</p>
3805
+ * @public
3806
3806
  */
3807
3807
  export interface Resource {
3808
3808
  /**
3809
- * @public
3810
3809
  * <p>The identifier of the resource.</p>
3810
+ * @public
3811
3811
  */
3812
3812
  Id?: string;
3813
3813
  /**
3814
- * @public
3815
3814
  * <p>The email of the resource.</p>
3815
+ * @public
3816
3816
  */
3817
3817
  Email?: string;
3818
3818
  /**
3819
- * @public
3820
3819
  * <p>The name of the resource.</p>
3820
+ * @public
3821
3821
  */
3822
3822
  Name?: string;
3823
3823
  /**
3824
- * @public
3825
3824
  * <p>The type of the resource: equipment or room.</p>
3825
+ * @public
3826
3826
  */
3827
3827
  Type?: ResourceType;
3828
3828
  /**
3829
- * @public
3830
3829
  * <p>The state of the resource, which can be ENABLED, DISABLED, or DELETED.</p>
3830
+ * @public
3831
3831
  */
3832
3832
  State?: EntityState;
3833
3833
  /**
3834
- * @public
3835
3834
  * <p>The date indicating when the resource was enabled for WorkMail use.</p>
3835
+ * @public
3836
3836
  */
3837
3837
  EnabledDate?: Date;
3838
3838
  /**
3839
- * @public
3840
3839
  * <p>The date indicating when the resource was disabled from WorkMail use.</p>
3840
+ * @public
3841
3841
  */
3842
3842
  DisabledDate?: Date;
3843
3843
  /**
3844
- * @public
3845
3844
  * <p>Resource description.</p>
3845
+ * @public
3846
3846
  */
3847
3847
  Description?: string;
3848
3848
  }
@@ -3851,15 +3851,15 @@ export interface Resource {
3851
3851
  */
3852
3852
  export interface ListResourcesResponse {
3853
3853
  /**
3854
- * @public
3855
3854
  * <p>One page of the organization's resource representation.</p>
3855
+ * @public
3856
3856
  */
3857
3857
  Resources?: Resource[];
3858
3858
  /**
3859
- * @public
3860
3859
  * <p> The token used to paginate through all the organization's resources. While results
3861
3860
  * are still available, it has an associated value. When the last page is reached, the token
3862
3861
  * is empty.</p>
3862
+ * @public
3863
3863
  */
3864
3864
  NextToken?: string;
3865
3865
  }
@@ -3868,24 +3868,24 @@ export interface ListResourcesResponse {
3868
3868
  */
3869
3869
  export interface ListTagsForResourceRequest {
3870
3870
  /**
3871
- * @public
3872
3871
  * <p>The resource ARN.</p>
3872
+ * @public
3873
3873
  */
3874
3874
  ResourceARN: string | undefined;
3875
3875
  }
3876
3876
  /**
3877
- * @public
3878
3877
  * <p>Describes a tag applied to a resource.</p>
3878
+ * @public
3879
3879
  */
3880
3880
  export interface Tag {
3881
3881
  /**
3882
- * @public
3883
3882
  * <p>The key of the tag.</p>
3883
+ * @public
3884
3884
  */
3885
3885
  Key: string | undefined;
3886
3886
  /**
3887
- * @public
3888
3887
  * <p>The value of the tag.</p>
3888
+ * @public
3889
3889
  */
3890
3890
  Value: string | undefined;
3891
3891
  }
@@ -3894,34 +3894,34 @@ export interface Tag {
3894
3894
  */
3895
3895
  export interface ListTagsForResourceResponse {
3896
3896
  /**
3897
- * @public
3898
3897
  * <p>A list of tag key-value pairs.</p>
3898
+ * @public
3899
3899
  */
3900
3900
  Tags?: Tag[];
3901
3901
  }
3902
3902
  /**
3903
- * @public
3904
3903
  * <p> Filtering options for <i>ListUsers</i> operation. This is only used as input to Operation.</p>
3904
+ * @public
3905
3905
  */
3906
3906
  export interface ListUsersFilters {
3907
3907
  /**
3908
- * @public
3909
3908
  * <p>Filters only users with the provided username prefix.</p>
3909
+ * @public
3910
3910
  */
3911
3911
  UsernamePrefix?: string;
3912
3912
  /**
3913
- * @public
3914
3913
  * <p>Filters only users with the provided display name prefix.</p>
3914
+ * @public
3915
3915
  */
3916
3916
  DisplayNamePrefix?: string;
3917
3917
  /**
3918
- * @public
3919
3918
  * <p>Filters only users with the provided email prefix.</p>
3919
+ * @public
3920
3920
  */
3921
3921
  PrimaryEmailPrefix?: string;
3922
3922
  /**
3923
- * @public
3924
3923
  * <p>Filters only users with the provided state.</p>
3924
+ * @public
3925
3925
  */
3926
3926
  State?: EntityState;
3927
3927
  }
@@ -3930,70 +3930,70 @@ export interface ListUsersFilters {
3930
3930
  */
3931
3931
  export interface ListUsersRequest {
3932
3932
  /**
3933
- * @public
3934
3933
  * <p>The identifier for the organization under which the users exist.</p>
3934
+ * @public
3935
3935
  */
3936
3936
  OrganizationId: string | undefined;
3937
3937
  /**
3938
- * @public
3939
3938
  * <p>The token to use to retrieve the next page of results. The first call does not
3940
3939
  * contain any tokens.</p>
3940
+ * @public
3941
3941
  */
3942
3942
  NextToken?: string;
3943
3943
  /**
3944
- * @public
3945
3944
  * <p>The maximum number of results to return in a single call.</p>
3945
+ * @public
3946
3946
  */
3947
3947
  MaxResults?: number;
3948
3948
  /**
3949
- * @public
3950
3949
  * <p>Limit the user search results based on the filter criteria. You can only use one filter per request.</p>
3950
+ * @public
3951
3951
  */
3952
3952
  Filters?: ListUsersFilters;
3953
3953
  }
3954
3954
  /**
3955
- * @public
3956
3955
  * <p>The representation of an WorkMail user.</p>
3956
+ * @public
3957
3957
  */
3958
3958
  export interface User {
3959
3959
  /**
3960
- * @public
3961
3960
  * <p>The identifier of the user.</p>
3961
+ * @public
3962
3962
  */
3963
3963
  Id?: string;
3964
3964
  /**
3965
- * @public
3966
3965
  * <p>The email of the user.</p>
3966
+ * @public
3967
3967
  */
3968
3968
  Email?: string;
3969
3969
  /**
3970
- * @public
3971
3970
  * <p>The name of the user.</p>
3971
+ * @public
3972
3972
  */
3973
3973
  Name?: string;
3974
3974
  /**
3975
- * @public
3976
3975
  * <p>The display name of the user.</p>
3976
+ * @public
3977
3977
  */
3978
3978
  DisplayName?: string;
3979
3979
  /**
3980
- * @public
3981
3980
  * <p>The state of the user, which can be ENABLED, DISABLED, or DELETED.</p>
3981
+ * @public
3982
3982
  */
3983
3983
  State?: EntityState;
3984
3984
  /**
3985
- * @public
3986
3985
  * <p>The role of the user.</p>
3986
+ * @public
3987
3987
  */
3988
3988
  UserRole?: UserRole;
3989
3989
  /**
3990
- * @public
3991
3990
  * <p>The date indicating when the user was enabled for WorkMail use.</p>
3991
+ * @public
3992
3992
  */
3993
3993
  EnabledDate?: Date;
3994
3994
  /**
3995
- * @public
3996
3995
  * <p>The date indicating when the user was disabled from WorkMail use.</p>
3996
+ * @public
3997
3997
  */
3998
3998
  DisabledDate?: Date;
3999
3999
  }
@@ -4002,14 +4002,14 @@ export interface User {
4002
4002
  */
4003
4003
  export interface ListUsersResponse {
4004
4004
  /**
4005
- * @public
4006
4005
  * <p>The overview of users for an organization.</p>
4006
+ * @public
4007
4007
  */
4008
4008
  Users?: User[];
4009
4009
  /**
4010
- * @public
4011
4010
  * <p> The token to use to retrieve the next page of results. This value is `null` when
4012
4011
  * there are no more results to return.</p>
4012
+ * @public
4013
4013
  */
4014
4014
  NextToken?: string;
4015
4015
  }
@@ -4018,67 +4018,67 @@ export interface ListUsersResponse {
4018
4018
  */
4019
4019
  export interface PutAccessControlRuleRequest {
4020
4020
  /**
4021
- * @public
4022
4021
  * <p>The rule name.</p>
4022
+ * @public
4023
4023
  */
4024
4024
  Name: string | undefined;
4025
4025
  /**
4026
- * @public
4027
4026
  * <p>The rule effect.</p>
4027
+ * @public
4028
4028
  */
4029
4029
  Effect: AccessControlRuleEffect | undefined;
4030
4030
  /**
4031
- * @public
4032
4031
  * <p>The rule description.</p>
4032
+ * @public
4033
4033
  */
4034
4034
  Description: string | undefined;
4035
4035
  /**
4036
- * @public
4037
4036
  * <p>IPv4 CIDR ranges to include in the rule.</p>
4037
+ * @public
4038
4038
  */
4039
4039
  IpRanges?: string[];
4040
4040
  /**
4041
- * @public
4042
4041
  * <p>IPv4 CIDR ranges to exclude from the rule.</p>
4042
+ * @public
4043
4043
  */
4044
4044
  NotIpRanges?: string[];
4045
4045
  /**
4046
- * @public
4047
4046
  * <p>Access protocol actions to include in the rule. Valid values include
4048
4047
  * <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
4049
4048
  * <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
4049
+ * @public
4050
4050
  */
4051
4051
  Actions?: string[];
4052
4052
  /**
4053
- * @public
4054
4053
  * <p>Access protocol actions to exclude from the rule. Valid values include
4055
4054
  * <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>,
4056
4055
  * <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>
4056
+ * @public
4057
4057
  */
4058
4058
  NotActions?: string[];
4059
4059
  /**
4060
- * @public
4061
4060
  * <p>User IDs to include in the rule.</p>
4061
+ * @public
4062
4062
  */
4063
4063
  UserIds?: string[];
4064
4064
  /**
4065
- * @public
4066
4065
  * <p>User IDs to exclude from the rule.</p>
4066
+ * @public
4067
4067
  */
4068
4068
  NotUserIds?: string[];
4069
4069
  /**
4070
- * @public
4071
4070
  * <p>The identifier of the organization.</p>
4071
+ * @public
4072
4072
  */
4073
4073
  OrganizationId: string | undefined;
4074
4074
  /**
4075
- * @public
4076
4075
  * <p>Impersonation role IDs to include in the rule.</p>
4076
+ * @public
4077
4077
  */
4078
4078
  ImpersonationRoleIds?: string[];
4079
4079
  /**
4080
- * @public
4081
4080
  * <p>Impersonation role IDs to exclude from the rule.</p>
4081
+ * @public
4082
4082
  */
4083
4083
  NotImpersonationRoleIds?: string[];
4084
4084
  }
@@ -4092,18 +4092,18 @@ export interface PutAccessControlRuleResponse {
4092
4092
  */
4093
4093
  export interface PutEmailMonitoringConfigurationRequest {
4094
4094
  /**
4095
- * @public
4096
4095
  * <p>The ID of the organization for which the email monitoring configuration is set.</p>
4096
+ * @public
4097
4097
  */
4098
4098
  OrganizationId: string | undefined;
4099
4099
  /**
4100
- * @public
4101
4100
  * <p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>
4101
+ * @public
4102
4102
  */
4103
4103
  RoleArn: string | undefined;
4104
4104
  /**
4105
- * @public
4106
4105
  * <p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>
4106
+ * @public
4107
4107
  */
4108
4108
  LogGroupArn: string | undefined;
4109
4109
  }
@@ -4117,13 +4117,13 @@ export interface PutEmailMonitoringConfigurationResponse {
4117
4117
  */
4118
4118
  export interface PutInboundDmarcSettingsRequest {
4119
4119
  /**
4120
- * @public
4121
4120
  * <p>The ID of the organization that you are applying the DMARC policy to.</p>
4121
+ * @public
4122
4122
  */
4123
4123
  OrganizationId: string | undefined;
4124
4124
  /**
4125
- * @public
4126
4125
  * <p>Enforces or suspends a policy after it's applied.</p>
4126
+ * @public
4127
4127
  */
4128
4128
  Enforced: boolean | undefined;
4129
4129
  }
@@ -4137,13 +4137,12 @@ export interface PutInboundDmarcSettingsResponse {
4137
4137
  */
4138
4138
  export interface PutMailboxPermissionsRequest {
4139
4139
  /**
4140
- * @public
4141
4140
  * <p>The identifier of the organization under which the user, group, or resource
4142
4141
  * exists.</p>
4142
+ * @public
4143
4143
  */
4144
4144
  OrganizationId: string | undefined;
4145
4145
  /**
4146
- * @public
4147
4146
  * <p>The identifier of the user or resource for which to update mailbox
4148
4147
  * permissions.</p>
4149
4148
  * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
@@ -4158,10 +4157,10 @@ export interface PutMailboxPermissionsRequest {
4158
4157
  * <p>Entity name: entity</p>
4159
4158
  * </li>
4160
4159
  * </ul>
4160
+ * @public
4161
4161
  */
4162
4162
  EntityId: string | undefined;
4163
4163
  /**
4164
- * @public
4165
4164
  * <p>The identifier of the user, group, or resource to which to grant the
4166
4165
  * permissions.</p>
4167
4166
  * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
@@ -4176,16 +4175,17 @@ export interface PutMailboxPermissionsRequest {
4176
4175
  * <p>Grantee name: grantee</p>
4177
4176
  * </li>
4178
4177
  * </ul>
4178
+ * @public
4179
4179
  */
4180
4180
  GranteeId: string | undefined;
4181
4181
  /**
4182
- * @public
4183
4182
  * <p>The permissions granted to the grantee. SEND_AS allows the grantee to send email as
4184
4183
  * the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF
4185
4184
  * allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not
4186
4185
  * mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full
4187
4186
  * access to the mailbox, irrespective of other folder-level permissions set on the
4188
4187
  * mailbox.</p>
4188
+ * @public
4189
4189
  */
4190
4190
  PermissionValues: PermissionType[] | undefined;
4191
4191
  }
@@ -4199,12 +4199,11 @@ export interface PutMailboxPermissionsResponse {
4199
4199
  */
4200
4200
  export interface PutMobileDeviceAccessOverrideRequest {
4201
4201
  /**
4202
- * @public
4203
4202
  * <p>Identifies the WorkMail organization for which you create the override.</p>
4203
+ * @public
4204
4204
  */
4205
4205
  OrganizationId: string | undefined;
4206
4206
  /**
4207
- * @public
4208
4207
  * <p>The WorkMail user for which you create the override. Accepts the following types of user identities:</p>
4209
4208
  * <ul>
4210
4209
  * <li>
@@ -4220,21 +4219,22 @@ export interface PutMobileDeviceAccessOverrideRequest {
4220
4219
  * </p>
4221
4220
  * </li>
4222
4221
  * </ul>
4222
+ * @public
4223
4223
  */
4224
4224
  UserId: string | undefined;
4225
4225
  /**
4226
- * @public
4227
4226
  * <p>The mobile device for which you create the override. <code>DeviceId</code> is case insensitive.</p>
4227
+ * @public
4228
4228
  */
4229
4229
  DeviceId: string | undefined;
4230
4230
  /**
4231
- * @public
4232
4231
  * <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
4232
+ * @public
4233
4233
  */
4234
4234
  Effect: MobileDeviceAccessRuleEffect | undefined;
4235
4235
  /**
4236
- * @public
4237
4236
  * <p>A description of the override.</p>
4237
+ * @public
4238
4238
  */
4239
4239
  Description?: string;
4240
4240
  }
@@ -4248,28 +4248,28 @@ export interface PutMobileDeviceAccessOverrideResponse {
4248
4248
  */
4249
4249
  export interface PutRetentionPolicyRequest {
4250
4250
  /**
4251
- * @public
4252
4251
  * <p>The organization ID.</p>
4252
+ * @public
4253
4253
  */
4254
4254
  OrganizationId: string | undefined;
4255
4255
  /**
4256
- * @public
4257
4256
  * <p>The retention policy ID.</p>
4257
+ * @public
4258
4258
  */
4259
4259
  Id?: string;
4260
4260
  /**
4261
- * @public
4262
4261
  * <p>The retention policy name.</p>
4262
+ * @public
4263
4263
  */
4264
4264
  Name: string | undefined;
4265
4265
  /**
4266
- * @public
4267
4266
  * <p>The retention policy description.</p>
4267
+ * @public
4268
4268
  */
4269
4269
  Description?: string;
4270
4270
  /**
4271
- * @public
4272
4271
  * <p>The retention policy folder configurations.</p>
4272
+ * @public
4273
4273
  */
4274
4274
  FolderConfigurations: FolderConfiguration[] | undefined;
4275
4275
  }
@@ -4283,18 +4283,18 @@ export interface PutRetentionPolicyResponse {
4283
4283
  */
4284
4284
  export interface RegisterMailDomainRequest {
4285
4285
  /**
4286
- * @public
4287
4286
  * <p>Idempotency token used when retrying requests.</p>
4287
+ * @public
4288
4288
  */
4289
4289
  ClientToken?: string;
4290
4290
  /**
4291
- * @public
4292
4291
  * <p>The WorkMail organization under which you're creating the domain.</p>
4292
+ * @public
4293
4293
  */
4294
4294
  OrganizationId: string | undefined;
4295
4295
  /**
4296
- * @public
4297
4296
  * <p>The name of the mail domain to create in WorkMail and SES.</p>
4297
+ * @public
4298
4298
  */
4299
4299
  DomainName: string | undefined;
4300
4300
  }
@@ -4308,13 +4308,12 @@ export interface RegisterMailDomainResponse {
4308
4308
  */
4309
4309
  export interface RegisterToWorkMailRequest {
4310
4310
  /**
4311
- * @public
4312
4311
  * <p>The identifier for the organization under which the user, group, or resource
4313
4312
  * exists.</p>
4313
+ * @public
4314
4314
  */
4315
4315
  OrganizationId: string | undefined;
4316
4316
  /**
4317
- * @public
4318
4317
  * <p>The identifier for the user, group, or resource to be updated.</p>
4319
4318
  * <p>The identifier can accept <i>UserId, ResourceId, or GroupId</i>, or <i>Username, Resourcename, or Groupname</i>. The following identity formats are available:</p>
4320
4319
  * <ul>
@@ -4325,11 +4324,12 @@ export interface RegisterToWorkMailRequest {
4325
4324
  * <p>Entity name: entity</p>
4326
4325
  * </li>
4327
4326
  * </ul>
4327
+ * @public
4328
4328
  */
4329
4329
  EntityId: string | undefined;
4330
4330
  /**
4331
- * @public
4332
4331
  * <p>The email for the user, group, or resource to be updated.</p>
4332
+ * @public
4333
4333
  */
4334
4334
  Email: string | undefined;
4335
4335
  }
@@ -4343,19 +4343,19 @@ export interface RegisterToWorkMailResponse {
4343
4343
  */
4344
4344
  export interface ResetPasswordRequest {
4345
4345
  /**
4346
- * @public
4347
4346
  * <p>The identifier of the organization that contains the user for which the password is
4348
4347
  * reset.</p>
4348
+ * @public
4349
4349
  */
4350
4350
  OrganizationId: string | undefined;
4351
4351
  /**
4352
- * @public
4353
4352
  * <p>The identifier of the user for whom the password is reset.</p>
4353
+ * @public
4354
4354
  */
4355
4355
  UserId: string | undefined;
4356
4356
  /**
4357
- * @public
4358
4357
  * <p>The new password for the user.</p>
4358
+ * @public
4359
4359
  */
4360
4360
  Password: string | undefined;
4361
4361
  }
@@ -4369,17 +4369,16 @@ export interface ResetPasswordResponse {
4369
4369
  */
4370
4370
  export interface StartMailboxExportJobRequest {
4371
4371
  /**
4372
- * @public
4373
4372
  * <p>The idempotency token for the client request.</p>
4373
+ * @public
4374
4374
  */
4375
4375
  ClientToken?: string;
4376
4376
  /**
4377
- * @public
4378
4377
  * <p>The identifier associated with the organization.</p>
4378
+ * @public
4379
4379
  */
4380
4380
  OrganizationId: string | undefined;
4381
4381
  /**
4382
- * @public
4383
4382
  * <p>The identifier of the user or resource associated with the mailbox.</p>
4384
4383
  * <p>The identifier can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
4385
4384
  * <ul>
@@ -4394,33 +4393,34 @@ export interface StartMailboxExportJobRequest {
4394
4393
  * <p>Entity name: entity</p>
4395
4394
  * </li>
4396
4395
  * </ul>
4396
+ * @public
4397
4397
  */
4398
4398
  EntityId: string | undefined;
4399
4399
  /**
4400
- * @public
4401
4400
  * <p>The mailbox export job description.</p>
4401
+ * @public
4402
4402
  */
4403
4403
  Description?: string;
4404
4404
  /**
4405
- * @public
4406
4405
  * <p>The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3
4407
4406
  * bucket.</p>
4407
+ * @public
4408
4408
  */
4409
4409
  RoleArn: string | undefined;
4410
4410
  /**
4411
- * @public
4412
4411
  * <p>The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)
4413
4412
  * key that encrypts the exported mailbox content.</p>
4413
+ * @public
4414
4414
  */
4415
4415
  KmsKeyArn: string | undefined;
4416
4416
  /**
4417
- * @public
4418
4417
  * <p>The name of the S3 bucket.</p>
4418
+ * @public
4419
4419
  */
4420
4420
  S3BucketName: string | undefined;
4421
4421
  /**
4422
- * @public
4423
4422
  * <p>The S3 bucket prefix.</p>
4423
+ * @public
4424
4424
  */
4425
4425
  S3Prefix: string | undefined;
4426
4426
  }
@@ -4429,8 +4429,8 @@ export interface StartMailboxExportJobRequest {
4429
4429
  */
4430
4430
  export interface StartMailboxExportJobResponse {
4431
4431
  /**
4432
- * @public
4433
4432
  * <p>The job ID.</p>
4433
+ * @public
4434
4434
  */
4435
4435
  JobId?: string;
4436
4436
  }
@@ -4439,13 +4439,13 @@ export interface StartMailboxExportJobResponse {
4439
4439
  */
4440
4440
  export interface TagResourceRequest {
4441
4441
  /**
4442
- * @public
4443
4442
  * <p>The resource ARN.</p>
4443
+ * @public
4444
4444
  */
4445
4445
  ResourceARN: string | undefined;
4446
4446
  /**
4447
- * @public
4448
4447
  * <p>The tag key-value pairs.</p>
4448
+ * @public
4449
4449
  */
4450
4450
  Tags: Tag[] | undefined;
4451
4451
  }
@@ -4455,8 +4455,8 @@ export interface TagResourceRequest {
4455
4455
  export interface TagResourceResponse {
4456
4456
  }
4457
4457
  /**
4458
- * @public
4459
4458
  * <p>The resource can have up to 50 user-applied tags.</p>
4459
+ * @public
4460
4460
  */
4461
4461
  export declare class TooManyTagsException extends __BaseException {
4462
4462
  readonly name: "TooManyTagsException";
@@ -4472,23 +4472,23 @@ export declare class TooManyTagsException extends __BaseException {
4472
4472
  */
4473
4473
  export interface TestAvailabilityConfigurationRequest {
4474
4474
  /**
4475
- * @public
4476
4475
  * <p>The WorkMail organization where the availability provider will be tested.</p>
4476
+ * @public
4477
4477
  */
4478
4478
  OrganizationId: string | undefined;
4479
4479
  /**
4480
- * @public
4481
4480
  * <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>
4481
+ * @public
4482
4482
  */
4483
4483
  DomainName?: string;
4484
4484
  /**
4485
- * @public
4486
4485
  * <p>Describes an EWS based availability provider. This is only used as input to the service.</p>
4486
+ * @public
4487
4487
  */
4488
4488
  EwsProvider?: EwsAvailabilityProvider;
4489
4489
  /**
4490
- * @public
4491
4490
  * <p>Describes a Lambda based availability provider.</p>
4491
+ * @public
4492
4492
  */
4493
4493
  LambdaProvider?: LambdaAvailabilityProvider;
4494
4494
  }
@@ -4497,13 +4497,13 @@ export interface TestAvailabilityConfigurationRequest {
4497
4497
  */
4498
4498
  export interface TestAvailabilityConfigurationResponse {
4499
4499
  /**
4500
- * @public
4501
4500
  * <p>Boolean indicating whether the test passed or failed.</p>
4501
+ * @public
4502
4502
  */
4503
4503
  TestPassed?: boolean;
4504
4504
  /**
4505
- * @public
4506
4505
  * <p>String containing the reason for a failed test if <code>TestPassed</code> is false.</p>
4506
+ * @public
4507
4507
  */
4508
4508
  FailureReason?: string;
4509
4509
  }
@@ -4512,13 +4512,13 @@ export interface TestAvailabilityConfigurationResponse {
4512
4512
  */
4513
4513
  export interface UntagResourceRequest {
4514
4514
  /**
4515
- * @public
4516
4515
  * <p>The resource ARN.</p>
4516
+ * @public
4517
4517
  */
4518
4518
  ResourceARN: string | undefined;
4519
4519
  /**
4520
- * @public
4521
4520
  * <p>The tag keys.</p>
4521
+ * @public
4522
4522
  */
4523
4523
  TagKeys: string[] | undefined;
4524
4524
  }
@@ -4532,28 +4532,28 @@ export interface UntagResourceResponse {
4532
4532
  */
4533
4533
  export interface UpdateAvailabilityConfigurationRequest {
4534
4534
  /**
4535
- * @public
4536
4535
  * <p>The WorkMail organization for which the <code>AvailabilityConfiguration</code> will be
4537
4536
  * updated.</p>
4537
+ * @public
4538
4538
  */
4539
4539
  OrganizationId: string | undefined;
4540
4540
  /**
4541
- * @public
4542
4541
  * <p>The domain to which the provider applies the availability configuration.</p>
4542
+ * @public
4543
4543
  */
4544
4544
  DomainName: string | undefined;
4545
4545
  /**
4546
- * @public
4547
4546
  * <p>The EWS availability provider definition. The request must contain exactly one provider
4548
4547
  * definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>. The previously
4549
4548
  * stored provider will be overridden by the one provided.</p>
4549
+ * @public
4550
4550
  */
4551
4551
  EwsProvider?: EwsAvailabilityProvider;
4552
4552
  /**
4553
- * @public
4554
4553
  * <p>The Lambda availability provider definition. The request must contain exactly one
4555
4554
  * provider definition, either <code>EwsProvider</code> or <code>LambdaProvider</code>. The
4556
4555
  * previously stored provider will be overridden by the one provided.</p>
4556
+ * @public
4557
4557
  */
4558
4558
  LambdaProvider?: LambdaAvailabilityProvider;
4559
4559
  }
@@ -4567,13 +4567,13 @@ export interface UpdateAvailabilityConfigurationResponse {
4567
4567
  */
4568
4568
  export interface UpdateDefaultMailDomainRequest {
4569
4569
  /**
4570
- * @public
4571
4570
  * <p>The WorkMail organization for which to list domains.</p>
4571
+ * @public
4572
4572
  */
4573
4573
  OrganizationId: string | undefined;
4574
4574
  /**
4575
- * @public
4576
4575
  * <p>The domain name that will become the default domain.</p>
4576
+ * @public
4577
4577
  */
4578
4578
  DomainName: string | undefined;
4579
4579
  }
@@ -4587,12 +4587,11 @@ export interface UpdateDefaultMailDomainResponse {
4587
4587
  */
4588
4588
  export interface UpdateGroupRequest {
4589
4589
  /**
4590
- * @public
4591
4590
  * <p>The identifier for the organization under which the group exists.</p>
4591
+ * @public
4592
4592
  */
4593
4593
  OrganizationId: string | undefined;
4594
4594
  /**
4595
- * @public
4596
4595
  * <p>The identifier for the group to be updated.</p>
4597
4596
  * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
4598
4597
  * <ul>
@@ -4606,11 +4605,12 @@ export interface UpdateGroupRequest {
4606
4605
  * <p>Group name: group</p>
4607
4606
  * </li>
4608
4607
  * </ul>
4608
+ * @public
4609
4609
  */
4610
4610
  GroupId: string | undefined;
4611
4611
  /**
4612
- * @public
4613
4612
  * <p>If enabled, the group is hidden from the global address list.</p>
4613
+ * @public
4614
4614
  */
4615
4615
  HiddenFromGlobalAddressList?: boolean;
4616
4616
  }
@@ -4624,33 +4624,33 @@ export interface UpdateGroupResponse {
4624
4624
  */
4625
4625
  export interface UpdateImpersonationRoleRequest {
4626
4626
  /**
4627
- * @public
4628
4627
  * <p>The WorkMail organization that contains the impersonation role to update.</p>
4628
+ * @public
4629
4629
  */
4630
4630
  OrganizationId: string | undefined;
4631
4631
  /**
4632
- * @public
4633
4632
  * <p>The ID of the impersonation role to update.</p>
4633
+ * @public
4634
4634
  */
4635
4635
  ImpersonationRoleId: string | undefined;
4636
4636
  /**
4637
- * @public
4638
4637
  * <p>The updated impersonation role name.</p>
4638
+ * @public
4639
4639
  */
4640
4640
  Name: string | undefined;
4641
4641
  /**
4642
- * @public
4643
4642
  * <p>The updated impersonation role type.</p>
4643
+ * @public
4644
4644
  */
4645
4645
  Type: ImpersonationRoleType | undefined;
4646
4646
  /**
4647
- * @public
4648
4647
  * <p>The updated impersonation role description.</p>
4648
+ * @public
4649
4649
  */
4650
4650
  Description?: string;
4651
4651
  /**
4652
- * @public
4653
4652
  * <p>The updated list of rules.</p>
4653
+ * @public
4654
4654
  */
4655
4655
  Rules: ImpersonationRule[] | undefined;
4656
4656
  }
@@ -4664,13 +4664,12 @@ export interface UpdateImpersonationRoleResponse {
4664
4664
  */
4665
4665
  export interface UpdateMailboxQuotaRequest {
4666
4666
  /**
4667
- * @public
4668
4667
  * <p>The identifier for the organization that contains the user for whom to update the
4669
4668
  * mailbox quota.</p>
4669
+ * @public
4670
4670
  */
4671
4671
  OrganizationId: string | undefined;
4672
4672
  /**
4673
- * @public
4674
4673
  * <p>The identifer for the user for whom to update the mailbox quota.</p>
4675
4674
  * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
4676
4675
  * <ul>
@@ -4684,11 +4683,12 @@ export interface UpdateMailboxQuotaRequest {
4684
4683
  * <p>User name: user</p>
4685
4684
  * </li>
4686
4685
  * </ul>
4686
+ * @public
4687
4687
  */
4688
4688
  UserId: string | undefined;
4689
4689
  /**
4690
- * @public
4691
4690
  * <p>The updated mailbox quota, in MB, for the specified user.</p>
4691
+ * @public
4692
4692
  */
4693
4693
  MailboxQuota: number | undefined;
4694
4694
  }
@@ -4702,68 +4702,68 @@ export interface UpdateMailboxQuotaResponse {
4702
4702
  */
4703
4703
  export interface UpdateMobileDeviceAccessRuleRequest {
4704
4704
  /**
4705
- * @public
4706
4705
  * <p>The WorkMail organization under which the rule will be updated.</p>
4706
+ * @public
4707
4707
  */
4708
4708
  OrganizationId: string | undefined;
4709
4709
  /**
4710
- * @public
4711
4710
  * <p>The identifier of the rule to be updated.</p>
4711
+ * @public
4712
4712
  */
4713
4713
  MobileDeviceAccessRuleId: string | undefined;
4714
4714
  /**
4715
- * @public
4716
4715
  * <p>The updated rule name.</p>
4716
+ * @public
4717
4717
  */
4718
4718
  Name: string | undefined;
4719
4719
  /**
4720
- * @public
4721
4720
  * <p>The updated rule description.</p>
4721
+ * @public
4722
4722
  */
4723
4723
  Description?: string;
4724
4724
  /**
4725
- * @public
4726
4725
  * <p>The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.</p>
4726
+ * @public
4727
4727
  */
4728
4728
  Effect: MobileDeviceAccessRuleEffect | undefined;
4729
4729
  /**
4730
- * @public
4731
4730
  * <p>Device types that the updated rule will match.</p>
4731
+ * @public
4732
4732
  */
4733
4733
  DeviceTypes?: string[];
4734
4734
  /**
4735
- * @public
4736
4735
  * <p>Device types that the updated rule <b>will not</b> match. All other device types will match.</p>
4736
+ * @public
4737
4737
  */
4738
4738
  NotDeviceTypes?: string[];
4739
4739
  /**
4740
- * @public
4741
4740
  * <p>Device models that the updated rule will match.</p>
4741
+ * @public
4742
4742
  */
4743
4743
  DeviceModels?: string[];
4744
4744
  /**
4745
- * @public
4746
4745
  * <p>Device models that the updated rule <b>will not</b> match. All other device models will match.</p>
4746
+ * @public
4747
4747
  */
4748
4748
  NotDeviceModels?: string[];
4749
4749
  /**
4750
- * @public
4751
4750
  * <p>Device operating systems that the updated rule will match.</p>
4751
+ * @public
4752
4752
  */
4753
4753
  DeviceOperatingSystems?: string[];
4754
4754
  /**
4755
- * @public
4756
4755
  * <p>Device operating systems that the updated rule <b>will not</b> match. All other device operating systems will match.</p>
4756
+ * @public
4757
4757
  */
4758
4758
  NotDeviceOperatingSystems?: string[];
4759
4759
  /**
4760
- * @public
4761
4760
  * <p>User agents that the updated rule will match.</p>
4761
+ * @public
4762
4762
  */
4763
4763
  DeviceUserAgents?: string[];
4764
4764
  /**
4765
- * @public
4766
4765
  * <p>User agents that the updated rule <b>will not</b> match. All other user agents will match.</p>
4766
+ * @public
4767
4767
  */
4768
4768
  NotDeviceUserAgents?: string[];
4769
4769
  }
@@ -4777,12 +4777,11 @@ export interface UpdateMobileDeviceAccessRuleResponse {
4777
4777
  */
4778
4778
  export interface UpdatePrimaryEmailAddressRequest {
4779
4779
  /**
4780
- * @public
4781
4780
  * <p>The organization that contains the user, group, or resource to update.</p>
4781
+ * @public
4782
4782
  */
4783
4783
  OrganizationId: string | undefined;
4784
4784
  /**
4785
- * @public
4786
4785
  * <p>The user, group, or resource to update.</p>
4787
4786
  * <p>The identifier can accept <i>UseriD, ResourceId, or GroupId</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
4788
4787
  * <ul>
@@ -4796,11 +4795,12 @@ export interface UpdatePrimaryEmailAddressRequest {
4796
4795
  * <p>Entity name: entity</p>
4797
4796
  * </li>
4798
4797
  * </ul>
4798
+ * @public
4799
4799
  */
4800
4800
  EntityId: string | undefined;
4801
4801
  /**
4802
- * @public
4803
4802
  * <p>The value of the email to be updated as primary.</p>
4803
+ * @public
4804
4804
  */
4805
4805
  Email: string | undefined;
4806
4806
  }
@@ -4814,13 +4814,12 @@ export interface UpdatePrimaryEmailAddressResponse {
4814
4814
  */
4815
4815
  export interface UpdateResourceRequest {
4816
4816
  /**
4817
- * @public
4818
4817
  * <p>The identifier associated with the organization for which the resource is
4819
4818
  * updated.</p>
4819
+ * @public
4820
4820
  */
4821
4821
  OrganizationId: string | undefined;
4822
4822
  /**
4823
- * @public
4824
4823
  * <p>The identifier of the resource to be updated.</p>
4825
4824
  * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
4826
4825
  * <ul>
@@ -4834,31 +4833,32 @@ export interface UpdateResourceRequest {
4834
4833
  * <p>Resource name: resource</p>
4835
4834
  * </li>
4836
4835
  * </ul>
4836
+ * @public
4837
4837
  */
4838
4838
  ResourceId: string | undefined;
4839
4839
  /**
4840
- * @public
4841
4840
  * <p>The name of the resource to be updated.</p>
4841
+ * @public
4842
4842
  */
4843
4843
  Name?: string;
4844
4844
  /**
4845
- * @public
4846
4845
  * <p>The resource's booking options to be updated.</p>
4846
+ * @public
4847
4847
  */
4848
4848
  BookingOptions?: BookingOptions;
4849
4849
  /**
4850
- * @public
4851
4850
  * <p>Updates the resource description.</p>
4851
+ * @public
4852
4852
  */
4853
4853
  Description?: string;
4854
4854
  /**
4855
- * @public
4856
4855
  * <p>Updates the resource type.</p>
4856
+ * @public
4857
4857
  */
4858
4858
  Type?: ResourceType;
4859
4859
  /**
4860
- * @public
4861
4860
  * <p>If enabled, the resource is hidden from the global address list.</p>
4861
+ * @public
4862
4862
  */
4863
4863
  HiddenFromGlobalAddressList?: boolean;
4864
4864
  }
@@ -4872,12 +4872,11 @@ export interface UpdateResourceResponse {
4872
4872
  */
4873
4873
  export interface UpdateUserRequest {
4874
4874
  /**
4875
- * @public
4876
4875
  * <p>The identifier for the organization under which the user exists.</p>
4876
+ * @public
4877
4877
  */
4878
4878
  OrganizationId: string | undefined;
4879
4879
  /**
4880
- * @public
4881
4880
  * <p>The identifier for the user to be updated.</p>
4882
4881
  * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
4883
4882
  * <ul>
@@ -4891,82 +4890,83 @@ export interface UpdateUserRequest {
4891
4890
  * <p>User name: user</p>
4892
4891
  * </li>
4893
4892
  * </ul>
4893
+ * @public
4894
4894
  */
4895
4895
  UserId: string | undefined;
4896
4896
  /**
4897
- * @public
4898
4897
  * <p>Updates the user role.</p>
4899
4898
  * <p>You cannot pass <i>SYSTEM_USER</i> or <i>RESOURCE</i>.</p>
4899
+ * @public
4900
4900
  */
4901
4901
  Role?: UserRole;
4902
4902
  /**
4903
- * @public
4904
4903
  * <p>Updates the display name of the user.</p>
4904
+ * @public
4905
4905
  */
4906
4906
  DisplayName?: string;
4907
4907
  /**
4908
- * @public
4909
4908
  * <p>Updates the user's first name.</p>
4909
+ * @public
4910
4910
  */
4911
4911
  FirstName?: string;
4912
4912
  /**
4913
- * @public
4914
4913
  * <p>Updates the user's last name.</p>
4914
+ * @public
4915
4915
  */
4916
4916
  LastName?: string;
4917
4917
  /**
4918
- * @public
4919
4918
  * <p>If enabled, the user is hidden from the global address list.</p>
4919
+ * @public
4920
4920
  */
4921
4921
  HiddenFromGlobalAddressList?: boolean;
4922
4922
  /**
4923
- * @public
4924
4923
  * <p>Updates the user's initials.</p>
4924
+ * @public
4925
4925
  */
4926
4926
  Initials?: string;
4927
4927
  /**
4928
- * @public
4929
4928
  * <p>Updates the user's contact details.</p>
4929
+ * @public
4930
4930
  */
4931
4931
  Telephone?: string;
4932
4932
  /**
4933
- * @public
4934
4933
  * <p>Updates the user's street address.</p>
4934
+ * @public
4935
4935
  */
4936
4936
  Street?: string;
4937
4937
  /**
4938
- * @public
4939
4938
  * <p>Updates the user's job title.</p>
4939
+ * @public
4940
4940
  */
4941
4941
  JobTitle?: string;
4942
4942
  /**
4943
- * @public
4944
4943
  * <p>Updates the user's city.</p>
4944
+ * @public
4945
4945
  */
4946
4946
  City?: string;
4947
4947
  /**
4948
- * @public
4949
4948
  * <p>Updates the user's company.</p>
4949
+ * @public
4950
4950
  */
4951
4951
  Company?: string;
4952
4952
  /**
4953
- * @public
4954
4953
  * <p>Updates the user's zipcode.</p>
4954
+ * @public
4955
4955
  */
4956
4956
  ZipCode?: string;
4957
4957
  /**
4958
- * @public
4959
4958
  * <p>Updates the user's department.</p>
4959
+ * @public
4960
4960
  */
4961
4961
  Department?: string;
4962
4962
  /**
4963
- * @public
4964
4963
  * <p>Updates the user's country.</p>
4964
+ * @public
4965
4965
  */
4966
4966
  Country?: string;
4967
4967
  /**
4968
- * @public
4969
4968
  * <p>Updates the user's office.</p>
4969
+ * @public
4970
4970
  */
4971
4971
  Office?: string;
4972
4972
  }