feat(client-workmail): This release includes four new APIs UpdateUser, UpdateGroup, ListGroupsForEntity and DescribeEntity, along with RemoteUsers and some enhancements to existing APIs.

Author: awstools

clients/client-workmail/README.md

@@ -461,6 +461,14 @@ DescribeEmailMonitoringConfiguration
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/describeemailmonitoringconfigurationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/describeemailmonitoringconfigurationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/describeemailmonitoringconfigurationcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DescribeEntity
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/describeentitycommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/describeentitycommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/describeentitycommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -629,6 +637,14 @@ ListGroups
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/listgroupscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/listgroupscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/listgroupscommandoutput.html)
 
+</details>
+<details>
+<summary>
+ListGroupsForEntity
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/listgroupsforentitycommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/listgroupsforentitycommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/listgroupsforentitycommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -837,6 +853,14 @@ UpdateDefaultMailDomain
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/updatedefaultmaildomaincommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updatedefaultmaildomaincommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updatedefaultmaildomaincommandoutput.html)
 
+</details>
+<details>
+<summary>
+UpdateGroup
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/updategroupcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updategroupcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updategroupcommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -878,3 +902,11 @@ UpdateResource
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/updateresourcecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updateresourcecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updateresourcecommandoutput.html)
 
 </details>
+<details>
+<summary>
+UpdateUser
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/classes/updateusercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updateusercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-workmail/interfaces/updateusercommandoutput.html)
+
+</details>

clients/client-workmail/src/WorkMail.ts

@@ -118,6 +118,11 @@ import {
   DescribeEmailMonitoringConfigurationCommandInput,
   DescribeEmailMonitoringConfigurationCommandOutput,
 } from "./commands/DescribeEmailMonitoringConfigurationCommand";
+import {
+  DescribeEntityCommand,
+  DescribeEntityCommandInput,
+  DescribeEntityCommandOutput,
+} from "./commands/DescribeEntityCommand";
 import {
   DescribeGroupCommand,
   DescribeGroupCommandInput,
@@ -215,6 +220,11 @@ import {
   ListGroupMembersCommandOutput,
 } from "./commands/ListGroupMembersCommand";
 import { ListGroupsCommand, ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand";
+import {
+  ListGroupsForEntityCommand,
+  ListGroupsForEntityCommandInput,
+  ListGroupsForEntityCommandOutput,
+} from "./commands/ListGroupsForEntityCommand";
 import {
   ListImpersonationRolesCommand,
   ListImpersonationRolesCommandInput,
@@ -337,6 +347,7 @@ import {
   UpdateDefaultMailDomainCommandInput,
   UpdateDefaultMailDomainCommandOutput,
 } from "./commands/UpdateDefaultMailDomainCommand";
+import { UpdateGroupCommand, UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
 import {
   UpdateImpersonationRoleCommand,
   UpdateImpersonationRoleCommandInput,
@@ -362,6 +373,7 @@ import {
   UpdateResourceCommandInput,
   UpdateResourceCommandOutput,
 } from "./commands/UpdateResourceCommand";
+import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { WorkMailClient, WorkMailClientConfig } from "./WorkMailClient";
 
 const commands = {
@@ -393,6 +405,7 @@ const commands = {
   DeregisterFromWorkMailCommand,
   DeregisterMailDomainCommand,
   DescribeEmailMonitoringConfigurationCommand,
+  DescribeEntityCommand,
   DescribeGroupCommand,
   DescribeInboundDmarcSettingsCommand,
   DescribeMailboxExportJobCommand,
@@ -414,6 +427,7 @@ const commands = {
   ListAvailabilityConfigurationsCommand,
   ListGroupMembersCommand,
   ListGroupsCommand,
+  ListGroupsForEntityCommand,
   ListImpersonationRolesCommand,
   ListMailboxExportJobsCommand,
   ListMailboxPermissionsCommand,
@@ -440,11 +454,13 @@ const commands = {
   UntagResourceCommand,
   UpdateAvailabilityConfigurationCommand,
   UpdateDefaultMailDomainCommand,
+  UpdateGroupCommand,
   UpdateImpersonationRoleCommand,
   UpdateMailboxQuotaCommand,
   UpdateMobileDeviceAccessRuleCommand,
   UpdatePrimaryEmailAddressCommand,
   UpdateResourceCommand,
+  UpdateUserCommand,
 };
 
 export interface WorkMail {
@@ -882,6 +898,20 @@ export interface WorkMail {
     cb: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeEntityCommand}
+   */
+  describeEntity(
+    args: DescribeEntityCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeEntityCommandOutput>;
+  describeEntity(args: DescribeEntityCommandInput, cb: (err: any, data?: DescribeEntityCommandOutput) => void): void;
+  describeEntity(
+    args: DescribeEntityCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeEntityCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeGroupCommand}
    */
@@ -1209,6 +1239,23 @@ export interface WorkMail {
     cb: (err: any, data?: ListGroupsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListGroupsForEntityCommand}
+   */
+  listGroupsForEntity(
+    args: ListGroupsForEntityCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListGroupsForEntityCommandOutput>;
+  listGroupsForEntity(
+    args: ListGroupsForEntityCommandInput,
+    cb: (err: any, data?: ListGroupsForEntityCommandOutput) => void
+  ): void;
+  listGroupsForEntity(
+    args: ListGroupsForEntityCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListGroupsForEntityCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListImpersonationRolesCommand}
    */
@@ -1618,6 +1665,17 @@ export interface WorkMail {
     cb: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateGroupCommand}
+   */
+  updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupCommandOutput>;
+  updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void;
+  updateGroup(
+    args: UpdateGroupCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateGroupCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateImpersonationRoleCommand}
    */
@@ -1699,6 +1757,17 @@ export interface WorkMail {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: UpdateResourceCommandOutput) => void
   ): void;
+
+  /**
+   * @see {@link UpdateUserCommand}
+   */
+  updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
+  updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
+  updateUser(
+    args: UpdateUserCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateUserCommandOutput) => void
+  ): void;
 }
 
 /**

clients/client-workmail/src/WorkMailClient.ts

@@ -132,6 +132,7 @@ import {
   DescribeEmailMonitoringConfigurationCommandInput,
   DescribeEmailMonitoringConfigurationCommandOutput,
 } from "./commands/DescribeEmailMonitoringConfigurationCommand";
+import { DescribeEntityCommandInput, DescribeEntityCommandOutput } from "./commands/DescribeEntityCommand";
 import { DescribeGroupCommandInput, DescribeGroupCommandOutput } from "./commands/DescribeGroupCommand";
 import {
   DescribeInboundDmarcSettingsCommandInput,
@@ -192,6 +193,10 @@ import {
 } from "./commands/ListAvailabilityConfigurationsCommand";
 import { ListGroupMembersCommandInput, ListGroupMembersCommandOutput } from "./commands/ListGroupMembersCommand";
 import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand";
+import {
+  ListGroupsForEntityCommandInput,
+  ListGroupsForEntityCommandOutput,
+} from "./commands/ListGroupsForEntityCommand";
 import {
   ListImpersonationRolesCommandInput,
   ListImpersonationRolesCommandOutput,
@@ -266,6 +271,7 @@ import {
   UpdateDefaultMailDomainCommandInput,
   UpdateDefaultMailDomainCommandOutput,
 } from "./commands/UpdateDefaultMailDomainCommand";
+import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
 import {
   UpdateImpersonationRoleCommandInput,
   UpdateImpersonationRoleCommandOutput,
@@ -280,6 +286,7 @@ import {
   UpdatePrimaryEmailAddressCommandOutput,
 } from "./commands/UpdatePrimaryEmailAddressCommand";
 import { UpdateResourceCommandInput, UpdateResourceCommandOutput } from "./commands/UpdateResourceCommand";
+import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -323,6 +330,7 @@ export type ServiceInputTypes =
   | DeregisterFromWorkMailCommandInput
   | DeregisterMailDomainCommandInput
   | DescribeEmailMonitoringConfigurationCommandInput
+  | DescribeEntityCommandInput
   | DescribeGroupCommandInput
   | DescribeInboundDmarcSettingsCommandInput
   | DescribeMailboxExportJobCommandInput
@@ -344,6 +352,7 @@ export type ServiceInputTypes =
   | ListAvailabilityConfigurationsCommandInput
   | ListGroupMembersCommandInput
   | ListGroupsCommandInput
+  | ListGroupsForEntityCommandInput
   | ListImpersonationRolesCommandInput
   | ListMailDomainsCommandInput
   | ListMailboxExportJobsCommandInput
@@ -370,11 +379,13 @@ export type ServiceInputTypes =
   | UntagResourceCommandInput
   | UpdateAvailabilityConfigurationCommandInput
   | UpdateDefaultMailDomainCommandInput
+  | UpdateGroupCommandInput
   | UpdateImpersonationRoleCommandInput
   | UpdateMailboxQuotaCommandInput
   | UpdateMobileDeviceAccessRuleCommandInput
   | UpdatePrimaryEmailAddressCommandInput
-  | UpdateResourceCommandInput;
+  | UpdateResourceCommandInput
+  | UpdateUserCommandInput;
 
 /**
  * @public
@@ -408,6 +419,7 @@ export type ServiceOutputTypes =
   | DeregisterFromWorkMailCommandOutput
   | DeregisterMailDomainCommandOutput
   | DescribeEmailMonitoringConfigurationCommandOutput
+  | DescribeEntityCommandOutput
   | DescribeGroupCommandOutput
   | DescribeInboundDmarcSettingsCommandOutput
   | DescribeMailboxExportJobCommandOutput
@@ -429,6 +441,7 @@ export type ServiceOutputTypes =
   | ListAvailabilityConfigurationsCommandOutput
   | ListGroupMembersCommandOutput
   | ListGroupsCommandOutput
+  | ListGroupsForEntityCommandOutput
   | ListImpersonationRolesCommandOutput
   | ListMailDomainsCommandOutput
   | ListMailboxExportJobsCommandOutput
@@ -455,11 +468,13 @@ export type ServiceOutputTypes =
   | UntagResourceCommandOutput
   | UpdateAvailabilityConfigurationCommandOutput
   | UpdateDefaultMailDomainCommandOutput
+  | UpdateGroupCommandOutput
   | UpdateImpersonationRoleCommandOutput
   | UpdateMailboxQuotaCommandOutput
   | UpdateMobileDeviceAccessRuleCommandOutput
   | UpdatePrimaryEmailAddressCommandOutput
-  | UpdateResourceCommandOutput;
+  | UpdateResourceCommandOutput
+  | UpdateUserCommandOutput;
 
 /**
  * @public

clients/client-workmail/src/commands/AssociateDelegateToResourceCommand.ts

@@ -81,6 +81,9 @@ export interface AssociateDelegateToResourceCommandOutput
  *  <p>The organization must have a valid state to perform certain
  *          operations on the organization or its members.</p>
  *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>You can't perform a write operation against a read-only directory.</p>
+ *
  * @throws {@link WorkMailServiceException}
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
  *

clients/client-workmail/src/commands/CreateGroupCommand.ts

@@ -46,6 +46,7 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
  * const input = { // CreateGroupRequest
  *   OrganizationId: "STRING_VALUE", // required
  *   Name: "STRING_VALUE", // required
+ *   HiddenFromGlobalAddressList: true || false,
  * };
  * const command = new CreateGroupCommand(input);
  * const response = await client.send(command);

clients/client-workmail/src/commands/CreateOrganizationCommand.ts

@@ -57,7 +57,7 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
  *   ClientToken: "STRING_VALUE",
  *   Domains: [ // Domains
  *     { // Domain
- *       DomainName: "STRING_VALUE",
+ *       DomainName: "STRING_VALUE", // required
  *       HostedZoneId: "STRING_VALUE",
  *     },
  *   ],

clients/client-workmail/src/commands/CreateResourceCommand.ts

@@ -47,6 +47,8 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
  *   OrganizationId: "STRING_VALUE", // required
  *   Name: "STRING_VALUE", // required
  *   Type: "ROOM" || "EQUIPMENT", // required
+ *   Description: "STRING_VALUE",
+ *   HiddenFromGlobalAddressList: true || false,
  * };
  * const command = new CreateResourceCommand(input);
  * const response = await client.send(command);
@@ -85,6 +87,9 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
  * @throws {@link ReservedNameException} (client fault)
  *  <p>This user, group, or resource name is not allowed in WorkMail.</p>
  *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>You can't perform a write operation against a read-only directory.</p>
+ *
  * @throws {@link WorkMailServiceException}
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
  *

clients/client-workmail/src/commands/CreateUserCommand.ts

@@ -47,7 +47,11 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  *   OrganizationId: "STRING_VALUE", // required
  *   Name: "STRING_VALUE", // required
  *   DisplayName: "STRING_VALUE", // required
- *   Password: "STRING_VALUE", // required
+ *   Password: "STRING_VALUE",
+ *   Role: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
+ *   FirstName: "STRING_VALUE",
+ *   LastName: "STRING_VALUE",
+ *   HiddenFromGlobalAddressList: true || false,
  * };
  * const command = new CreateUserCommand(input);
  * const response = await client.send(command);

clients/client-workmail/src/commands/DeleteOrganizationCommand.ts

@@ -47,6 +47,7 @@ export interface DeleteOrganizationCommandOutput extends DeleteOrganizationRespo
  *   ClientToken: "STRING_VALUE",
  *   OrganizationId: "STRING_VALUE", // required
  *   DeleteDirectory: true || false, // required
+ *   ForceDelete: true || false,
  * };
  * const command = new DeleteOrganizationCommand(input);
  * const response = await client.send(command);

clients/client-workmail/src/commands/DeleteResourceCommand.ts

@@ -74,6 +74,9 @@ export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __M
  *  <p>The organization must have a valid state to perform certain
  *          operations on the organization or its members.</p>
  *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>You can't perform a write operation against a read-only directory.</p>
+ *
  * @throws {@link WorkMailServiceException}
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
  *