@aws-sdk/client-workmail 3.413.0 → 3.415.0

package/dist-types/commands/UpdateUserCommand.d.ts

@@ -0,0 +1,117 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateUserRequest, UpdateUserResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateUserCommand}.
+ */
+export interface UpdateUserCommandInput extends UpdateUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateUserCommand}.
+ */
+export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates data for the user. To have the latest information, it must be preceded by a
+ *             <a>DescribeUser</a> call. The dataset in the request should be the one
+ *          expected when performing another <code>DescribeUser</code> call.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WorkMailClient, UpdateUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import
+ * // const { WorkMailClient, UpdateUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
+ * const client = new WorkMailClient(config);
+ * const input = { // UpdateUserRequest
+ *   OrganizationId: "STRING_VALUE", // required
+ *   UserId: "STRING_VALUE", // required
+ *   Role: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
+ *   DisplayName: "STRING_VALUE",
+ *   FirstName: "STRING_VALUE",
+ *   LastName: "STRING_VALUE",
+ *   HiddenFromGlobalAddressList: true || false,
+ *   Initials: "STRING_VALUE",
+ *   Telephone: "STRING_VALUE",
+ *   Street: "STRING_VALUE",
+ *   JobTitle: "STRING_VALUE",
+ *   City: "STRING_VALUE",
+ *   Company: "STRING_VALUE",
+ *   ZipCode: "STRING_VALUE",
+ *   Department: "STRING_VALUE",
+ *   Country: "STRING_VALUE",
+ *   Office: "STRING_VALUE",
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
+ * @see {@link UpdateUserCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserCommandOutput} for command's `response` shape.
+ * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
+ *
+ * @throws {@link DirectoryServiceAuthenticationFailedException} (client fault)
+ *  <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
+ *
+ * @throws {@link DirectoryUnavailableException} (client fault)
+ *  <p>The directory is unavailable. It might be located in another Region or deleted.</p>
+ *
+ * @throws {@link EntityNotFoundException} (client fault)
+ *  <p>The identifier supplied for the user, group, or resource does not exist in your
+ *          organization.</p>
+ *
+ * @throws {@link EntityStateException} (client fault)
+ *  <p>You are performing an operation on a user, group, or resource that isn't in the
+ *          expected state, such as trying to delete an active user.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link OrganizationNotFoundException} (client fault)
+ *  <p>An operation received a valid organization identifier that either doesn't belong or
+ *          exist in the system.</p>
+ *
+ * @throws {@link OrganizationStateException} (client fault)
+ *  <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>
+ *
+ */
+export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, WorkMailClientResolvedConfig> {
+    readonly input: UpdateUserCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateUserCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserCommandInput, UpdateUserCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -26,6 +26,7 @@ export * from "./DeleteUserCommand";
 export * from "./DeregisterFromWorkMailCommand";
 export * from "./DeregisterMailDomainCommand";
 export * from "./DescribeEmailMonitoringConfigurationCommand";
+export * from "./DescribeEntityCommand";
 export * from "./DescribeGroupCommand";
 export * from "./DescribeInboundDmarcSettingsCommand";
 export * from "./DescribeMailboxExportJobCommand";
@@ -47,6 +48,7 @@ export * from "./ListAliasesCommand";
 export * from "./ListAvailabilityConfigurationsCommand";
 export * from "./ListGroupMembersCommand";
 export * from "./ListGroupsCommand";
+export * from "./ListGroupsForEntityCommand";
 export * from "./ListImpersonationRolesCommand";
 export * from "./ListMailDomainsCommand";
 export * from "./ListMailboxExportJobsCommand";
@@ -73,8 +75,10 @@ export * from "./TestAvailabilityConfigurationCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAvailabilityConfigurationCommand";
 export * from "./UpdateDefaultMailDomainCommand";
+export * from "./UpdateGroupCommand";
 export * from "./UpdateImpersonationRoleCommand";
 export * from "./UpdateMailboxQuotaCommand";
 export * from "./UpdateMobileDeviceAccessRuleCommand";
 export * from "./UpdatePrimaryEmailAddressCommand";
 export * from "./UpdateResourceCommand";
+export * from "./UpdateUserCommand";

package/dist-types/extensionConfiguration.d.ts

@@ -1,7 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
 import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
 import { DefaultExtensionConfiguration } from "@smithy/types";
 /**
  * @internal
  */
-export interface WorkMailExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
+export interface WorkMailExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
 }