@aws-sdk/client-customer-profiles 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { PutIntegrationRequest, PutIntegrationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutIntegrationCommand}.
  */
 export interface PutIntegrationCommandInput extends PutIntegrationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutIntegrationCommand}.
  */
 export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds an integration between the service and a third-party service, which includes
  *          Amazon AppFlow and Amazon Connect.</p>
  *          <p>An integration can belong to only one domain.</p>
@@ -30,6 +35,8 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param PutIntegrationCommandInput - {@link PutIntegrationCommandInput}
+ * @returns {@link PutIntegrationCommandOutput}
  * @see {@link PutIntegrationCommandInput} for command's `input` shape.
  * @see {@link PutIntegrationCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -54,11 +61,20 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M
 export declare class PutIntegrationCommand extends $Command<PutIntegrationCommandInput, PutIntegrationCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: PutIntegrationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutIntegrationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutIntegrationCommandInput, PutIntegrationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { PutProfileObjectRequest, PutProfileObjectResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutProfileObjectCommand}.
  */
 export interface PutProfileObjectCommandInput extends PutProfileObjectRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutProfileObjectCommand}.
  */
 export interface PutProfileObjectCommandOutput extends PutProfileObjectResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds additional objects to customer profiles of a given ObjectType.</p>
  *          <p>When adding a specific profile object, like a Contact Record, an inferred profile can
  *          get created if it is not mapped to an existing profile. The resulting profile will only
@@ -34,6 +39,8 @@ export interface PutProfileObjectCommandOutput extends PutProfileObjectResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param PutProfileObjectCommandInput - {@link PutProfileObjectCommandInput}
+ * @returns {@link PutProfileObjectCommandOutput}
  * @see {@link PutProfileObjectCommandInput} for command's `input` shape.
  * @see {@link PutProfileObjectCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -58,11 +65,20 @@ export interface PutProfileObjectCommandOutput extends PutProfileObjectResponse,
 export declare class PutProfileObjectCommand extends $Command<PutProfileObjectCommandInput, PutProfileObjectCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: PutProfileObjectCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutProfileObjectCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutProfileObjectCommandInput, PutProfileObjectCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { PutProfileObjectTypeRequest, PutProfileObjectTypeResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutProfileObjectTypeCommand}.
  */
 export interface PutProfileObjectTypeCommandInput extends PutProfileObjectTypeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutProfileObjectTypeCommand}.
  */
 export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Defines a ProfileObjectType.</p>
  *          <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
  *          TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
@@ -27,6 +32,8 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
  * const response = await client.send(command);
  * ```
  *
+ * @param PutProfileObjectTypeCommandInput - {@link PutProfileObjectTypeCommandInput}
+ * @returns {@link PutProfileObjectTypeCommandOutput}
  * @see {@link PutProfileObjectTypeCommandInput} for command's `input` shape.
  * @see {@link PutProfileObjectTypeCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -51,11 +58,20 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
 export declare class PutProfileObjectTypeCommand extends $Command<PutProfileObjectTypeCommandInput, PutProfileObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: PutProfileObjectTypeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutProfileObjectTypeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutProfileObjectTypeCommandInput, PutProfileObjectTypeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { SearchProfilesRequest, SearchProfilesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchProfilesCommand}.
  */
 export interface SearchProfilesCommandInput extends SearchProfilesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchProfilesCommand}.
  */
 export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Searches for profiles within a specific domain using one or more predefined search keys
  *          (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
  *          is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
@@ -29,6 +34,8 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchProfilesCommandInput - {@link SearchProfilesCommandInput}
+ * @returns {@link SearchProfilesCommandOutput}
  * @see {@link SearchProfilesCommandInput} for command's `input` shape.
  * @see {@link SearchProfilesCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -53,11 +60,20 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M
 export declare class SearchProfilesCommand extends $Command<SearchProfilesCommandInput, SearchProfilesCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: SearchProfilesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchProfilesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchProfilesCommandInput, SearchProfilesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles
  *          resource. Tags can help you organize and categorize your resources. You can also use them
  *          to scope user permissions by granting a user permission to access or change only resources
@@ -36,6 +41,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -54,11 +61,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect
  *          Customer Profiles, domains, profile object types, and integrations can be tagged.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -44,11 +51,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { UpdateDomainRequest, UpdateDomainResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateDomainCommand}.
  */
 export interface UpdateDomainCommandInput extends UpdateDomainRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDomainCommand}.
  */
 export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the properties of a domain, including creating or selecting a dead letter queue
  *          or an encryption key.</p>
  *          <p>After a domain is created, the name can’t be changed.</p>
@@ -33,6 +38,8 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDomainCommandInput - {@link UpdateDomainCommandInput}
+ * @returns {@link UpdateDomainCommandOutput}
  * @see {@link UpdateDomainCommandInput} for command's `input` shape.
  * @see {@link UpdateDomainCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
 export declare class UpdateDomainCommand extends $Command<UpdateDomainCommandInput, UpdateDomainCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: UpdateDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDomainCommandInput, UpdateDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
 import { UpdateProfileRequest, UpdateProfileResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateProfileCommand}.
  */
 export interface UpdateProfileCommandInput extends UpdateProfileRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateProfileCommand}.
  */
 export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the properties of a profile. The ProfileId is required for updating a customer
  *          profile.</p>
  *          <p>When calling the UpdateProfile API, specifying an empty string value means that any
@@ -29,6 +34,8 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateProfileCommandInput - {@link UpdateProfileCommandInput}
+ * @returns {@link UpdateProfileCommandOutput}
  * @see {@link UpdateProfileCommandInput} for command's `input` shape.
  * @see {@link UpdateProfileCommandOutput} for command's `response` shape.
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
 export declare class UpdateProfileCommand extends $Command<UpdateProfileCommandInput, UpdateProfileCommandOutput, CustomerProfilesClientResolvedConfig> {
     readonly input: UpdateProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateProfileCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateProfileCommandInput, UpdateProfileCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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