@aws-sdk/client-connect 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateTrafficDistributionRequest, UpdateTrafficDistributionResponse } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateTrafficDistributionCommand}.
  */
 export interface UpdateTrafficDistributionCommandInput extends UpdateTrafficDistributionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateTrafficDistributionCommand}.
  */
 export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDistributionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the traffic distribution for a given traffic distribution group. </p>
  *          <p>For more information about updating a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html">Update telephony
  *     traffic distribution across Amazon Web Services Regions
@@ -28,6 +33,8 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateTrafficDistributionCommandInput - {@link UpdateTrafficDistributionCommandInput}
+ * @returns {@link UpdateTrafficDistributionCommandOutput}
  * @see {@link UpdateTrafficDistributionCommandInput} for command's `input` shape.
  * @see {@link UpdateTrafficDistributionCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis
 export declare class UpdateTrafficDistributionCommand extends $Command<UpdateTrafficDistributionCommandInput, UpdateTrafficDistributionCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateTrafficDistributionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateTrafficDistributionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTrafficDistributionCommandInput, UpdateTrafficDistributionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserHierarchyRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserHierarchyCommand}.
  */
 export interface UpdateUserHierarchyCommandInput extends UpdateUserHierarchyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserHierarchyCommand}.
  */
 export interface UpdateUserHierarchyCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns the specified hierarchy group to the specified user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateUserHierarchyCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserHierarchyCommandInput - {@link UpdateUserHierarchyCommandInput}
+ * @returns {@link UpdateUserHierarchyCommandOutput}
  * @see {@link UpdateUserHierarchyCommandInput} for command's `input` shape.
  * @see {@link UpdateUserHierarchyCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateUserHierarchyCommandOutput extends __MetadataBearer {
 export declare class UpdateUserHierarchyCommand extends $Command<UpdateUserHierarchyCommandInput, UpdateUserHierarchyCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserHierarchyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserHierarchyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserHierarchyCommandInput, UpdateUserHierarchyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserHierarchyGroupNameRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserHierarchyGroupNameCommand}.
  */
 export interface UpdateUserHierarchyGroupNameCommandInput extends UpdateUserHierarchyGroupNameRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserHierarchyGroupNameCommand}.
  */
 export interface UpdateUserHierarchyGroupNameCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the name of the user hierarchy group. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateUserHierarchyGroupNameCommandOutput extends __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserHierarchyGroupNameCommandInput - {@link UpdateUserHierarchyGroupNameCommandInput}
+ * @returns {@link UpdateUserHierarchyGroupNameCommandOutput}
  * @see {@link UpdateUserHierarchyGroupNameCommandInput} for command's `input` shape.
  * @see {@link UpdateUserHierarchyGroupNameCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateUserHierarchyGroupNameCommandOutput extends __MetadataBea
 export declare class UpdateUserHierarchyGroupNameCommand extends $Command<UpdateUserHierarchyGroupNameCommandInput, UpdateUserHierarchyGroupNameCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserHierarchyGroupNameCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserHierarchyGroupNameCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserHierarchyGroupNameCommandInput, UpdateUserHierarchyGroupNameCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserHierarchyStructureRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserHierarchyStructureCommand}.
  */
 export interface UpdateUserHierarchyStructureCommandInput extends UpdateUserHierarchyStructureRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserHierarchyStructureCommand}.
  */
 export interface UpdateUserHierarchyStructureCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateUserHierarchyStructureCommandOutput extends __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserHierarchyStructureCommandInput - {@link UpdateUserHierarchyStructureCommandInput}
+ * @returns {@link UpdateUserHierarchyStructureCommandOutput}
  * @see {@link UpdateUserHierarchyStructureCommandInput} for command's `input` shape.
  * @see {@link UpdateUserHierarchyStructureCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateUserHierarchyStructureCommandOutput extends __MetadataBea
 export declare class UpdateUserHierarchyStructureCommand extends $Command<UpdateUserHierarchyStructureCommandInput, UpdateUserHierarchyStructureCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserHierarchyStructureCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserHierarchyStructureCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserHierarchyStructureCommandInput, UpdateUserHierarchyStructureCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserIdentityInfoRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserIdentityInfoCommand}.
  */
 export interface UpdateUserIdentityInfoCommandInput extends UpdateUserIdentityInfoRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserIdentityInfoCommand}.
  */
 export interface UpdateUserIdentityInfoCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the identity information for the specified user.</p>
  *          <important>
  *             <p>We strongly recommend limiting who has the ability to invoke
@@ -34,6 +39,8 @@ export interface UpdateUserIdentityInfoCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserIdentityInfoCommandInput - {@link UpdateUserIdentityInfoCommandInput}
+ * @returns {@link UpdateUserIdentityInfoCommandOutput}
  * @see {@link UpdateUserIdentityInfoCommandInput} for command's `input` shape.
  * @see {@link UpdateUserIdentityInfoCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -58,11 +65,20 @@ export interface UpdateUserIdentityInfoCommandOutput extends __MetadataBearer {
 export declare class UpdateUserIdentityInfoCommand extends $Command<UpdateUserIdentityInfoCommandInput, UpdateUserIdentityInfoCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserIdentityInfoCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserIdentityInfoCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserIdentityInfoCommandInput, UpdateUserIdentityInfoCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserRoutingProfileRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserRoutingProfileCommand}.
  */
 export interface UpdateUserRoutingProfileCommandInput extends UpdateUserRoutingProfileRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserRoutingProfileCommand}.
  */
 export interface UpdateUserRoutingProfileCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns the specified routing profile to the specified user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateUserRoutingProfileCommandOutput extends __MetadataBearer
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserRoutingProfileCommandInput - {@link UpdateUserRoutingProfileCommandInput}
+ * @returns {@link UpdateUserRoutingProfileCommandOutput}
  * @see {@link UpdateUserRoutingProfileCommandInput} for command's `input` shape.
  * @see {@link UpdateUserRoutingProfileCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateUserRoutingProfileCommandOutput extends __MetadataBearer
 export declare class UpdateUserRoutingProfileCommand extends $Command<UpdateUserRoutingProfileCommandInput, UpdateUserRoutingProfileCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserRoutingProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserRoutingProfileCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserRoutingProfileCommandInput, UpdateUserRoutingProfileCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { UpdateUserSecurityProfilesRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserSecurityProfilesCommand}.
  */
 export interface UpdateUserSecurityProfilesCommandInput extends UpdateUserSecurityProfilesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserSecurityProfilesCommand}.
  */
 export interface UpdateUserSecurityProfilesCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns the specified security profiles to the specified user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateUserSecurityProfilesCommandOutput extends __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserSecurityProfilesCommandInput - {@link UpdateUserSecurityProfilesCommandInput}
+ * @returns {@link UpdateUserSecurityProfilesCommandOutput}
  * @see {@link UpdateUserSecurityProfilesCommandInput} for command's `input` shape.
  * @see {@link UpdateUserSecurityProfilesCommandOutput} for command's `response` shape.
  * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateUserSecurityProfilesCommandOutput extends __MetadataBeare
 export declare class UpdateUserSecurityProfilesCommand extends $Command<UpdateUserSecurityProfilesCommandInput, UpdateUserSecurityProfilesCommandOutput, ConnectClientResolvedConfig> {
     readonly input: UpdateUserSecurityProfilesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserSecurityProfilesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserSecurityProfilesCommandInput, UpdateUserSecurityProfilesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/ConnectServiceException.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 Connect service.
  */
 export declare class ConnectServiceException extends __ServiceException {