@aws-sdk/client-workmail 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateDefaultMailDomainRequest, UpdateDefaultMailDomainResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateDefaultMailDomainCommand}.
  */
 export interface UpdateDefaultMailDomainCommandInput extends UpdateDefaultMailDomainRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDefaultMailDomainCommand}.
  */
 export interface UpdateDefaultMailDomainCommandOutput extends UpdateDefaultMailDomainResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateDefaultMailDomainCommandOutput extends UpdateDefaultMailD
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDefaultMailDomainCommandInput - {@link UpdateDefaultMailDomainCommandInput}
+ * @returns {@link UpdateDefaultMailDomainCommandOutput}
  * @see {@link UpdateDefaultMailDomainCommandInput} for command's `input` shape.
  * @see {@link UpdateDefaultMailDomainCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateDefaultMailDomainCommandOutput extends UpdateDefaultMailD
 export declare class UpdateDefaultMailDomainCommand extends $Command<UpdateDefaultMailDomainCommandInput, UpdateDefaultMailDomainCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdateDefaultMailDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDefaultMailDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDefaultMailDomainCommandInput, UpdateDefaultMailDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateImpersonationRoleRequest, UpdateImpersonationRoleResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateImpersonationRoleCommand}.
  */
 export interface UpdateImpersonationRoleCommandInput extends UpdateImpersonationRoleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateImpersonationRoleCommand}.
  */
 export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonationRoleResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an impersonation role for the given WorkMail organization.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonatio
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateImpersonationRoleCommandInput - {@link UpdateImpersonationRoleCommandInput}
+ * @returns {@link UpdateImpersonationRoleCommandOutput}
  * @see {@link UpdateImpersonationRoleCommandInput} for command's `input` shape.
  * @see {@link UpdateImpersonationRoleCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonatio
 export declare class UpdateImpersonationRoleCommand extends $Command<UpdateImpersonationRoleCommandInput, UpdateImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdateImpersonationRoleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateImpersonationRoleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateImpersonationRoleCommandInput, UpdateImpersonationRoleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateMailboxQuotaRequest, UpdateMailboxQuotaResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateMailboxQuotaCommand}.
  */
 export interface UpdateMailboxQuotaCommandInput extends UpdateMailboxQuotaRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateMailboxQuotaCommand}.
  */
 export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a user's current mailbox quota for a specified organization and
  *          user.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateMailboxQuotaCommandInput - {@link UpdateMailboxQuotaCommandInput}
+ * @returns {@link UpdateMailboxQuotaCommandOutput}
  * @see {@link UpdateMailboxQuotaCommandInput} for command's `input` shape.
  * @see {@link UpdateMailboxQuotaCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaRespo
 export declare class UpdateMailboxQuotaCommand extends $Command<UpdateMailboxQuotaCommandInput, UpdateMailboxQuotaCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdateMailboxQuotaCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateMailboxQuotaCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateMailboxQuotaCommandInput, UpdateMailboxQuotaCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateMobileDeviceAccessRuleRequest, UpdateMobileDeviceAccessRuleResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateMobileDeviceAccessRuleCommand}.
  */
 export interface UpdateMobileDeviceAccessRuleCommandInput extends UpdateMobileDeviceAccessRuleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateMobileDeviceAccessRuleCommand}.
  */
 export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileDeviceAccessRuleResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a mobile device access rule for the specified WorkMail organization.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileD
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateMobileDeviceAccessRuleCommandInput - {@link UpdateMobileDeviceAccessRuleCommandInput}
+ * @returns {@link UpdateMobileDeviceAccessRuleCommandOutput}
  * @see {@link UpdateMobileDeviceAccessRuleCommandInput} for command's `input` shape.
  * @see {@link UpdateMobileDeviceAccessRuleCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileD
 export declare class UpdateMobileDeviceAccessRuleCommand extends $Command<UpdateMobileDeviceAccessRuleCommandInput, UpdateMobileDeviceAccessRuleCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdateMobileDeviceAccessRuleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateMobileDeviceAccessRuleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateMobileDeviceAccessRuleCommandInput, UpdateMobileDeviceAccessRuleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdatePrimaryEmailAddressRequest, UpdatePrimaryEmailAddressResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdatePrimaryEmailAddressCommand}.
  */
 export interface UpdatePrimaryEmailAddressCommandInput extends UpdatePrimaryEmailAddressRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdatePrimaryEmailAddressCommand}.
  */
 export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEmailAddressResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the primary email for a user, group, or resource. The current email is moved
  *          into the list of aliases (or swapped between an existing alias and the current primary
  *          email), and the email provided in the input is promoted as the primary.</p>
@@ -27,6 +32,8 @@ export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEma
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdatePrimaryEmailAddressCommandInput - {@link UpdatePrimaryEmailAddressCommandInput}
+ * @returns {@link UpdatePrimaryEmailAddressCommandOutput}
  * @see {@link UpdatePrimaryEmailAddressCommandInput} for command's `input` shape.
  * @see {@link UpdatePrimaryEmailAddressCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -75,11 +82,20 @@ export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEma
 export declare class UpdatePrimaryEmailAddressCommand extends $Command<UpdatePrimaryEmailAddressCommandInput, UpdatePrimaryEmailAddressCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdatePrimaryEmailAddressCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdatePrimaryEmailAddressCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePrimaryEmailAddressCommandInput, UpdatePrimaryEmailAddressCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateResourceRequest, UpdateResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateResourceCommand}.
  */
 export interface UpdateResourceCommandInput extends UpdateResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateResourceCommand}.
  */
 export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates data for the resource. To have the latest information, it must be preceded by
  *          a <a>DescribeResource</a> call. The dataset in the request should be the one
  *          expected when performing another <code>DescribeResource</code> call.</p>
@@ -27,6 +32,8 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateResourceCommandInput - {@link UpdateResourceCommandInput}
+ * @returns {@link UpdateResourceCommandOutput}
  * @see {@link UpdateResourceCommandInput} for command's `input` shape.
  * @see {@link UpdateResourceCommandOutput} for command's `response` shape.
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
@@ -74,11 +81,20 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
 export declare class UpdateResourceCommand extends $Command<UpdateResourceCommandInput, UpdateResourceCommandOutput, WorkMailClientResolvedConfig> {
     readonly input: UpdateResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateResourceCommandInput, UpdateResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/WorkMailServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from WorkMail service.
  */
 export declare class WorkMailServiceException extends __ServiceException {