@aws-sdk/client-workmail 3.414.0 → 3.418.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 (223) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/WorkMail.js +8 -0
  3. package/dist-cjs/commands/AssociateDelegateToResourceCommand.js +5 -0
  4. package/dist-cjs/commands/AssociateMemberToGroupCommand.js +5 -0
  5. package/dist-cjs/commands/AssumeImpersonationRoleCommand.js +5 -0
  6. package/dist-cjs/commands/CancelMailboxExportJobCommand.js +5 -0
  7. package/dist-cjs/commands/CreateAliasCommand.js +5 -0
  8. package/dist-cjs/commands/CreateAvailabilityConfigurationCommand.js +5 -0
  9. package/dist-cjs/commands/CreateGroupCommand.js +5 -0
  10. package/dist-cjs/commands/CreateImpersonationRoleCommand.js +5 -0
  11. package/dist-cjs/commands/CreateMobileDeviceAccessRuleCommand.js +5 -0
  12. package/dist-cjs/commands/CreateOrganizationCommand.js +5 -0
  13. package/dist-cjs/commands/CreateResourceCommand.js +5 -0
  14. package/dist-cjs/commands/CreateUserCommand.js +5 -0
  15. package/dist-cjs/commands/DeleteAccessControlRuleCommand.js +5 -0
  16. package/dist-cjs/commands/DeleteAliasCommand.js +5 -0
  17. package/dist-cjs/commands/DeleteAvailabilityConfigurationCommand.js +5 -0
  18. package/dist-cjs/commands/DeleteEmailMonitoringConfigurationCommand.js +5 -0
  19. package/dist-cjs/commands/DeleteGroupCommand.js +5 -0
  20. package/dist-cjs/commands/DeleteImpersonationRoleCommand.js +5 -0
  21. package/dist-cjs/commands/DeleteMailboxPermissionsCommand.js +5 -0
  22. package/dist-cjs/commands/DeleteMobileDeviceAccessOverrideCommand.js +5 -0
  23. package/dist-cjs/commands/DeleteMobileDeviceAccessRuleCommand.js +5 -0
  24. package/dist-cjs/commands/DeleteOrganizationCommand.js +5 -0
  25. package/dist-cjs/commands/DeleteResourceCommand.js +5 -0
  26. package/dist-cjs/commands/DeleteRetentionPolicyCommand.js +5 -0
  27. package/dist-cjs/commands/DeleteUserCommand.js +5 -0
  28. package/dist-cjs/commands/DeregisterFromWorkMailCommand.js +5 -0
  29. package/dist-cjs/commands/DeregisterMailDomainCommand.js +5 -0
  30. package/dist-cjs/commands/DescribeEmailMonitoringConfigurationCommand.js +5 -0
  31. package/dist-cjs/commands/DescribeEntityCommand.js +51 -0
  32. package/dist-cjs/commands/DescribeGroupCommand.js +5 -0
  33. package/dist-cjs/commands/DescribeInboundDmarcSettingsCommand.js +5 -0
  34. package/dist-cjs/commands/DescribeMailboxExportJobCommand.js +5 -0
  35. package/dist-cjs/commands/DescribeOrganizationCommand.js +5 -0
  36. package/dist-cjs/commands/DescribeResourceCommand.js +5 -0
  37. package/dist-cjs/commands/DescribeUserCommand.js +7 -1
  38. package/dist-cjs/commands/DisassociateDelegateFromResourceCommand.js +5 -0
  39. package/dist-cjs/commands/DisassociateMemberFromGroupCommand.js +5 -0
  40. package/dist-cjs/commands/GetAccessControlEffectCommand.js +5 -0
  41. package/dist-cjs/commands/GetDefaultRetentionPolicyCommand.js +5 -0
  42. package/dist-cjs/commands/GetImpersonationRoleCommand.js +5 -0
  43. package/dist-cjs/commands/GetImpersonationRoleEffectCommand.js +5 -0
  44. package/dist-cjs/commands/GetMailDomainCommand.js +5 -0
  45. package/dist-cjs/commands/GetMailboxDetailsCommand.js +5 -0
  46. package/dist-cjs/commands/GetMobileDeviceAccessEffectCommand.js +5 -0
  47. package/dist-cjs/commands/GetMobileDeviceAccessOverrideCommand.js +5 -0
  48. package/dist-cjs/commands/ListAccessControlRulesCommand.js +5 -0
  49. package/dist-cjs/commands/ListAliasesCommand.js +5 -0
  50. package/dist-cjs/commands/ListAvailabilityConfigurationsCommand.js +5 -0
  51. package/dist-cjs/commands/ListGroupMembersCommand.js +5 -0
  52. package/dist-cjs/commands/ListGroupsCommand.js +5 -0
  53. package/dist-cjs/commands/ListGroupsForEntityCommand.js +51 -0
  54. package/dist-cjs/commands/ListImpersonationRolesCommand.js +5 -0
  55. package/dist-cjs/commands/ListMailDomainsCommand.js +5 -0
  56. package/dist-cjs/commands/ListMailboxExportJobsCommand.js +5 -0
  57. package/dist-cjs/commands/ListMailboxPermissionsCommand.js +5 -0
  58. package/dist-cjs/commands/ListMobileDeviceAccessOverridesCommand.js +5 -0
  59. package/dist-cjs/commands/ListMobileDeviceAccessRulesCommand.js +5 -0
  60. package/dist-cjs/commands/ListOrganizationsCommand.js +5 -0
  61. package/dist-cjs/commands/ListResourceDelegatesCommand.js +5 -0
  62. package/dist-cjs/commands/ListResourcesCommand.js +5 -0
  63. package/dist-cjs/commands/ListTagsForResourceCommand.js +5 -0
  64. package/dist-cjs/commands/ListUsersCommand.js +7 -1
  65. package/dist-cjs/commands/PutAccessControlRuleCommand.js +5 -0
  66. package/dist-cjs/commands/PutEmailMonitoringConfigurationCommand.js +5 -0
  67. package/dist-cjs/commands/PutInboundDmarcSettingsCommand.js +5 -0
  68. package/dist-cjs/commands/PutMailboxPermissionsCommand.js +5 -0
  69. package/dist-cjs/commands/PutMobileDeviceAccessOverrideCommand.js +5 -0
  70. package/dist-cjs/commands/PutRetentionPolicyCommand.js +5 -0
  71. package/dist-cjs/commands/RegisterMailDomainCommand.js +5 -0
  72. package/dist-cjs/commands/RegisterToWorkMailCommand.js +5 -0
  73. package/dist-cjs/commands/ResetPasswordCommand.js +5 -0
  74. package/dist-cjs/commands/StartMailboxExportJobCommand.js +5 -0
  75. package/dist-cjs/commands/TagResourceCommand.js +5 -0
  76. package/dist-cjs/commands/TestAvailabilityConfigurationCommand.js +5 -0
  77. package/dist-cjs/commands/UntagResourceCommand.js +5 -0
  78. package/dist-cjs/commands/UpdateAvailabilityConfigurationCommand.js +5 -0
  79. package/dist-cjs/commands/UpdateDefaultMailDomainCommand.js +5 -0
  80. package/dist-cjs/commands/UpdateGroupCommand.js +51 -0
  81. package/dist-cjs/commands/UpdateImpersonationRoleCommand.js +5 -0
  82. package/dist-cjs/commands/UpdateMailboxQuotaCommand.js +5 -0
  83. package/dist-cjs/commands/UpdateMobileDeviceAccessRuleCommand.js +5 -0
  84. package/dist-cjs/commands/UpdatePrimaryEmailAddressCommand.js +5 -0
  85. package/dist-cjs/commands/UpdateResourceCommand.js +5 -0
  86. package/dist-cjs/commands/UpdateUserCommand.js +52 -0
  87. package/dist-cjs/commands/index.js +4 -0
  88. package/dist-cjs/models/models_0.js +73 -20
  89. package/dist-cjs/pagination/ListGroupsForEntityPaginator.js +29 -0
  90. package/dist-cjs/pagination/index.js +1 -0
  91. package/dist-cjs/protocols/Aws_json1_1.js +276 -4
  92. package/dist-es/WorkMail.js +8 -0
  93. package/dist-es/commands/AssociateDelegateToResourceCommand.js +5 -0
  94. package/dist-es/commands/AssociateMemberToGroupCommand.js +5 -0
  95. package/dist-es/commands/AssumeImpersonationRoleCommand.js +5 -0
  96. package/dist-es/commands/CancelMailboxExportJobCommand.js +5 -0
  97. package/dist-es/commands/CreateAliasCommand.js +5 -0
  98. package/dist-es/commands/CreateAvailabilityConfigurationCommand.js +5 -0
  99. package/dist-es/commands/CreateGroupCommand.js +5 -0
  100. package/dist-es/commands/CreateImpersonationRoleCommand.js +5 -0
  101. package/dist-es/commands/CreateMobileDeviceAccessRuleCommand.js +5 -0
  102. package/dist-es/commands/CreateOrganizationCommand.js +5 -0
  103. package/dist-es/commands/CreateResourceCommand.js +5 -0
  104. package/dist-es/commands/CreateUserCommand.js +5 -0
  105. package/dist-es/commands/DeleteAccessControlRuleCommand.js +5 -0
  106. package/dist-es/commands/DeleteAliasCommand.js +5 -0
  107. package/dist-es/commands/DeleteAvailabilityConfigurationCommand.js +5 -0
  108. package/dist-es/commands/DeleteEmailMonitoringConfigurationCommand.js +5 -0
  109. package/dist-es/commands/DeleteGroupCommand.js +5 -0
  110. package/dist-es/commands/DeleteImpersonationRoleCommand.js +5 -0
  111. package/dist-es/commands/DeleteMailboxPermissionsCommand.js +5 -0
  112. package/dist-es/commands/DeleteMobileDeviceAccessOverrideCommand.js +5 -0
  113. package/dist-es/commands/DeleteMobileDeviceAccessRuleCommand.js +5 -0
  114. package/dist-es/commands/DeleteOrganizationCommand.js +5 -0
  115. package/dist-es/commands/DeleteResourceCommand.js +5 -0
  116. package/dist-es/commands/DeleteRetentionPolicyCommand.js +5 -0
  117. package/dist-es/commands/DeleteUserCommand.js +5 -0
  118. package/dist-es/commands/DeregisterFromWorkMailCommand.js +5 -0
  119. package/dist-es/commands/DeregisterMailDomainCommand.js +5 -0
  120. package/dist-es/commands/DescribeEmailMonitoringConfigurationCommand.js +5 -0
  121. package/dist-es/commands/DescribeEntityCommand.js +47 -0
  122. package/dist-es/commands/DescribeGroupCommand.js +5 -0
  123. package/dist-es/commands/DescribeInboundDmarcSettingsCommand.js +5 -0
  124. package/dist-es/commands/DescribeMailboxExportJobCommand.js +5 -0
  125. package/dist-es/commands/DescribeOrganizationCommand.js +5 -0
  126. package/dist-es/commands/DescribeResourceCommand.js +5 -0
  127. package/dist-es/commands/DescribeUserCommand.js +7 -1
  128. package/dist-es/commands/DisassociateDelegateFromResourceCommand.js +5 -0
  129. package/dist-es/commands/DisassociateMemberFromGroupCommand.js +5 -0
  130. package/dist-es/commands/GetAccessControlEffectCommand.js +5 -0
  131. package/dist-es/commands/GetDefaultRetentionPolicyCommand.js +5 -0
  132. package/dist-es/commands/GetImpersonationRoleCommand.js +5 -0
  133. package/dist-es/commands/GetImpersonationRoleEffectCommand.js +5 -0
  134. package/dist-es/commands/GetMailDomainCommand.js +5 -0
  135. package/dist-es/commands/GetMailboxDetailsCommand.js +5 -0
  136. package/dist-es/commands/GetMobileDeviceAccessEffectCommand.js +5 -0
  137. package/dist-es/commands/GetMobileDeviceAccessOverrideCommand.js +5 -0
  138. package/dist-es/commands/ListAccessControlRulesCommand.js +5 -0
  139. package/dist-es/commands/ListAliasesCommand.js +5 -0
  140. package/dist-es/commands/ListAvailabilityConfigurationsCommand.js +5 -0
  141. package/dist-es/commands/ListGroupMembersCommand.js +5 -0
  142. package/dist-es/commands/ListGroupsCommand.js +5 -0
  143. package/dist-es/commands/ListGroupsForEntityCommand.js +47 -0
  144. package/dist-es/commands/ListImpersonationRolesCommand.js +5 -0
  145. package/dist-es/commands/ListMailDomainsCommand.js +5 -0
  146. package/dist-es/commands/ListMailboxExportJobsCommand.js +5 -0
  147. package/dist-es/commands/ListMailboxPermissionsCommand.js +5 -0
  148. package/dist-es/commands/ListMobileDeviceAccessOverridesCommand.js +5 -0
  149. package/dist-es/commands/ListMobileDeviceAccessRulesCommand.js +5 -0
  150. package/dist-es/commands/ListOrganizationsCommand.js +5 -0
  151. package/dist-es/commands/ListResourceDelegatesCommand.js +5 -0
  152. package/dist-es/commands/ListResourcesCommand.js +5 -0
  153. package/dist-es/commands/ListTagsForResourceCommand.js +5 -0
  154. package/dist-es/commands/ListUsersCommand.js +7 -1
  155. package/dist-es/commands/PutAccessControlRuleCommand.js +5 -0
  156. package/dist-es/commands/PutEmailMonitoringConfigurationCommand.js +5 -0
  157. package/dist-es/commands/PutInboundDmarcSettingsCommand.js +5 -0
  158. package/dist-es/commands/PutMailboxPermissionsCommand.js +5 -0
  159. package/dist-es/commands/PutMobileDeviceAccessOverrideCommand.js +5 -0
  160. package/dist-es/commands/PutRetentionPolicyCommand.js +5 -0
  161. package/dist-es/commands/RegisterMailDomainCommand.js +5 -0
  162. package/dist-es/commands/RegisterToWorkMailCommand.js +5 -0
  163. package/dist-es/commands/ResetPasswordCommand.js +5 -0
  164. package/dist-es/commands/StartMailboxExportJobCommand.js +5 -0
  165. package/dist-es/commands/TagResourceCommand.js +5 -0
  166. package/dist-es/commands/TestAvailabilityConfigurationCommand.js +5 -0
  167. package/dist-es/commands/UntagResourceCommand.js +5 -0
  168. package/dist-es/commands/UpdateAvailabilityConfigurationCommand.js +5 -0
  169. package/dist-es/commands/UpdateDefaultMailDomainCommand.js +5 -0
  170. package/dist-es/commands/UpdateGroupCommand.js +47 -0
  171. package/dist-es/commands/UpdateImpersonationRoleCommand.js +5 -0
  172. package/dist-es/commands/UpdateMailboxQuotaCommand.js +5 -0
  173. package/dist-es/commands/UpdateMobileDeviceAccessRuleCommand.js +5 -0
  174. package/dist-es/commands/UpdatePrimaryEmailAddressCommand.js +5 -0
  175. package/dist-es/commands/UpdateResourceCommand.js +5 -0
  176. package/dist-es/commands/UpdateUserCommand.js +48 -0
  177. package/dist-es/commands/index.js +4 -0
  178. package/dist-es/models/models_0.js +66 -17
  179. package/dist-es/pagination/ListGroupsForEntityPaginator.js +25 -0
  180. package/dist-es/pagination/index.js +1 -0
  181. package/dist-es/protocols/Aws_json1_1.js +265 -1
  182. package/dist-types/WorkMail.d.ts +28 -0
  183. package/dist-types/WorkMailClient.d.ts +6 -2
  184. package/dist-types/commands/AssociateDelegateToResourceCommand.d.ts +3 -0
  185. package/dist-types/commands/CreateGroupCommand.d.ts +1 -0
  186. package/dist-types/commands/CreateOrganizationCommand.d.ts +1 -1
  187. package/dist-types/commands/CreateResourceCommand.d.ts +5 -0
  188. package/dist-types/commands/CreateUserCommand.d.ts +5 -1
  189. package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
  190. package/dist-types/commands/DeleteResourceCommand.d.ts +3 -0
  191. package/dist-types/commands/DescribeEntityCommand.d.ts +91 -0
  192. package/dist-types/commands/DescribeGroupCommand.d.ts +1 -0
  193. package/dist-types/commands/DescribeOrganizationCommand.d.ts +2 -0
  194. package/dist-types/commands/DescribeResourceCommand.d.ts +5 -0
  195. package/dist-types/commands/DescribeUserCommand.d.ts +16 -1
  196. package/dist-types/commands/DisassociateDelegateFromResourceCommand.d.ts +3 -0
  197. package/dist-types/commands/GetMailboxDetailsCommand.d.ts +3 -0
  198. package/dist-types/commands/ListGroupsCommand.d.ts +5 -0
  199. package/dist-types/commands/ListGroupsForEntityCommand.d.ts +104 -0
  200. package/dist-types/commands/ListResourceDelegatesCommand.d.ts +3 -0
  201. package/dist-types/commands/ListResourcesCommand.d.ts +9 -0
  202. package/dist-types/commands/ListUsersCommand.d.ts +7 -1
  203. package/dist-types/commands/TagResourceCommand.d.ts +3 -0
  204. package/dist-types/commands/UpdateGroupCommand.d.ts +95 -0
  205. package/dist-types/commands/UpdateResourceCommand.d.ts +9 -0
  206. package/dist-types/commands/UpdateUserCommand.d.ts +117 -0
  207. package/dist-types/commands/index.d.ts +4 -0
  208. package/dist-types/models/models_0.d.ts +921 -58
  209. package/dist-types/pagination/ListGroupsForEntityPaginator.d.ts +7 -0
  210. package/dist-types/pagination/index.d.ts +1 -0
  211. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  212. package/dist-types/ts3.4/WorkMail.d.ts +68 -0
  213. package/dist-types/ts3.4/WorkMailClient.d.ts +26 -2
  214. package/dist-types/ts3.4/commands/DescribeEntityCommand.d.ts +38 -0
  215. package/dist-types/ts3.4/commands/ListGroupsForEntityCommand.d.ts +39 -0
  216. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +35 -0
  217. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +35 -0
  218. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  219. package/dist-types/ts3.4/models/models_0.d.ts +139 -16
  220. package/dist-types/ts3.4/pagination/ListGroupsForEntityPaginator.d.ts +11 -0
  221. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  222. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
  223. package/package.json +31 -31
@@ -111,11 +111,35 @@ export interface AssociateDelegateToResourceRequest {
111
111
  /**
112
112
  * @public
113
113
  * <p>The resource for which members (users or groups) are associated.</p>
114
+ * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
115
+ * <ul>
116
+ * <li>
117
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
118
+ * </li>
119
+ * <li>
120
+ * <p>Email address: resource@domain.tld</p>
121
+ * </li>
122
+ * <li>
123
+ * <p>Resource name: resource</p>
124
+ * </li>
125
+ * </ul>
114
126
  */
115
127
  ResourceId: string | undefined;
116
128
  /**
117
129
  * @public
118
130
  * <p>The member (user or group) to associate to the resource.</p>
131
+ * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
132
+ * <ul>
133
+ * <li>
134
+ * <p>Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
135
+ * </li>
136
+ * <li>
137
+ * <p>Email address: entity@domain.tld</p>
138
+ * </li>
139
+ * <li>
140
+ * <p>Entity: entity</p>
141
+ * </li>
142
+ * </ul>
119
143
  */
120
144
  EntityId: string | undefined;
121
145
  }
@@ -193,6 +217,19 @@ export declare class OrganizationStateException extends __BaseException {
193
217
  */
194
218
  constructor(opts: __ExceptionOptionType<OrganizationStateException, __BaseException>);
195
219
  }
220
+ /**
221
+ * @public
222
+ * <p>You can't perform a write operation against a read-only directory.</p>
223
+ */
224
+ export declare class UnsupportedOperationException extends __BaseException {
225
+ readonly name: "UnsupportedOperationException";
226
+ readonly $fault: "client";
227
+ Message?: string;
228
+ /**
229
+ * @internal
230
+ */
231
+ constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
232
+ }
196
233
  /**
197
234
  * @public
198
235
  */
@@ -205,11 +242,35 @@ export interface AssociateMemberToGroupRequest {
205
242
  /**
206
243
  * @public
207
244
  * <p>The group to which the member (user or group) is associated.</p>
245
+ * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
246
+ * <ul>
247
+ * <li>
248
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
249
+ * </li>
250
+ * <li>
251
+ * <p>Email address: group@domain.tld</p>
252
+ * </li>
253
+ * <li>
254
+ * <p>Group name: group</p>
255
+ * </li>
256
+ * </ul>
208
257
  */
209
258
  GroupId: string | undefined;
210
259
  /**
211
260
  * @public
212
261
  * <p>The member (user or group) to associate to the group.</p>
262
+ * <p>The member ID can accept <i>UserID or GroupId</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
263
+ * <ul>
264
+ * <li>
265
+ * <p>Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
266
+ * </li>
267
+ * <li>
268
+ * <p>Email address: member@domain.tld</p>
269
+ * </li>
270
+ * <li>
271
+ * <p>Member name: member</p>
272
+ * </li>
273
+ * </ul>
213
274
  */
214
275
  MemberId: string | undefined;
215
276
  }
@@ -244,19 +305,6 @@ export declare class DirectoryUnavailableException extends __BaseException {
244
305
  */
245
306
  constructor(opts: __ExceptionOptionType<DirectoryUnavailableException, __BaseException>);
246
307
  }
247
- /**
248
- * @public
249
- * <p>You can't perform a write operation against a read-only directory.</p>
250
- */
251
- export declare class UnsupportedOperationException extends __BaseException {
252
- readonly name: "UnsupportedOperationException";
253
- readonly $fault: "client";
254
- Message?: string;
255
- /**
256
- * @internal
257
- */
258
- constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
259
- }
260
308
  /**
261
309
  * @public
262
310
  */
@@ -589,6 +637,11 @@ export interface CreateGroupRequest {
589
637
  * <p>The name of the group.</p>
590
638
  */
591
639
  Name: string | undefined;
640
+ /**
641
+ * @public
642
+ * <p>If this parameter is enabled, the group will be hidden from the address book.</p>
643
+ */
644
+ HiddenFromGlobalAddressList?: boolean;
592
645
  }
593
646
  /**
594
647
  * @public
@@ -810,7 +863,7 @@ export interface Domain {
810
863
  * @public
811
864
  * <p>The fully qualified domain name.</p>
812
865
  */
813
- DomainName?: string;
866
+ DomainName: string | undefined;
814
867
  /**
815
868
  * @public
816
869
  * <p>The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.</p>
@@ -910,6 +963,16 @@ export interface CreateResourceRequest {
910
963
  * <code>room</code>.</p>
911
964
  */
912
965
  Type: ResourceType | string | undefined;
966
+ /**
967
+ * @public
968
+ * <p>Resource description.</p>
969
+ */
970
+ Description?: string;
971
+ /**
972
+ * @public
973
+ * <p>If this parameter is enabled, the resource will be hidden from the address book.</p>
974
+ */
975
+ HiddenFromGlobalAddressList?: boolean;
913
976
  }
914
977
  /**
915
978
  * @public
@@ -921,6 +984,20 @@ export interface CreateResourceResponse {
921
984
  */
922
985
  ResourceId?: string;
923
986
  }
987
+ /**
988
+ * @public
989
+ * @enum
990
+ */
991
+ export declare const UserRole: {
992
+ readonly REMOTE_USER: "REMOTE_USER";
993
+ readonly RESOURCE: "RESOURCE";
994
+ readonly SYSTEM_USER: "SYSTEM_USER";
995
+ readonly USER: "USER";
996
+ };
997
+ /**
998
+ * @public
999
+ */
1000
+ export type UserRole = (typeof UserRole)[keyof typeof UserRole];
924
1001
  /**
925
1002
  * @public
926
1003
  */
@@ -944,7 +1021,28 @@ export interface CreateUserRequest {
944
1021
  * @public
945
1022
  * <p>The password for the new user.</p>
946
1023
  */
947
- Password: string | undefined;
1024
+ Password?: string;
1025
+ /**
1026
+ * @public
1027
+ * <p>The role of the new user.</p>
1028
+ * <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>
1029
+ */
1030
+ Role?: UserRole | string;
1031
+ /**
1032
+ * @public
1033
+ * <p>The first name of the new user.</p>
1034
+ */
1035
+ FirstName?: string;
1036
+ /**
1037
+ * @public
1038
+ * <p>The last name of the new user. </p>
1039
+ */
1040
+ LastName?: string;
1041
+ /**
1042
+ * @public
1043
+ * <p>If this parameter is enabled, the user will be hidden from the address book.</p>
1044
+ */
1045
+ HiddenFromGlobalAddressList?: boolean;
948
1046
  }
949
1047
  /**
950
1048
  * @public
@@ -1093,6 +1191,15 @@ export interface DeleteGroupRequest {
1093
1191
  /**
1094
1192
  * @public
1095
1193
  * <p>The identifier of the group to be deleted.</p>
1194
+ * <p>The identifier can be the <i>GroupId</i>, or <i>Groupname</i>. The following identity formats are available:</p>
1195
+ * <ul>
1196
+ * <li>
1197
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
1198
+ * </li>
1199
+ * <li>
1200
+ * <p>Group name: group</p>
1201
+ * </li>
1202
+ * </ul>
1096
1203
  */
1097
1204
  GroupId: string | undefined;
1098
1205
  }
@@ -1133,13 +1240,36 @@ export interface DeleteMailboxPermissionsRequest {
1133
1240
  OrganizationId: string | undefined;
1134
1241
  /**
1135
1242
  * @public
1136
- * <p>The identifier of the member (user or group) that owns the mailbox.</p>
1243
+ * <p>The identifier of the entity that owns the mailbox.</p>
1244
+ * <p>The identifier can be <i>UserId or Group Id</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
1245
+ * <ul>
1246
+ * <li>
1247
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
1248
+ * </li>
1249
+ * <li>
1250
+ * <p>Email address: entity@domain.tld</p>
1251
+ * </li>
1252
+ * <li>
1253
+ * <p>Entity name: entity</p>
1254
+ * </li>
1255
+ * </ul>
1137
1256
  */
1138
1257
  EntityId: string | undefined;
1139
1258
  /**
1140
1259
  * @public
1141
- * <p>The identifier of the member (user or group) for which to delete granted
1142
- * permissions.</p>
1260
+ * <p>The identifier of the entity for which to delete granted permissions.</p>
1261
+ * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
1262
+ * <ul>
1263
+ * <li>
1264
+ * <p>Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
1265
+ * </li>
1266
+ * <li>
1267
+ * <p>Email address: grantee@domain.tld</p>
1268
+ * </li>
1269
+ * <li>
1270
+ * <p>Grantee name: grantee</p>
1271
+ * </li>
1272
+ * </ul>
1143
1273
  */
1144
1274
  GranteeId: string | undefined;
1145
1275
  }
@@ -1226,6 +1356,11 @@ export interface DeleteOrganizationRequest {
1226
1356
  * <p>If true, deletes the AWS Directory Service directory associated with the organization.</p>
1227
1357
  */
1228
1358
  DeleteDirectory: boolean | undefined;
1359
+ /**
1360
+ * @public
1361
+ * <p>Deletes a WorkMail organization even if the organization has enabled users.</p>
1362
+ */
1363
+ ForceDelete?: boolean;
1229
1364
  }
1230
1365
  /**
1231
1366
  * @public
@@ -1255,6 +1390,15 @@ export interface DeleteResourceRequest {
1255
1390
  /**
1256
1391
  * @public
1257
1392
  * <p>The identifier of the resource to be deleted.</p>
1393
+ * <p>The identifier can accept <i>ResourceId</i>, or <i>Resourcename</i>. The following identity formats are available:</p>
1394
+ * <ul>
1395
+ * <li>
1396
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
1397
+ * </li>
1398
+ * <li>
1399
+ * <p>Resource name: resource</p>
1400
+ * </li>
1401
+ * </ul>
1258
1402
  */
1259
1403
  ResourceId: string | undefined;
1260
1404
  }
@@ -1295,6 +1439,15 @@ export interface DeleteUserRequest {
1295
1439
  /**
1296
1440
  * @public
1297
1441
  * <p>The identifier of the user to be deleted.</p>
1442
+ * <p>The identifier can be the <i>UserId</i> or <i>Username</i>. The following identity formats are available:</p>
1443
+ * <ul>
1444
+ * <li>
1445
+ * <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
1446
+ * </li>
1447
+ * <li>
1448
+ * <p>User name: user</p>
1449
+ * </li>
1450
+ * </ul>
1298
1451
  */
1299
1452
  UserId: string | undefined;
1300
1453
  }
@@ -1314,7 +1467,19 @@ export interface DeregisterFromWorkMailRequest {
1314
1467
  OrganizationId: string | undefined;
1315
1468
  /**
1316
1469
  * @public
1317
- * <p>The identifier for the member (user or group) to be updated.</p>
1470
+ * <p>The identifier for the member to be updated.</p>
1471
+ * <p>The identifier can be <i>UserId, ResourceId, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
1472
+ * <ul>
1473
+ * <li>
1474
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
1475
+ * </li>
1476
+ * <li>
1477
+ * <p>Email address: entity@domain.tld</p>
1478
+ * </li>
1479
+ * <li>
1480
+ * <p>Entity name: entity</p>
1481
+ * </li>
1482
+ * </ul>
1318
1483
  */
1319
1484
  EntityId: string | undefined;
1320
1485
  }
@@ -1395,6 +1560,54 @@ export interface DescribeEmailMonitoringConfigurationResponse {
1395
1560
  */
1396
1561
  LogGroupArn?: string;
1397
1562
  }
1563
+ /**
1564
+ * @public
1565
+ */
1566
+ export interface DescribeEntityRequest {
1567
+ /**
1568
+ * @public
1569
+ * <p>The identifier for the organization under which the entity exists.</p>
1570
+ */
1571
+ OrganizationId: string | undefined;
1572
+ /**
1573
+ * @public
1574
+ * <p>The email under which the entity exists.</p>
1575
+ */
1576
+ Email: string | undefined;
1577
+ }
1578
+ /**
1579
+ * @public
1580
+ * @enum
1581
+ */
1582
+ export declare const EntityType: {
1583
+ readonly GROUP: "GROUP";
1584
+ readonly RESOURCE: "RESOURCE";
1585
+ readonly USER: "USER";
1586
+ };
1587
+ /**
1588
+ * @public
1589
+ */
1590
+ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
1591
+ /**
1592
+ * @public
1593
+ */
1594
+ export interface DescribeEntityResponse {
1595
+ /**
1596
+ * @public
1597
+ * <p>The entity ID under which the entity exists.</p>
1598
+ */
1599
+ EntityId?: string;
1600
+ /**
1601
+ * @public
1602
+ * <p>Username, GroupName, or ResourceName based on entity type.</p>
1603
+ */
1604
+ Name?: string;
1605
+ /**
1606
+ * @public
1607
+ * <p>Entity type.</p>
1608
+ */
1609
+ Type?: EntityType | string;
1610
+ }
1398
1611
  /**
1399
1612
  * @public
1400
1613
  */
@@ -1407,6 +1620,18 @@ export interface DescribeGroupRequest {
1407
1620
  /**
1408
1621
  * @public
1409
1622
  * <p>The identifier for the group to be described.</p>
1623
+ * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
1624
+ * <ul>
1625
+ * <li>
1626
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
1627
+ * </li>
1628
+ * <li>
1629
+ * <p>Email address: group@domain.tld</p>
1630
+ * </li>
1631
+ * <li>
1632
+ * <p>Group name: group</p>
1633
+ * </li>
1634
+ * </ul>
1410
1635
  */
1411
1636
  GroupId: string | undefined;
1412
1637
  }
@@ -1460,6 +1685,11 @@ export interface DescribeGroupResponse {
1460
1685
  * format.</p>
1461
1686
  */
1462
1687
  DisabledDate?: Date;
1688
+ /**
1689
+ * @public
1690
+ * <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
1691
+ */
1692
+ HiddenFromGlobalAddressList?: boolean;
1463
1693
  }
1464
1694
  /**
1465
1695
  * @public
@@ -1639,6 +1869,16 @@ export interface DescribeOrganizationResponse {
1639
1869
  * <p>The Amazon Resource Name (ARN) of the organization.</p>
1640
1870
  */
1641
1871
  ARN?: string;
1872
+ /**
1873
+ * @public
1874
+ * <p>The user ID of the migration admin if migration is enabled for the organization.</p>
1875
+ */
1876
+ MigrationAdmin?: string;
1877
+ /**
1878
+ * @public
1879
+ * <p>Indicates if interoperability is enabled for this organization.</p>
1880
+ */
1881
+ InteroperabilityEnabled?: boolean;
1642
1882
  }
1643
1883
  /**
1644
1884
  * @public
@@ -1653,6 +1893,18 @@ export interface DescribeResourceRequest {
1653
1893
  /**
1654
1894
  * @public
1655
1895
  * <p>The identifier of the resource to be described.</p>
1896
+ * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
1897
+ * <ul>
1898
+ * <li>
1899
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
1900
+ * </li>
1901
+ * <li>
1902
+ * <p>Email address: resource@domain.tld</p>
1903
+ * </li>
1904
+ * <li>
1905
+ * <p>Resource name: resource</p>
1906
+ * </li>
1907
+ * </ul>
1656
1908
  */
1657
1909
  ResourceId: string | undefined;
1658
1910
  }
@@ -1703,6 +1955,16 @@ export interface DescribeResourceResponse {
1703
1955
  * format.</p>
1704
1956
  */
1705
1957
  DisabledDate?: Date;
1958
+ /**
1959
+ * @public
1960
+ * <p>Description of the resource.</p>
1961
+ */
1962
+ Description?: string;
1963
+ /**
1964
+ * @public
1965
+ * <p>If enabled, the resource is hidden from the global address list.</p>
1966
+ */
1967
+ HiddenFromGlobalAddressList?: boolean;
1706
1968
  }
1707
1969
  /**
1708
1970
  * @public
@@ -1716,22 +1978,22 @@ export interface DescribeUserRequest {
1716
1978
  /**
1717
1979
  * @public
1718
1980
  * <p>The identifier for the user to be described.</p>
1981
+ * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
1982
+ * <ul>
1983
+ * <li>
1984
+ * <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
1985
+ * </li>
1986
+ * <li>
1987
+ * <p>Email address: user@domain.tld</p>
1988
+ * </li>
1989
+ * <li>
1990
+ * <p>User name: user</p>
1991
+ * </li>
1992
+ * </ul>
1993
+ * <p></p>
1719
1994
  */
1720
1995
  UserId: string | undefined;
1721
1996
  }
1722
- /**
1723
- * @public
1724
- * @enum
1725
- */
1726
- export declare const UserRole: {
1727
- readonly RESOURCE: "RESOURCE";
1728
- readonly SYSTEM_USER: "SYSTEM_USER";
1729
- readonly USER: "USER";
1730
- };
1731
- /**
1732
- * @public
1733
- */
1734
- export type UserRole = (typeof UserRole)[keyof typeof UserRole];
1735
1997
  /**
1736
1998
  * @public
1737
1999
  */
@@ -1768,7 +2030,7 @@ export interface DescribeUserResponse {
1768
2030
  * enabled, resources are imported into WorkMail as users. Because different WorkMail
1769
2031
  * organizations rely on different directory types, administrators can distinguish between an
1770
2032
  * unregistered user (account is disabled and has a user role) and the directory
1771
- * administrators. The values are USER, RESOURCE, and SYSTEM_USER.</p>
2033
+ * administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.</p>
1772
2034
  */
1773
2035
  UserRole?: UserRole | string;
1774
2036
  /**
@@ -1783,37 +2045,136 @@ export interface DescribeUserResponse {
1783
2045
  * time format.</p>
1784
2046
  */
1785
2047
  DisabledDate?: Date;
1786
- }
1787
- /**
1788
- * @public
1789
- */
1790
- export interface DisassociateDelegateFromResourceRequest {
1791
2048
  /**
1792
2049
  * @public
1793
- * <p>The identifier for the organization under which the resource exists.</p>
2050
+ * <p>The date when the mailbox was created for the user.</p>
1794
2051
  */
1795
- OrganizationId: string | undefined;
2052
+ MailboxProvisionedDate?: Date;
1796
2053
  /**
1797
2054
  * @public
1798
- * <p>The identifier of the resource from which delegates' set members are removed.
1799
- * </p>
2055
+ * <p>The date when the mailbox was removed for the user.</p>
1800
2056
  */
1801
- ResourceId: string | undefined;
2057
+ MailboxDeprovisionedDate?: Date;
1802
2058
  /**
1803
2059
  * @public
1804
- * <p>The identifier for the member (user, group) to be removed from the resource's
1805
- * delegates.</p>
2060
+ * <p>First name of the user.</p>
1806
2061
  */
1807
- EntityId: string | undefined;
1808
- }
1809
- /**
1810
- * @public
1811
- */
1812
- export interface DisassociateDelegateFromResourceResponse {
1813
- }
1814
- /**
1815
- * @public
1816
- */
2062
+ FirstName?: string;
2063
+ /**
2064
+ * @public
2065
+ * <p>Last name of the user.</p>
2066
+ */
2067
+ LastName?: string;
2068
+ /**
2069
+ * @public
2070
+ * <p>If enabled, the user is hidden from the global address list.</p>
2071
+ */
2072
+ HiddenFromGlobalAddressList?: boolean;
2073
+ /**
2074
+ * @public
2075
+ * <p>Initials of the user.</p>
2076
+ */
2077
+ Initials?: string;
2078
+ /**
2079
+ * @public
2080
+ * <p>User's contact number.</p>
2081
+ */
2082
+ Telephone?: string;
2083
+ /**
2084
+ * @public
2085
+ * <p>Street where the user is located.</p>
2086
+ */
2087
+ Street?: string;
2088
+ /**
2089
+ * @public
2090
+ * <p>Job title of the user.</p>
2091
+ */
2092
+ JobTitle?: string;
2093
+ /**
2094
+ * @public
2095
+ * <p>City where the user is located.</p>
2096
+ */
2097
+ City?: string;
2098
+ /**
2099
+ * @public
2100
+ * <p>Company of the user.</p>
2101
+ */
2102
+ Company?: string;
2103
+ /**
2104
+ * @public
2105
+ * <p>Zip code of the user.</p>
2106
+ */
2107
+ ZipCode?: string;
2108
+ /**
2109
+ * @public
2110
+ * <p>Department of the user.</p>
2111
+ */
2112
+ Department?: string;
2113
+ /**
2114
+ * @public
2115
+ * <p>Country where the user is located.</p>
2116
+ */
2117
+ Country?: string;
2118
+ /**
2119
+ * @public
2120
+ * <p>Office where the user is located.</p>
2121
+ */
2122
+ Office?: string;
2123
+ }
2124
+ /**
2125
+ * @public
2126
+ */
2127
+ export interface DisassociateDelegateFromResourceRequest {
2128
+ /**
2129
+ * @public
2130
+ * <p>The identifier for the organization under which the resource exists.</p>
2131
+ */
2132
+ OrganizationId: string | undefined;
2133
+ /**
2134
+ * @public
2135
+ * <p>The identifier of the resource from which delegates' set members are removed.
2136
+ * </p>
2137
+ * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
2138
+ * <ul>
2139
+ * <li>
2140
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
2141
+ * </li>
2142
+ * <li>
2143
+ * <p>Email address: resource@domain.tld</p>
2144
+ * </li>
2145
+ * <li>
2146
+ * <p>Resource name: resource</p>
2147
+ * </li>
2148
+ * </ul>
2149
+ */
2150
+ ResourceId: string | undefined;
2151
+ /**
2152
+ * @public
2153
+ * <p>The identifier for the member (user, group) to be removed from the resource's
2154
+ * delegates.</p>
2155
+ * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
2156
+ * <ul>
2157
+ * <li>
2158
+ * <p>Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
2159
+ * </li>
2160
+ * <li>
2161
+ * <p>Email address: entity@domain.tld</p>
2162
+ * </li>
2163
+ * <li>
2164
+ * <p>Entity: entity</p>
2165
+ * </li>
2166
+ * </ul>
2167
+ */
2168
+ EntityId: string | undefined;
2169
+ }
2170
+ /**
2171
+ * @public
2172
+ */
2173
+ export interface DisassociateDelegateFromResourceResponse {
2174
+ }
2175
+ /**
2176
+ * @public
2177
+ */
1817
2178
  export interface DisassociateMemberFromGroupRequest {
1818
2179
  /**
1819
2180
  * @public
@@ -1823,11 +2184,35 @@ export interface DisassociateMemberFromGroupRequest {
1823
2184
  /**
1824
2185
  * @public
1825
2186
  * <p>The identifier for the group from which members are removed.</p>
2187
+ * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
2188
+ * <ul>
2189
+ * <li>
2190
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
2191
+ * </li>
2192
+ * <li>
2193
+ * <p>Email address: group@domain.tld</p>
2194
+ * </li>
2195
+ * <li>
2196
+ * <p>Group name: group</p>
2197
+ * </li>
2198
+ * </ul>
1826
2199
  */
1827
2200
  GroupId: string | undefined;
1828
2201
  /**
1829
2202
  * @public
1830
- * <p>The identifier for the member to be removed to the group.</p>
2203
+ * <p>The identifier for the member to be removed from the group.</p>
2204
+ * <p>The member ID can accept <i>UserID or GroupId</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
2205
+ * <ul>
2206
+ * <li>
2207
+ * <p>Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
2208
+ * </li>
2209
+ * <li>
2210
+ * <p>Email address: member@domain.tld</p>
2211
+ * </li>
2212
+ * <li>
2213
+ * <p>Member name: member</p>
2214
+ * </li>
2215
+ * </ul>
1831
2216
  */
1832
2217
  MemberId: string | undefined;
1833
2218
  }
@@ -2158,6 +2543,18 @@ export interface GetMailboxDetailsRequest {
2158
2543
  /**
2159
2544
  * @public
2160
2545
  * <p>The identifier for the user whose mailbox details are being requested.</p>
2546
+ * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
2547
+ * <ul>
2548
+ * <li>
2549
+ * <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
2550
+ * </li>
2551
+ * <li>
2552
+ * <p>Email address: user@domain.tld</p>
2553
+ * </li>
2554
+ * <li>
2555
+ * <p>User name: user</p>
2556
+ * </li>
2557
+ * </ul>
2161
2558
  */
2162
2559
  UserId: string | undefined;
2163
2560
  }
@@ -2389,6 +2786,22 @@ export interface Group {
2389
2786
  */
2390
2787
  DisabledDate?: Date;
2391
2788
  }
2789
+ /**
2790
+ * @public
2791
+ * <p>The identifier that contains the Group ID and name of a group.</p>
2792
+ */
2793
+ export interface GroupIdentifier {
2794
+ /**
2795
+ * @public
2796
+ * <p>Group ID that matched the group.</p>
2797
+ */
2798
+ GroupId?: string;
2799
+ /**
2800
+ * @public
2801
+ * <p>Group name that matched the group.</p>
2802
+ */
2803
+ GroupName?: string;
2804
+ }
2392
2805
  /**
2393
2806
  * @public
2394
2807
  * <p>An impersonation role for the given WorkMail organization.</p>
@@ -2598,6 +3011,18 @@ export interface ListGroupMembersRequest {
2598
3011
  * @public
2599
3012
  * <p>The identifier for the group to which the members (users or groups) are
2600
3013
  * associated.</p>
3014
+ * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
3015
+ * <ul>
3016
+ * <li>
3017
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
3018
+ * </li>
3019
+ * <li>
3020
+ * <p>Email address: group@domain.tld</p>
3021
+ * </li>
3022
+ * <li>
3023
+ * <p>Group name: group</p>
3024
+ * </li>
3025
+ * </ul>
2601
3026
  */
2602
3027
  GroupId: string | undefined;
2603
3028
  /**
@@ -2664,6 +3089,27 @@ export interface ListGroupMembersResponse {
2664
3089
  */
2665
3090
  NextToken?: string;
2666
3091
  }
3092
+ /**
3093
+ * @public
3094
+ * <p> Filtering options for <i>ListGroups</i> operation. This is only used as input to Operation.</p>
3095
+ */
3096
+ export interface ListGroupsFilters {
3097
+ /**
3098
+ * @public
3099
+ * <p>Filters only groups with the provided name prefix.</p>
3100
+ */
3101
+ NamePrefix?: string;
3102
+ /**
3103
+ * @public
3104
+ * <p>Filters only groups with the provided primary email prefix.</p>
3105
+ */
3106
+ PrimaryEmailPrefix?: string;
3107
+ /**
3108
+ * @public
3109
+ * <p>Filters only groups with the provided state.</p>
3110
+ */
3111
+ State?: EntityState | string;
3112
+ }
2667
3113
  /**
2668
3114
  * @public
2669
3115
  */
@@ -2684,6 +3130,11 @@ export interface ListGroupsRequest {
2684
3130
  * <p>The maximum number of results to return in a single call.</p>
2685
3131
  */
2686
3132
  MaxResults?: number;
3133
+ /**
3134
+ * @public
3135
+ * <p>Limit the search results based on the filter criteria. Only one filter per request is supported.</p>
3136
+ */
3137
+ Filters?: ListGroupsFilters;
2687
3138
  }
2688
3139
  /**
2689
3140
  * @public
@@ -2701,6 +3152,74 @@ export interface ListGroupsResponse {
2701
3152
  */
2702
3153
  NextToken?: string;
2703
3154
  }
3155
+ /**
3156
+ * @public
3157
+ * <p> Filtering options for <i>ListGroupsForEntity</i> operation. This is only used as input to Operation.</p>
3158
+ */
3159
+ export interface ListGroupsForEntityFilters {
3160
+ /**
3161
+ * @public
3162
+ * <p>Filters only group names that start with the provided name prefix.</p>
3163
+ */
3164
+ GroupNamePrefix?: string;
3165
+ }
3166
+ /**
3167
+ * @public
3168
+ */
3169
+ export interface ListGroupsForEntityRequest {
3170
+ /**
3171
+ * @public
3172
+ * <p>The identifier for the organization under which the entity exists.</p>
3173
+ */
3174
+ OrganizationId: string | undefined;
3175
+ /**
3176
+ * @public
3177
+ * <p>The identifier for the entity.</p>
3178
+ * <p>The entity ID can accept <i>UserId or GroupID</i>, <i>Username or Groupname</i>, or <i>email</i>.</p>
3179
+ * <ul>
3180
+ * <li>
3181
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
3182
+ * </li>
3183
+ * <li>
3184
+ * <p>Email address: entity@domain.tld</p>
3185
+ * </li>
3186
+ * <li>
3187
+ * <p>Entity name: entity</p>
3188
+ * </li>
3189
+ * </ul>
3190
+ */
3191
+ EntityId: string | undefined;
3192
+ /**
3193
+ * @public
3194
+ * <p>Limit the search results based on the filter criteria.</p>
3195
+ */
3196
+ Filters?: ListGroupsForEntityFilters;
3197
+ /**
3198
+ * @public
3199
+ * <p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p>
3200
+ */
3201
+ NextToken?: string;
3202
+ /**
3203
+ * @public
3204
+ * <p>The maximum number of results to return in a single call.</p>
3205
+ */
3206
+ MaxResults?: number;
3207
+ }
3208
+ /**
3209
+ * @public
3210
+ */
3211
+ export interface ListGroupsForEntityResponse {
3212
+ /**
3213
+ * @public
3214
+ * <p>The overview of groups in an organization.</p>
3215
+ */
3216
+ Groups?: GroupIdentifier[];
3217
+ /**
3218
+ * @public
3219
+ * <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>
3220
+ */
3221
+ NextToken?: string;
3222
+ }
2704
3223
  /**
2705
3224
  * @public
2706
3225
  */
@@ -2785,8 +3304,20 @@ export interface ListMailboxPermissionsRequest {
2785
3304
  OrganizationId: string | undefined;
2786
3305
  /**
2787
3306
  * @public
2788
- * <p>The identifier of the user, group, or resource for which to list mailbox
3307
+ * <p>The identifier of the user, or resource for which to list mailbox
2789
3308
  * permissions.</p>
3309
+ * <p>The entity ID can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>.</p>
3310
+ * <ul>
3311
+ * <li>
3312
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789</p>
3313
+ * </li>
3314
+ * <li>
3315
+ * <p>Email address: entity@domain.tld</p>
3316
+ * </li>
3317
+ * <li>
3318
+ * <p>Entity name: entity</p>
3319
+ * </li>
3320
+ * </ul>
2790
3321
  */
2791
3322
  EntityId: string | undefined;
2792
3323
  /**
@@ -3179,6 +3710,18 @@ export interface ListResourceDelegatesRequest {
3179
3710
  /**
3180
3711
  * @public
3181
3712
  * <p>The identifier for the resource whose delegates are listed.</p>
3713
+ * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
3714
+ * <ul>
3715
+ * <li>
3716
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
3717
+ * </li>
3718
+ * <li>
3719
+ * <p>Email address: resource@domain.tld</p>
3720
+ * </li>
3721
+ * <li>
3722
+ * <p>Resource name: resource</p>
3723
+ * </li>
3724
+ * </ul>
3182
3725
  */
3183
3726
  ResourceId: string | undefined;
3184
3727
  /**
@@ -3210,6 +3753,27 @@ export interface ListResourceDelegatesResponse {
3210
3753
  */
3211
3754
  NextToken?: string;
3212
3755
  }
3756
+ /**
3757
+ * @public
3758
+ * <p>Filtering options for <i>ListResources</i> operation. This is only used as input to Operation.</p>
3759
+ */
3760
+ export interface ListResourcesFilters {
3761
+ /**
3762
+ * @public
3763
+ * <p>Filters only resource that start with the entered name prefix .</p>
3764
+ */
3765
+ NamePrefix?: string;
3766
+ /**
3767
+ * @public
3768
+ * <p>Filters only resource with the provided primary email prefix.</p>
3769
+ */
3770
+ PrimaryEmailPrefix?: string;
3771
+ /**
3772
+ * @public
3773
+ * <p>Filters only resource with the provided state.</p>
3774
+ */
3775
+ State?: EntityState | string;
3776
+ }
3213
3777
  /**
3214
3778
  * @public
3215
3779
  */
@@ -3230,6 +3794,11 @@ export interface ListResourcesRequest {
3230
3794
  * <p>The maximum number of results to return in a single call.</p>
3231
3795
  */
3232
3796
  MaxResults?: number;
3797
+ /**
3798
+ * @public
3799
+ * <p>Limit the resource search results based on the filter criteria. You can only use one filter per request.</p>
3800
+ */
3801
+ Filters?: ListResourcesFilters;
3233
3802
  }
3234
3803
  /**
3235
3804
  * @public
@@ -3271,6 +3840,11 @@ export interface Resource {
3271
3840
  * <p>The date indicating when the resource was disabled from WorkMail use.</p>
3272
3841
  */
3273
3842
  DisabledDate?: Date;
3843
+ /**
3844
+ * @public
3845
+ * <p>Resource description.</p>
3846
+ */
3847
+ Description?: string;
3274
3848
  }
3275
3849
  /**
3276
3850
  * @public
@@ -3325,6 +3899,32 @@ export interface ListTagsForResourceResponse {
3325
3899
  */
3326
3900
  Tags?: Tag[];
3327
3901
  }
3902
+ /**
3903
+ * @public
3904
+ * <p> Filtering options for <i>ListUsers</i> operation. This is only used as input to Operation.</p>
3905
+ */
3906
+ export interface ListUsersFilters {
3907
+ /**
3908
+ * @public
3909
+ * <p>Filters only users with the provided username prefix.</p>
3910
+ */
3911
+ UsernamePrefix?: string;
3912
+ /**
3913
+ * @public
3914
+ * <p>Filters only users with the provided display name prefix.</p>
3915
+ */
3916
+ DisplayNamePrefix?: string;
3917
+ /**
3918
+ * @public
3919
+ * <p>Filters only users with the provided email prefix.</p>
3920
+ */
3921
+ PrimaryEmailPrefix?: string;
3922
+ /**
3923
+ * @public
3924
+ * <p>Filters only users with the provided state.</p>
3925
+ */
3926
+ State?: EntityState | string;
3927
+ }
3328
3928
  /**
3329
3929
  * @public
3330
3930
  */
@@ -3345,6 +3945,11 @@ export interface ListUsersRequest {
3345
3945
  * <p>The maximum number of results to return in a single call.</p>
3346
3946
  */
3347
3947
  MaxResults?: number;
3948
+ /**
3949
+ * @public
3950
+ * <p>Limit the user search results based on the filter criteria. You can only use one filter per request.</p>
3951
+ */
3952
+ Filters?: ListUsersFilters;
3348
3953
  }
3349
3954
  /**
3350
3955
  * @public
@@ -3539,14 +4144,38 @@ export interface PutMailboxPermissionsRequest {
3539
4144
  OrganizationId: string | undefined;
3540
4145
  /**
3541
4146
  * @public
3542
- * <p>The identifier of the user, group, or resource for which to update mailbox
4147
+ * <p>The identifier of the user or resource for which to update mailbox
3543
4148
  * permissions.</p>
4149
+ * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
4150
+ * <ul>
4151
+ * <li>
4152
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
4153
+ * </li>
4154
+ * <li>
4155
+ * <p>Email address: entity@domain.tld</p>
4156
+ * </li>
4157
+ * <li>
4158
+ * <p>Entity name: entity</p>
4159
+ * </li>
4160
+ * </ul>
3544
4161
  */
3545
4162
  EntityId: string | undefined;
3546
4163
  /**
3547
4164
  * @public
3548
4165
  * <p>The identifier of the user, group, or resource to which to grant the
3549
4166
  * permissions.</p>
4167
+ * <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p>
4168
+ * <ul>
4169
+ * <li>
4170
+ * <p>Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
4171
+ * </li>
4172
+ * <li>
4173
+ * <p>Email address: grantee@domain.tld</p>
4174
+ * </li>
4175
+ * <li>
4176
+ * <p>Grantee name: grantee</p>
4177
+ * </li>
4178
+ * </ul>
3550
4179
  */
3551
4180
  GranteeId: string | undefined;
3552
4181
  /**
@@ -3687,6 +4316,15 @@ export interface RegisterToWorkMailRequest {
3687
4316
  /**
3688
4317
  * @public
3689
4318
  * <p>The identifier for the user, group, or resource to be updated.</p>
4319
+ * <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
+ * <ul>
4321
+ * <li>
4322
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
4323
+ * </li>
4324
+ * <li>
4325
+ * <p>Entity name: entity</p>
4326
+ * </li>
4327
+ * </ul>
3690
4328
  */
3691
4329
  EntityId: string | undefined;
3692
4330
  /**
@@ -3743,6 +4381,19 @@ export interface StartMailboxExportJobRequest {
3743
4381
  /**
3744
4382
  * @public
3745
4383
  * <p>The identifier of the user or resource associated with the mailbox.</p>
4384
+ * <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
+ * <ul>
4386
+ * <li>
4387
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789
4388
+ * , or S-1-1-12-1234567890-123456789-123456789-1234</p>
4389
+ * </li>
4390
+ * <li>
4391
+ * <p>Email address: entity@domain.tld</p>
4392
+ * </li>
4393
+ * <li>
4394
+ * <p>Entity name: entity</p>
4395
+ * </li>
4396
+ * </ul>
3746
4397
  */
3747
4398
  EntityId: string | undefined;
3748
4399
  /**
@@ -3931,6 +4582,43 @@ export interface UpdateDefaultMailDomainRequest {
3931
4582
  */
3932
4583
  export interface UpdateDefaultMailDomainResponse {
3933
4584
  }
4585
+ /**
4586
+ * @public
4587
+ */
4588
+ export interface UpdateGroupRequest {
4589
+ /**
4590
+ * @public
4591
+ * <p>The identifier for the organization under which the group exists.</p>
4592
+ */
4593
+ OrganizationId: string | undefined;
4594
+ /**
4595
+ * @public
4596
+ * <p>The identifier for the group to be updated.</p>
4597
+ * <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p>
4598
+ * <ul>
4599
+ * <li>
4600
+ * <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
4601
+ * </li>
4602
+ * <li>
4603
+ * <p>Email address: group@domain.tld</p>
4604
+ * </li>
4605
+ * <li>
4606
+ * <p>Group name: group</p>
4607
+ * </li>
4608
+ * </ul>
4609
+ */
4610
+ GroupId: string | undefined;
4611
+ /**
4612
+ * @public
4613
+ * <p>If enabled, the group is hidden from the global address list.</p>
4614
+ */
4615
+ HiddenFromGlobalAddressList?: boolean;
4616
+ }
4617
+ /**
4618
+ * @public
4619
+ */
4620
+ export interface UpdateGroupResponse {
4621
+ }
3934
4622
  /**
3935
4623
  * @public
3936
4624
  */
@@ -3984,6 +4672,18 @@ export interface UpdateMailboxQuotaRequest {
3984
4672
  /**
3985
4673
  * @public
3986
4674
  * <p>The identifer for the user for whom to update the mailbox quota.</p>
4675
+ * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
4676
+ * <ul>
4677
+ * <li>
4678
+ * <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
4679
+ * </li>
4680
+ * <li>
4681
+ * <p>Email address: user@domain.tld</p>
4682
+ * </li>
4683
+ * <li>
4684
+ * <p>User name: user</p>
4685
+ * </li>
4686
+ * </ul>
3987
4687
  */
3988
4688
  UserId: string | undefined;
3989
4689
  /**
@@ -4084,6 +4784,18 @@ export interface UpdatePrimaryEmailAddressRequest {
4084
4784
  /**
4085
4785
  * @public
4086
4786
  * <p>The user, group, or resource to update.</p>
4787
+ * <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
+ * <ul>
4789
+ * <li>
4790
+ * <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p>
4791
+ * </li>
4792
+ * <li>
4793
+ * <p>Email address: entity@domain.tld</p>
4794
+ * </li>
4795
+ * <li>
4796
+ * <p>Entity name: entity</p>
4797
+ * </li>
4798
+ * </ul>
4087
4799
  */
4088
4800
  EntityId: string | undefined;
4089
4801
  /**
@@ -4110,6 +4822,18 @@ export interface UpdateResourceRequest {
4110
4822
  /**
4111
4823
  * @public
4112
4824
  * <p>The identifier of the resource to be updated.</p>
4825
+ * <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p>
4826
+ * <ul>
4827
+ * <li>
4828
+ * <p>Resource ID: r-0123456789a0123456789b0123456789</p>
4829
+ * </li>
4830
+ * <li>
4831
+ * <p>Email address: resource@domain.tld</p>
4832
+ * </li>
4833
+ * <li>
4834
+ * <p>Resource name: resource</p>
4835
+ * </li>
4836
+ * </ul>
4113
4837
  */
4114
4838
  ResourceId: string | undefined;
4115
4839
  /**
@@ -4122,12 +4846,135 @@ export interface UpdateResourceRequest {
4122
4846
  * <p>The resource's booking options to be updated.</p>
4123
4847
  */
4124
4848
  BookingOptions?: BookingOptions;
4849
+ /**
4850
+ * @public
4851
+ * <p>Updates the resource description.</p>
4852
+ */
4853
+ Description?: string;
4854
+ /**
4855
+ * @public
4856
+ * <p>Updates the resource type.</p>
4857
+ */
4858
+ Type?: ResourceType | string;
4859
+ /**
4860
+ * @public
4861
+ * <p>If enabled, the resource is hidden from the global address list.</p>
4862
+ */
4863
+ HiddenFromGlobalAddressList?: boolean;
4125
4864
  }
4126
4865
  /**
4127
4866
  * @public
4128
4867
  */
4129
4868
  export interface UpdateResourceResponse {
4130
4869
  }
4870
+ /**
4871
+ * @public
4872
+ */
4873
+ export interface UpdateUserRequest {
4874
+ /**
4875
+ * @public
4876
+ * <p>The identifier for the organization under which the user exists.</p>
4877
+ */
4878
+ OrganizationId: string | undefined;
4879
+ /**
4880
+ * @public
4881
+ * <p>The identifier for the user to be updated.</p>
4882
+ * <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p>
4883
+ * <ul>
4884
+ * <li>
4885
+ * <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p>
4886
+ * </li>
4887
+ * <li>
4888
+ * <p>Email address: user@domain.tld</p>
4889
+ * </li>
4890
+ * <li>
4891
+ * <p>User name: user</p>
4892
+ * </li>
4893
+ * </ul>
4894
+ */
4895
+ UserId: string | undefined;
4896
+ /**
4897
+ * @public
4898
+ * <p>Updates the user role.</p>
4899
+ * <p>You cannot pass <i>SYSTEM_USER</i> or <i>RESOURCE</i>.</p>
4900
+ */
4901
+ Role?: UserRole | string;
4902
+ /**
4903
+ * @public
4904
+ * <p>Updates the display name of the user.</p>
4905
+ */
4906
+ DisplayName?: string;
4907
+ /**
4908
+ * @public
4909
+ * <p>Updates the user's first name.</p>
4910
+ */
4911
+ FirstName?: string;
4912
+ /**
4913
+ * @public
4914
+ * <p>Updates the user's last name.</p>
4915
+ */
4916
+ LastName?: string;
4917
+ /**
4918
+ * @public
4919
+ * <p>If enabled, the user is hidden from the global address list.</p>
4920
+ */
4921
+ HiddenFromGlobalAddressList?: boolean;
4922
+ /**
4923
+ * @public
4924
+ * <p>Updates the user's initials.</p>
4925
+ */
4926
+ Initials?: string;
4927
+ /**
4928
+ * @public
4929
+ * <p>Updates the user's contact details.</p>
4930
+ */
4931
+ Telephone?: string;
4932
+ /**
4933
+ * @public
4934
+ * <p>Updates the user's street address.</p>
4935
+ */
4936
+ Street?: string;
4937
+ /**
4938
+ * @public
4939
+ * <p>Updates the user's job title.</p>
4940
+ */
4941
+ JobTitle?: string;
4942
+ /**
4943
+ * @public
4944
+ * <p>Updates the user's city.</p>
4945
+ */
4946
+ City?: string;
4947
+ /**
4948
+ * @public
4949
+ * <p>Updates the user's company.</p>
4950
+ */
4951
+ Company?: string;
4952
+ /**
4953
+ * @public
4954
+ * <p>Updates the user's zipcode.</p>
4955
+ */
4956
+ ZipCode?: string;
4957
+ /**
4958
+ * @public
4959
+ * <p>Updates the user's department.</p>
4960
+ */
4961
+ Department?: string;
4962
+ /**
4963
+ * @public
4964
+ * <p>Updates the user's country.</p>
4965
+ */
4966
+ Country?: string;
4967
+ /**
4968
+ * @public
4969
+ * <p>Updates the user's office.</p>
4970
+ */
4971
+ Office?: string;
4972
+ }
4973
+ /**
4974
+ * @public
4975
+ */
4976
+ export interface UpdateUserResponse {
4977
+ }
4131
4978
  /**
4132
4979
  * @internal
4133
4980
  */
@@ -4140,6 +4987,18 @@ export declare const CreateAvailabilityConfigurationRequestFilterSensitiveLog: (
4140
4987
  * @internal
4141
4988
  */
4142
4989
  export declare const CreateUserRequestFilterSensitiveLog: (obj: CreateUserRequest) => any;
4990
+ /**
4991
+ * @internal
4992
+ */
4993
+ export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
4994
+ /**
4995
+ * @internal
4996
+ */
4997
+ export declare const ListUsersFiltersFilterSensitiveLog: (obj: ListUsersFilters) => any;
4998
+ /**
4999
+ * @internal
5000
+ */
5001
+ export declare const ListUsersRequestFilterSensitiveLog: (obj: ListUsersRequest) => any;
4143
5002
  /**
4144
5003
  * @internal
4145
5004
  */
@@ -4156,3 +5015,7 @@ export declare const TestAvailabilityConfigurationRequestFilterSensitiveLog: (ob
4156
5015
  * @internal
4157
5016
  */
4158
5017
  export declare const UpdateAvailabilityConfigurationRequestFilterSensitiveLog: (obj: UpdateAvailabilityConfigurationRequest) => any;
5018
+ /**
5019
+ * @internal
5020
+ */
5021
+ export declare const UpdateUserRequestFilterSensitiveLog: (obj: UpdateUserRequest) => any;