# Creating a rule-based matching workflow with the Simple rule type **Prerequisites** Before you create a rule-based matching workflow, you must: 1. Create a schema mapping. For more information, see [Creating a schema mapping](create-schema-mapping.md). 1. If using Connect Customer Customer Profiles as your output destination, ensure you have the appropriate permissions configured. The following procedure demonstrates how to create a rule-based matching workflow with the **Simple** rule type using either the AWS Entity Resolution Console or the `CreateMatchingWorkflow` API. ------ #### [ Console ] **To create a rule-based matching workflow with the **Simple** rule type using the console** 1. Sign in to the AWS Management Console and open the AWS Entity Resolution console at [https://console.aws.amazon.com/entityresolution/](https://console.aws.amazon.com/entityresolution/). 1. In the left navigation pane, under **Workflows**, choose **Matching**. 1. On the **Matching workflows** page, in the upper right corner, choose **Create matching workflow**. 1. For **Step 1: Specify matching workflow details**, do the following: 1. Enter a **Matching workflow name** and an optional **Description**. 1. For **Data input**, choose an **AWS Region**, **AWS Glue database**, the **AWS Glue table**, and then the corresponding **Schema mapping**. You can add up to 19 data inputs. 1. The **Normalize data** option is selected by default, so that data inputs are normalized before matching. If you don't want to normalize data, deselect the **Normalize data** option. **Note** Normalization is only supported for the following scenarios in **Create schema mapping**: If the following **Name** sub-types are grouped: **First name**, **Middle name**, **Last name**. If the following **Address** sub-types are grouped: **Street address 1**, **Street address 2**, **Street address 3**, **City**, **State**, **Country**, **Postal code**. If the following **Phone** sub-types are grouped: **Phone number**, **Phone country code**. 1. To specify the **Service access** permissions, choose an option and take the recommended action.
OptionRecommended action
Create and use a new service role
  • AWS Entity Resolution creates a service role with the required policy for this table.
  • The default Service role name is entityresolution-matching-workflow-<timestamp>.
  • You must have permissions to create roles and attach policies.
  • If your input data is encrypted, you can choose the This data is encrypted with a KMS key option and then enter an AWS KMS key that will be used to decrypt your data input.
Use an existing service role
  1. Choose an Existing service role name from the dropdown list.
    The list of roles are displayed if you have permissions to list roles.
    If you don't have permissions to list roles, you can enter the Amazon Resource Name (ARN) of the role that you want to use.
    If there are no existing service roles, the option to Use an existing service role is unavailable.
  2. View the service role by choosing the View in IAM external link.
    By default, AWS Entity Resolution doesn't attempt to update the existing role policy to add necessary permissions.
1. (Optional) To enable **Tags** for the resource, choose **Add new tag**, and then enter the **Key** and **Value** pair. 1. Choose **Next**. 1. For **Step 2: Choose matching technique**: 1. For **Matching method**, choose **Rule-based matching**. 1. For **Rule type**, choose **Simple**. ![Choose matching technique screen with the Simple rule-based matching option selected.](https://docs.aws.amazon.com/entityresolution/latest/userguide/images/choose-matching-method-rule-based-simple.PNG) 1. For **Processing cadence**, select one of the following options. + Choose **Manual** to run a workflow on demand for a bulk update + Choose **Automatic** to run a workflow as soon as new data is in your S3 bucket **Note** If you choose **Automatic**, ensure that you have Amazon EventBridge notifications turned on for your S3 bucket. For instructions on enabling Amazon EventBridge using the S3 console, see [Enabling Amazon EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications-eventbridge.html) in the *Amazon S3 User Guide*. 1. (Optional) For **Index only for ID mapping**, You can choose to **Turn on** the ability to only index the data and not generate IDs. By default, matching workflow generate IDs after the data is indexed. 1. For **Matching rules**, enter a **Rule name** and then choose the **Match keys** for that rule. You can create up to 15 rules and you can apply up to 15 different match keys across your rules to define match criteria. ![Matching rules interface with fields to enter rule name and select match keys.](https://docs.aws.amazon.com/entityresolution/latest/userguide/images/matching-rules.PNG) 1. For **Comparison type**, choose one of the following options based on your goal.
Your goalRecommended option
Find any combination of matches across data stored in multiple input fieldsMultiple input fields
Limit comparison to a single input fieldSingle input field
![Comparison type options: Multiple input fields to find matches across data stored in multiple fields, or Single input field to limit comparison within one field.](https://docs.aws.amazon.com/entityresolution/latest/userguide/images/comparison-type.PNG) 1. Choose **Next**. 1. For **Step 3: Specify data output and format**: 1. For **Data output destination and format**, choose the **Amazon S3 location** for the data output and whether the **Data format** will be **Normalized data** or **Original data**. 1. For **Encryption**, if you choose to **Customize encryption settings**, enter the **AWS KMS key** ARN. 1. View the **System generated output**. 1. For **Data output**, decide which fields you want to include, hide, or mask, and then take the recommended actions based on your goals.
Your goalRecommended action
Include fieldsKeep the output state as Included.
Hide fields (exclude from output)Choose the Output field, and then choose Hide.
Mask fieldsChoose the Output field, and then choose Hash output.
Reset the previous settingsChoose Reset.
1. Choose **Next**. 1. For **Step 4: Review and create**: 1. Review the selections that you made for the previous steps and edit if necessary. 1. Choose **Create and run**. A message appears, indicating that the matching workflow has been created and that the job has started. 1. On the matching workflow details page, on the **Metrics** tab, view the following under **Last job metrics**: + The **Job ID**. + The **Status** of the matching workflow job: **Queued**, **In progress**, **Completed**, **Failed** + The **Time completed** for the workflow job. + The number of **Records processed**. + The number of **Records not processed**. + The **Unique match IDs generated**. + The number of **Input records**. You can also view the job metrics for matching workflow jobs that have been previously run under the **Job history**. 1. After the matching workflow job completes (**Status** is **Completed**), you can go to the **Data output** tab and then select your **Amazon S3 location** to view the results. 1. (**Manual** processing type only) If you have created a **Rule-based matching** workflow with the **Manual** processing type, you can run the matching workflow anytime by choosing **Run workflow** on the matching workflow details page. ------ #### [ API ] **To create a rule-based matching workflow with the **Simple** rule type using the API** **Note** By default, the workflow uses standard (batch) processing. To use incremental (automatic processing, you must explicitly configure it. 1. Open a terminal or command prompt to make the API request. 1. Create a POST request to the following endpoint: ``` /matchingworkflows ``` 1. In the request header, set the Content-type to application/json. **Note** For a complete list of supported programming languages, see the *[AWS Entity Resolution API Reference](https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html)*. 1. For the request body, provide the following required JSON parameters: ``` { "description": "{{string}}", "incrementalRunConfig": { "incrementalRunType": "{{string}}" }, "inputSourceConfig": [ { "applyNormalization": {{boolean}}, "inputSourceARN": "{{string}}", "schemaName": "{{string}}" } ], "outputSourceConfig": [ { "applyNormalization": {{boolean}}, "KMSArn": "{{string}}", "output": [ { "hashed": boolean, "name": "{{string}}" } ], "outputS3Path": "{{string}}" } ], "resolutionTechniques": { "providerProperties": { "intermediateSourceConfiguration": { "intermediateS3Path": "{{string}}" }, "providerConfiguration": {{JSON value}}, "providerServiceArn": "{{string}}" }, "resolutionType": "RULE_MATCHING", "ruleBasedProperties": { "attributeMatchingModel": "{{string}}", "matchPurpose": "{{string}}", "rules": [ { "matchingKeys": [ "{{string}}" ], "ruleName": "{{string}}" } ] }, "ruleConditionProperties": { "rules": [ { "condition": "{{string}}", "ruleName": "{{string}}" } ] } }, "roleArn": "{{string}}", "tags": { "string" : "{{string}}" }, "workflowName": "{{{{string}}}}" } ``` Where: + `workflowName` (required) – Must be unique and between 1–255 characters matching pattern [a-zA-Z\_0-9-]\* + `inputSourceConfig` (required) – List of 1–20 input source configurations + `outputSourceConfig` (required) – Exactly one output source configuration + `resolutionTechniques` (required) – Set to "RULE\_MATCHING" for rule-based matching + `roleArn` (required) – IAM role ARN for workflow execution + `ruleConditionProperties` (required) – List of rule conditions and the name of the matching rule. Optional parameters include: + `description` – Up to 255 characters + `incrementalRunConfig` – Incremental run type configuration + `tags` – Up to 200 key-value pairs 1. (Optional) To use incremental processing instead of the default standard (batch) processing, add the following parameter to the request body: ``` "incrementalRunConfig": { "incrementalRunType": "AUTOMATIC" } ``` 1. Send the request. 1. If successful, you'll receive a response with status code 200 and a JSON body containing: ``` { "workflowArn": "string", "workflowName": "string", // Plus all configured workflow details } ``` 1. If the call is unsuccessful, you might receive one of these errors: + 400 – ConflictException if the workflow name already exists + 400 – ValidationException if the input fails validation + 402 – ExceedsLimitException if account limits are exceeded + 403 – AccessDeniedException if you don't have sufficient access + 429 – ThrottlingException if the request was throttled + 500 – InternalServerException if there's an internal service failure ------