@aws-sdk/client-customer-profiles 3.370.0 → 3.377.0

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

@@ -28,7 +28,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
  *          <p>After a domain is created, the name can’t be changed.</p>
  *          <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to
  *          enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
- *             resolution</a>: set <code>Matching</code> to true. </p>
+ *             resolution</a>: set <code>Matching</code> to true.</p>
  *          <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
  *          apply. </p>
  *          <p>To add or remove tags on an existing Domain, 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>
@@ -71,6 +71,40 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
  *       },
  *     },
  *   },
+ *   RuleBasedMatching: { // RuleBasedMatchingRequest
+ *     Enabled: true || false, // required
+ *     MatchingRules: [ // MatchingRules
+ *       { // MatchingRule
+ *         Rule: [ // MatchingRuleAttributeList // required
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     ],
+ *     MaxAllowedRuleLevelForMerging: Number("int"),
+ *     MaxAllowedRuleLevelForMatching: Number("int"),
+ *     AttributeTypesSelector: { // AttributeTypesSelector
+ *       AttributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ *       Address: [ // AddressList
+ *         "STRING_VALUE",
+ *       ],
+ *       PhoneNumber: [ // PhoneNumberList
+ *         "STRING_VALUE",
+ *       ],
+ *       EmailAddress: [ // EmailList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *     ConflictResolution: {
+ *       ConflictResolvingModel: "RECENCY" || "SOURCE", // required
+ *       SourceName: "STRING_VALUE",
+ *     },
+ *     ExportingConfig: {
+ *       S3Exporting: {
+ *         S3BucketName: "STRING_VALUE", // required
+ *         S3KeyName: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
  *   Tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
@@ -110,6 +144,41 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
  * //       },
  * //     },
  * //   },
+ * //   RuleBasedMatching: { // RuleBasedMatchingResponse
+ * //     Enabled: true || false,
+ * //     MatchingRules: [ // MatchingRules
+ * //       { // MatchingRule
+ * //         Rule: [ // MatchingRuleAttributeList // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     ],
+ * //     Status: "PENDING" || "IN_PROGRESS" || "ACTIVE",
+ * //     MaxAllowedRuleLevelForMerging: Number("int"),
+ * //     MaxAllowedRuleLevelForMatching: Number("int"),
+ * //     AttributeTypesSelector: { // AttributeTypesSelector
+ * //       AttributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ * //       Address: [ // AddressList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       PhoneNumber: [ // PhoneNumberList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       EmailAddress: [ // EmailList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     ConflictResolution: {
+ * //       ConflictResolvingModel: "RECENCY" || "SOURCE", // required
+ * //       SourceName: "STRING_VALUE",
+ * //     },
+ * //     ExportingConfig: {
+ * //       S3Exporting: {
+ * //         S3BucketName: "STRING_VALUE", // required
+ * //         S3KeyName: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
  * //   CreatedAt: new Date("TIMESTAMP"), // required
  * //   LastUpdatedAt: new Date("TIMESTAMP"), // required
  * //   Tags: { // TagMap

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

@@ -23,6 +23,7 @@ export * from "./GetIntegrationCommand";
 export * from "./GetMatchesCommand";
 export * from "./GetProfileObjectTypeCommand";
 export * from "./GetProfileObjectTypeTemplateCommand";
+export * from "./GetSimilarProfilesCommand";
 export * from "./GetWorkflowCommand";
 export * from "./GetWorkflowStepsCommand";
 export * from "./ListAccountIntegrationsCommand";
@@ -35,6 +36,7 @@ export * from "./ListIntegrationsCommand";
 export * from "./ListProfileObjectTypeTemplatesCommand";
 export * from "./ListProfileObjectTypesCommand";
 export * from "./ListProfileObjectsCommand";
+export * from "./ListRuleBasedMatchesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListWorkflowsCommand";
 export * from "./MergeProfilesCommand";

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

@@ -824,6 +824,105 @@ export interface AttributeDetails {
      */
     Expression: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const AttributeMatchingModel: {
+    readonly MANY_TO_MANY: "MANY_TO_MANY";
+    readonly ONE_TO_ONE: "ONE_TO_ONE";
+};
+/**
+ * @public
+ */
+export type AttributeMatchingModel = (typeof AttributeMatchingModel)[keyof typeof AttributeMatchingModel];
+/**
+ * @public
+ * <p>Configuration information about the <code>AttributeTypesSelector </code>where the
+ *          rule-based identity resolution uses to match profiles. You can choose how profiles are
+ *          compared across attribute types and which attribute to use for matching from each type.
+ *          There are three attribute types you can configure:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Email type</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>You can choose from <code>Email</code>, <code>BusinessEmail</code>, and
+ *                         <code>PersonalEmail</code>
+ *                      </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Phone number type</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>You can choose from <code>Phone</code>, <code>HomePhone</code>, and
+ *                         <code>MobilePhone</code>
+ *                      </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>Address type</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>You can choose from <code>Address</code>, <code>BusinessAddress</code>,
+ *                         <code>MaillingAddress</code>, and <code>ShippingAddress</code>
+ *                      </p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ *          <p>You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the
+ *             <code>AttributeMatchingModel</code>. When choosing <code>MANY_TO_MANY</code>, the system
+ *          can match attribute across the sub-types of an attribute type. For example, if the value of
+ *          the <code>Email</code> field of Profile A and the value of <code>BusinessEmail</code> field
+ *          of Profile B matches, the two profiles are matched on the Email type. When choosing
+ *             <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches.
+ *          For example, only when the value of the <code>Email</code> field of Profile A and the value
+ *          of the <code>Email</code> field of Profile B matches, the two profiles are matched on the
+ *          Email type.</p>
+ */
+export interface AttributeTypesSelector {
+    /**
+     * <p>Configures the <code>AttributeMatchingModel</code>, you can either choose <code>ONE_TO_ONE</code> or
+     *          <code>MANY_TO_MANY</code>.</p>
+     */
+    AttributeMatchingModel: AttributeMatchingModel | string | undefined;
+    /**
+     * <p>The <code>Address</code> type. You can choose from <code>Address</code>,
+     *             <code>BusinessAddress</code>, <code>MaillingAddress</code>, and
+     *             <code>ShippingAddress</code>.</p>
+     *          <p>You only can use the Address type in the <code>MatchingRule</code>. For example, if you
+     *          want to match profile based on <code>BusinessAddress.City</code> or
+     *             <code>MaillingAddress.City</code>, you need to choose the <code>BusinessAddress</code>
+     *          and the <code>MaillingAddress</code> to represent the Address type and specify the
+     *             <code>Address.City</code> on the matching rule.</p>
+     */
+    Address?: string[];
+    /**
+     * <p>The <code>PhoneNumber</code> type. You can choose from <code>PhoneNumber</code>,
+     *             <code>HomePhoneNumber</code>, and <code>MobilePhoneNumber</code>.</p>
+     *          <p>You only can use the <code>PhoneNumber</code> type in the <code>MatchingRule</code>. For
+     *          example, if you want to match a profile based on <code>Phone</code> or
+     *             <code>HomePhone</code>, you need to choose the <code>Phone</code> and the
+     *             <code>HomePhone</code> to represent the <code>PhoneNumber</code> type and only specify
+     *          the <code>PhoneNumber</code> on the matching rule.</p>
+     */
+    PhoneNumber?: string[];
+    /**
+     * <p>The <code>Email</code> type. You can choose from <code>EmailAddress</code>,
+     *             <code>BusinessEmailAddress</code> and <code>PersonalEmailAddress</code>.</p>
+     *          <p>You only can use the <code>EmailAddress</code> type in the <code>MatchingRule</code>.
+     *          For example, if you want to match profile based on <code>PersonalEmailAddress</code> or
+     *             <code>BusinessEmailAddress</code>, you need to choose the
+     *             <code>PersonalEmailAddress</code> and the <code>BusinessEmailAddress</code> to represent
+     *          the <code>EmailAddress</code> type and only specify the <code>EmailAddress</code> on the
+     *          matching rule.</p>
+     */
+    EmailAddress?: string[];
+}
 /**
  * @public
  * @enum
@@ -1204,6 +1303,115 @@ export interface MatchingRequest {
      */
     ExportingConfig?: ExportingConfig;
 }
+/**
+ * @public
+ * <p>Specifies how does the rule-based matching process should match profiles. You can choose
+ *          from the following attributes to build the matching Rule:</p>
+ *          <ul>
+ *             <li>
+ *                <p>AccountNumber</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.Address</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.City</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.Country</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.County</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.PostalCode</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.State</p>
+ *             </li>
+ *             <li>
+ *                <p>Address.Province</p>
+ *             </li>
+ *             <li>
+ *                <p>BirthDate</p>
+ *             </li>
+ *             <li>
+ *                <p>BusinessName</p>
+ *             </li>
+ *             <li>
+ *                <p>EmailAddress</p>
+ *             </li>
+ *             <li>
+ *                <p>FirstName</p>
+ *             </li>
+ *             <li>
+ *                <p>Gender</p>
+ *             </li>
+ *             <li>
+ *                <p>LastName</p>
+ *             </li>
+ *             <li>
+ *                <p>MiddleName</p>
+ *             </li>
+ *             <li>
+ *                <p>PhoneNumber</p>
+ *             </li>
+ *             <li>
+ *                <p>Any customized profile attributes that start with the <code>Attributes</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ */
+export interface MatchingRule {
+    /**
+     * <p>A single rule level of the <code>MatchRules</code>. Configures how the rule-based
+     *          matching process should match profiles.</p>
+     */
+    Rule: string[] | undefined;
+}
+/**
+ * @public
+ * <p>The request to enable the rule-based matching.</p>
+ */
+export interface RuleBasedMatchingRequest {
+    /**
+     * <p>The flag that enables the rule-based matching process of duplicate profiles.</p>
+     */
+    Enabled: boolean | undefined;
+    /**
+     * <p>Configures how the rule-based matching process should match profiles. You can have up to 15
+     *          <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
+     */
+    MatchingRules?: MatchingRule[];
+    /**
+     * <p>
+     *             <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a>
+     *          </p>
+     */
+    MaxAllowedRuleLevelForMerging?: number;
+    /**
+     * <p>Indicates the maximum allowed rule level.</p>
+     */
+    MaxAllowedRuleLevelForMatching?: number;
+    /**
+     * <p>Configures information about the <code>AttributeTypesSelector</code> where the
+     *          rule-based identity resolution uses to match profiles.</p>
+     */
+    AttributeTypesSelector?: AttributeTypesSelector;
+    /**
+     * <p>How the auto-merging process should resolve conflicts between different profiles.</p>
+     */
+    ConflictResolution?: ConflictResolution;
+    /**
+     * <p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>
+     *          <note>
+     *             <p>You need to give Customer Profiles service principal write permission to your S3 bucket.
+     *             Otherwise, you'll get an exception in the API response. For an example policy, see
+     *                <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service">Amazon Connect Customer Profiles cross-service confused deputy prevention</a>. </p>
+     *          </note>
+     */
+    ExportingConfig?: ExportingConfig;
+}
 /**
  * @public
  */
@@ -1239,6 +1447,14 @@ export interface CreateDomainRequest {
      * S3.</p>
      */
     Matching?: MatchingRequest;
+    /**
+     * <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
+     *          Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
+     *          in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
+     *          review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can
+     *          download the results from S3.</p>
+     */
+    RuleBasedMatching?: RuleBasedMatchingRequest;
     /**
      * <p>The tags used to organize, track, or control access for this resource.</p>
      */
@@ -1267,6 +1483,89 @@ export interface MatchingResponse {
      */
     ExportingConfig?: ExportingConfig;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleBasedMatchingStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly PENDING: "PENDING";
+};
+/**
+ * @public
+ */
+export type RuleBasedMatchingStatus = (typeof RuleBasedMatchingStatus)[keyof typeof RuleBasedMatchingStatus];
+/**
+ * @public
+ * <p>The response of the Rule-based matching request.</p>
+ */
+export interface RuleBasedMatchingResponse {
+    /**
+     * <p>The flag that enables the rule-based matching process of duplicate profiles.</p>
+     */
+    Enabled?: boolean;
+    /**
+     * <p>Configures how the rule-based matching process should match profiles. You can have up to 15
+     *          <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
+     */
+    MatchingRules?: MatchingRule[];
+    /**
+     * <p>PENDING</p>
+     *          <ul>
+     *             <li>
+     *                <p>The first status after configuration a rule-based matching rule. If it is an
+     *                existing domain, the rule-based Identity Resolution waits one hour before creating the matching
+     *                rule. If it is a new domain, the system will skip the <code>PENDING</code>
+     *                stage.</p>
+     *             </li>
+     *          </ul>
+     *          <p>IN_PROGRESS</p>
+     *          <ul>
+     *             <li>
+     *                <p>The system is creating the rule-based matching rule. Under this status, the system
+     *                is evaluating the existing data and you can no longer change the Rule-based matching
+     *                configuration.</p>
+     *             </li>
+     *          </ul>
+     *          <p>ACTIVE</p>
+     *          <ul>
+     *             <li>
+     *                <p>The rule is ready to use. You can change the rule a day after the status is in
+     *                   <code>ACTIVE</code>.</p>
+     *             </li>
+     *          </ul>
+     */
+    Status?: RuleBasedMatchingStatus | string;
+    /**
+     * <p>
+     *             <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a>
+     *          </p>
+     */
+    MaxAllowedRuleLevelForMerging?: number;
+    /**
+     * <p>Indicates the maximum allowed rule level.</p>
+     */
+    MaxAllowedRuleLevelForMatching?: number;
+    /**
+     * <p>Configures information about the <code>AttributeTypesSelector</code> where the
+     *          rule-based identity resolution uses to match profiles.</p>
+     */
+    AttributeTypesSelector?: AttributeTypesSelector;
+    /**
+     * <p>How the auto-merging process should resolve conflicts between different profiles.</p>
+     */
+    ConflictResolution?: ConflictResolution;
+    /**
+     * <p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>
+     *          <note>
+     *             <p>You need to give Customer Profiles service principal write permission to your S3 bucket.
+     *             Otherwise, you'll get an exception in the API response. For an example policy, see
+     *                <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service">Amazon Connect Customer Profiles cross-service confused deputy prevention</a>. </p>
+     *          </note>
+     */
+    ExportingConfig?: ExportingConfig;
+}
 /**
  * @public
  */
@@ -1300,6 +1599,14 @@ export interface CreateDomainResponse {
      * S3.</p>
      */
     Matching?: MatchingResponse;
+    /**
+     * <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
+     *          Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
+     *          in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
+     *          review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can
+     *          download the results from S3.</p>
+     */
+    RuleBasedMatching?: RuleBasedMatchingResponse;
     /**
      * <p>The timestamp of when the domain was created.</p>
      */
@@ -1957,6 +2264,14 @@ export interface GetDomainResponse {
      * S3.</p>
      */
     Matching?: MatchingResponse;
+    /**
+     * <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true,
+     *          Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration
+     *          in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and
+     *          review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can
+     *          download the results from S3.</p>
+     */
+    RuleBasedMatching?: RuleBasedMatchingResponse;
     /**
      * <p>The timestamp of when the domain was created.</p>
      */
@@ -2533,6 +2848,83 @@ export interface GetProfileObjectTypeTemplateResponse {
      */
     Keys?: Record<string, ObjectTypeKey[]>;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const MatchType: {
+    readonly ML_BASED_MATCHING: "ML_BASED_MATCHING";
+    readonly RULE_BASED_MATCHING: "RULE_BASED_MATCHING";
+};
+/**
+ * @public
+ */
+export type MatchType = (typeof MatchType)[keyof typeof MatchType];
+/**
+ * @public
+ */
+export interface GetSimilarProfilesRequest {
+    /**
+     * <p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum number of objects returned per page.</p>
+     */
+    MaxResults?: number;
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>Specify the type of matching to get similar profiles for.</p>
+     */
+    MatchType: MatchType | string | undefined;
+    /**
+     * <p>The string indicating the search key to be used.</p>
+     */
+    SearchKey: string | undefined;
+    /**
+     * <p>The string based on <code>SearchKey</code> to be searched for similar profiles.</p>
+     */
+    SearchValue: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetSimilarProfilesResponse {
+    /**
+     * <p>Set of <code>profileId</code>s that belong to the same matching group.</p>
+     */
+    ProfileIds?: string[];
+    /**
+     * <p>The string <code>matchId</code> that the similar profiles belong to.</p>
+     */
+    MatchId?: string;
+    /**
+     * <p>Specify the type of matching to get similar profiles for.</p>
+     */
+    MatchType?: MatchType | string;
+    /**
+     * <p>The integer rule level that the profiles matched on.</p>
+     */
+    RuleLevel?: number;
+    /**
+     * <p>It only has value when the <code>MatchType</code> is <code>ML_BASED_MATCHING</code>.A
+     *          number between 0 and 1, where a higher score means higher similarity. Examining match
+     *          confidence scores lets you distinguish between groups of similar records in which the
+     *          system is highly confident (which you may decide to merge), groups of similar records about
+     *          which the system is uncertain (which you may decide to have reviewed by a human), and
+     *          groups of similar records that the system deems to be unlikely (which you may decide to
+     *          reject). Given confidence scores vary as per the data input, it should not be used as an
+     *          absolute measure of matching quality.</p>
+     */
+    ConfidenceScore?: number;
+    /**
+     * <p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>
+     */
+    NextToken?: string;
+}
 /**
  * @public
  */
@@ -3249,6 +3641,38 @@ export interface ListProfileObjectTypeTemplatesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListRuleBasedMatchesRequest {
+    /**
+     * <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
+     *          call.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum number of <code>MatchIds</code> returned per page.</p>
+     */
+    MaxResults?: number;
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRuleBasedMatchesResponse {
+    /**
+     * <p>The list of <code>MatchIds</code> for the given domain.</p>
+     */
+    MatchIds?: string[];
+    /**
+     * <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API
+     *          call.</p>
+     */
+    NextToken?: string;
+}
 /**
  * @public
  */
@@ -4058,6 +4482,16 @@ export interface UpdateDomainRequest {
      * S3.</p>
      */
     Matching?: MatchingRequest;
+    /**
+     * <p>The process of matching duplicate profiles using the rule-Based matching. If
+     *             <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
+     *          to match and merge your profiles according to your configuration in the
+     *             <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
+     *          and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
+     *          configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
+     *          can download the results from S3.</p>
+     */
+    RuleBasedMatching?: RuleBasedMatchingRequest;
     /**
      * <p>The tags used to organize, track, or control access for this resource.</p>
      */
@@ -4096,6 +4530,16 @@ export interface UpdateDomainResponse {
      * S3.</p>
      */
     Matching?: MatchingResponse;
+    /**
+     * <p>The process of matching duplicate profiles using the rule-Based matching. If
+     *             <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
+     *          to match and merge your profiles according to your configuration in the
+     *             <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
+     *          and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
+     *          configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
+     *          can download the results from S3.</p>
+     */
+    RuleBasedMatching?: RuleBasedMatchingResponse;
     /**
      * <p>The timestamp of when the domain was created.</p>
      */

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -25,6 +25,7 @@ import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "../comm
 import { GetMatchesCommandInput, GetMatchesCommandOutput } from "../commands/GetMatchesCommand";
 import { GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput } from "../commands/GetProfileObjectTypeCommand";
 import { GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput } from "../commands/GetProfileObjectTypeTemplateCommand";
+import { GetSimilarProfilesCommandInput, GetSimilarProfilesCommandOutput } from "../commands/GetSimilarProfilesCommand";
 import { GetWorkflowCommandInput, GetWorkflowCommandOutput } from "../commands/GetWorkflowCommand";
 import { GetWorkflowStepsCommandInput, GetWorkflowStepsCommandOutput } from "../commands/GetWorkflowStepsCommand";
 import { ListAccountIntegrationsCommandInput, ListAccountIntegrationsCommandOutput } from "../commands/ListAccountIntegrationsCommand";
@@ -37,6 +38,7 @@ import { ListIntegrationsCommandInput, ListIntegrationsCommandOutput } from "../
 import { ListProfileObjectsCommandInput, ListProfileObjectsCommandOutput } from "../commands/ListProfileObjectsCommand";
 import { ListProfileObjectTypesCommandInput, ListProfileObjectTypesCommandOutput } from "../commands/ListProfileObjectTypesCommand";
 import { ListProfileObjectTypeTemplatesCommandInput, ListProfileObjectTypeTemplatesCommandOutput } from "../commands/ListProfileObjectTypeTemplatesCommand";
+import { ListRuleBasedMatchesCommandInput, ListRuleBasedMatchesCommandOutput } from "../commands/ListRuleBasedMatchesCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
 import { ListWorkflowsCommandInput, ListWorkflowsCommandOutput } from "../commands/ListWorkflowsCommand";
 import { MergeProfilesCommandInput, MergeProfilesCommandOutput } from "../commands/MergeProfilesCommand";
@@ -149,6 +151,10 @@ export declare const se_GetProfileObjectTypeCommand: (input: GetProfileObjectTyp
  * serializeAws_restJson1GetProfileObjectTypeTemplateCommand
  */
 export declare const se_GetProfileObjectTypeTemplateCommand: (input: GetProfileObjectTypeTemplateCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetSimilarProfilesCommand
+ */
+export declare const se_GetSimilarProfilesCommand: (input: GetSimilarProfilesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetWorkflowCommand
  */
@@ -197,6 +203,10 @@ export declare const se_ListProfileObjectTypesCommand: (input: ListProfileObject
  * serializeAws_restJson1ListProfileObjectTypeTemplatesCommand
  */
 export declare const se_ListProfileObjectTypeTemplatesCommand: (input: ListProfileObjectTypeTemplatesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1ListRuleBasedMatchesCommand
+ */
+export declare const se_ListRuleBasedMatchesCommand: (input: ListRuleBasedMatchesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ListTagsForResourceCommand
  */
@@ -345,6 +355,10 @@ export declare const de_GetProfileObjectTypeCommand: (output: __HttpResponse, co
  * deserializeAws_restJson1GetProfileObjectTypeTemplateCommand
  */
 export declare const de_GetProfileObjectTypeTemplateCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetProfileObjectTypeTemplateCommandOutput>;
+/**
+ * deserializeAws_restJson1GetSimilarProfilesCommand
+ */
+export declare const de_GetSimilarProfilesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetSimilarProfilesCommandOutput>;
 /**
  * deserializeAws_restJson1GetWorkflowCommand
  */
@@ -393,6 +407,10 @@ export declare const de_ListProfileObjectTypesCommand: (output: __HttpResponse,
  * deserializeAws_restJson1ListProfileObjectTypeTemplatesCommand
  */
 export declare const de_ListProfileObjectTypeTemplatesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListProfileObjectTypeTemplatesCommandOutput>;
+/**
+ * deserializeAws_restJson1ListRuleBasedMatchesCommand
+ */
+export declare const de_ListRuleBasedMatchesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListRuleBasedMatchesCommandOutput>;
 /**
  * deserializeAws_restJson1ListTagsForResourceCommand
  */