# create-matching-workflow ## Description Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use `UpdateMatchingWorkflow` . #### WARNING For workflows where `resolutionType` is `PROVIDER` , incremental processing is not supported. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateMatchingWorkflow) `create-matching-workflow` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types. ## Synopsis ``` create-matching-workflow --workflow-name [--description ] --input-source-config --output-source-config --resolution-techniques [--incremental-run-config ] --role-arn [--tags ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--workflow-name` (string) [required] > The name of the workflow. There can’t be multiple `MatchingWorkflows` with the same name. > Constraints: > * min: `1` > * max: `255` > * pattern: `[a-zA-Z_0-9-]*` `--description` (string) > A description of the workflow. > Constraints: > * min: `0` > * max: `255` `--input-source-config` (list) [required] > A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . > Constraints: > * min: `1` > * max: `20` > (structure) > > An object containing `inputSourceARN` , `schemaName` , and `applyNormalization` . > > inputSourceARN -> (string) [required] > > > An Glue table Amazon Resource Name (ARN) for the input source table. > > > Constraints: > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})` > > schemaName -> (string) [required] > > > The name of the schema to be retrieved. > > > Constraints: > > > * min: `1` > > > * max: `255` > > > * pattern: `[a-zA-Z_0-9-]*` > > applyNormalization -> (boolean) > > > Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890. Shorthand Syntax: ``` inputSourceARN=string,schemaName=string,applyNormalization=boolean ... ``` JSON Syntax: ```json [ { "inputSourceARN": "string", "schemaName": "string", "applyNormalization": true|false } ... ] ``` `--output-source-config` (list) [required] > A list of `OutputSource` objects, each of which contains fields `outputS3Path` , `applyNormalization` , `KMSArn` , and `output` . > Constraints: > * min: `1` > * max: `1` > (structure) > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > KMSArn -> (string) > > > Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key. > > > Constraints: > > > * pattern: `arn:aws:kms:.*:[0-9]+:.*` > > outputS3Path -> (string) > > > The S3 path to which Entity Resolution will write the output table. > > > Constraints: > > > * min: `0` > > > * max: `1024` > > > * pattern: `$|^s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?` > > output -> (list) [required] > > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > > Constraints: > > > * min: `0` > > > * max: `750` > > > (structure) > > > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > > > name -> (string) [required] > > > > > A name of a column to be written to the output. This must be an `InputField` name in the schema mapping. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > hashed -> (boolean) > > > > > Enables the ability to hash the column values in the output. > > applyNormalization -> (boolean) > > > Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890. > > customerProfilesIntegrationConfig -> (structure) > > > Specifies the Customer Profiles integration configuration for sending matched output directly to Customer Profiles. When configured, Entity Resolution automatically creates and updates customer profiles based on match clusters, eliminating the need for manual Amazon S3 integration setup. > > > domainArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Customer Profiles domain where the matched output will be sent. > > > > Constraints: > > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-9-]{1,255})` > > > objectTypeArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Customer Profiles object type that defines the structure for the matched customer data. > > > > Constraints: > > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-9-]{1,255}/object-types/[a-zA-Z_0-9-]{1,255})` Shorthand Syntax: ``` KMSArn=string,outputS3Path=string,output=[{name=string,hashed=boolean},{name=string,hashed=boolean}],applyNormalization=boolean,customerProfilesIntegrationConfig={domainArn=string,objectTypeArn=string} ... ``` JSON Syntax: ```json [ { "KMSArn": "string", "outputS3Path": "string", "output": [ { "name": "string", "hashed": true|false } ... ], "applyNormalization": true|false, "customerProfilesIntegrationConfig": { "domainArn": "string", "objectTypeArn": "string" } } ... ] ``` `--resolution-techniques` (structure) [required] > An object which defines the `resolutionType` and the `ruleBasedProperties` . > resolutionType -> (string) [required] > > The type of matching workflow to create. Specify one of the following types: > > * `RULE_MATCHING` : Match records using configurable rule-based criteria > > * `ML_MATCHING` : Match records using machine learning models > > * `PROVIDER` : Match records using a third-party matching provider > > Possible values: > > * `RULE_MATCHING` > > * `ML_MATCHING` > > * `PROVIDER` > ruleBasedProperties -> (structure) > > An object which defines the list of matching rules to run and has a field `rules` , which is a list of rule objects. > > rules -> (list) [required] > > > A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` . > > > Constraints: > > > * min: `1` > > > * max: `25` > > > (structure) > > > > An object containing the `ruleName` and `matchingKeys` . > > > > ruleName -> (string) [required] > > > > > A name for the matching rule. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > matchingKeys -> (list) [required] > > > > > A list of `MatchingKeys` . The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `15` > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `255` > > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > attributeMatchingModel -> (string) [required] > > > The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` . > > > If you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B. > > > If you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A and the value of `BusinessEmail` field of Profile B matches, the two profiles are matched on the `Email` attribute type. > > > Possible values: > > > * `ONE_TO_ONE` > > > * `MANY_TO_MANY` > > matchPurpose -> (string) > > > An indicator of whether to generate IDs and index the data or not. > > > If you choose `IDENTIFIER_GENERATION` , the process generates IDs and indexes the data. > > > If you choose `INDEXING` , the process indexes the data without generating IDs. > > > Possible values: > > > * `IDENTIFIER_GENERATION` > > > * `INDEXING` > ruleConditionProperties -> (structure) > > An object containing the `rules` for a matching workflow. > > rules -> (list) [required] > > > A list of rule objects, each of which have fields `ruleName` and `condition` . > > > Constraints: > > > * min: `1` > > > * max: `25` > > > (structure) > > > > An object that defines the `ruleCondition` and the `ruleName` to use in a matching workflow. > > > > ruleName -> (string) [required] > > > > > A name for the matching rule. > > > > > For example: `Rule1` > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > condition -> (string) [required] > > > > > A statement that specifies the conditions for a matching rule. > > > > > If your data is accurate, use an Exact matching function: `Exact` or `ExactManyToMany` . > > > > > If your data has variations in spelling or pronunciation, use a Fuzzy matching function: `Cosine` , `Levenshtein` , or `Soundex` . > > > > > Use operators if you want to combine (`AND` ), separate (`OR` ), or group matching functions `(...)` . > > > > > For example: `(Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)` > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `2048` > > matchingConfig -> (structure) > > > An object that contains configuration settings for the matching process. > > > enableTransitiveMatching -> (boolean) > > > > Enables transitive matching for the rule-based matching workflow. When enabled, records that match through different rules are grouped together into the same match group. > enableRealTimeMatching -> (boolean) > > Specifies whether real-time matching is enabled for the rule-based matching workflow. When you enable real-time matching, you can use the `GenerateMatchId` operation with the workflow. > providerProperties -> (structure) > > The properties of the provider service. > > providerServiceArn -> (string) [required] > > > The ARN of the provider service. > > > Constraints: > > > * min: `20` > > > * max: `255` > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})` > > providerConfiguration -> (document) > > > The required configuration fields to use with the provider service. > > intermediateSourceConfiguration -> (structure) > > > The Amazon S3 location that temporarily stores your data while it processes. Your information won’t be saved permanently. > > > intermediateS3Path -> (string) [required] > > > > The Amazon S3 location (bucket and prefix). For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET` > > > > Constraints: > > > > * min: `1` > > > > * max: `1024` > > > > * pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?` JSON Syntax: ```json { "resolutionType": "RULE_MATCHING"|"ML_MATCHING"|"PROVIDER", "ruleBasedProperties": { "rules": [ { "ruleName": "string", "matchingKeys": ["string", ...] } ... ], "attributeMatchingModel": "ONE_TO_ONE"|"MANY_TO_MANY", "matchPurpose": "IDENTIFIER_GENERATION"|"INDEXING" }, "ruleConditionProperties": { "rules": [ { "ruleName": "string", "condition": "string" } ... ], "matchingConfig": { "enableTransitiveMatching": true|false } }, "enableRealTimeMatching": true|false, "providerProperties": { "providerServiceArn": "string", "providerConfiguration": {...}, "intermediateSourceConfiguration": { "intermediateS3Path": "string" } } } ``` `--incremental-run-config` (structure) > Optional. An object that defines the incremental run type. This object contains only the `incrementalRunType` field, which appears as “Automatic” in the console. > #### WARNING > For workflows where `resolutionType` is `PROVIDER` , incremental processing is not supported. > incrementalRunType -> (string) > > The type of incremental run. The only valid value is `IMMEDIATE` . This appears as “Automatic” in the console. > > #### WARNING > > For workflows where `resolutionType` is `PROVIDER` , incremental processing is not supported. > > Possible values: > > * `IMMEDIATE` Shorthand Syntax: ``` incrementalRunType=string ``` JSON Syntax: ```json { "incrementalRunType": "IMMEDIATE" } ``` `--role-arn` (string) [required] > The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. `--tags` (map) > The tags used to organize, track, or control access for this resource. > Constraints: > * min: `0` > * max: `200` > key -> (string) > > Constraints: > > * min: `1` > > * max: `128` > value -> (string) > > Constraints: > > * min: `0` > > * max: `256` Shorthand Syntax: ``` KeyName1=string,KeyName2=string ``` JSON Syntax: ```json {"string": "string" ...} ``` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Output workflowName -> (string) > The name of the workflow. > Constraints: > * min: `1` > * max: `255` > * pattern: `[a-zA-Z_0-9-]*` workflowArn -> (string) > The ARN (Amazon Resource Name) that Entity Resolution generated for the `MatchingWorkflow` . > Constraints: > * pattern: `arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})` description -> (string) > A description of the workflow. > Constraints: > * min: `0` > * max: `255` inputSourceConfig -> (list) > A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . > Constraints: > * min: `1` > * max: `20` > (structure) > > An object containing `inputSourceARN` , `schemaName` , and `applyNormalization` . > > inputSourceARN -> (string) [required] > > > An Glue table Amazon Resource Name (ARN) for the input source table. > > > Constraints: > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})` > > schemaName -> (string) [required] > > > The name of the schema to be retrieved. > > > Constraints: > > > * min: `1` > > > * max: `255` > > > * pattern: `[a-zA-Z_0-9-]*` > > applyNormalization -> (boolean) > > > Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890. outputSourceConfig -> (list) > A list of `OutputSource` objects, each of which contains fields `outputS3Path` , `applyNormalization` , `KMSArn` , and `output` . > Constraints: > * min: `1` > * max: `1` > (structure) > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > KMSArn -> (string) > > > Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key. > > > Constraints: > > > * pattern: `arn:aws:kms:.*:[0-9]+:.*` > > outputS3Path -> (string) > > > The S3 path to which Entity Resolution will write the output table. > > > Constraints: > > > * min: `0` > > > * max: `1024` > > > * pattern: `$|^s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?` > > output -> (list) [required] > > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > > Constraints: > > > * min: `0` > > > * max: `750` > > > (structure) > > > > A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. > > > > name -> (string) [required] > > > > > A name of a column to be written to the output. This must be an `InputField` name in the schema mapping. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > hashed -> (boolean) > > > > > Enables the ability to hash the column values in the output. > > applyNormalization -> (boolean) > > > Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890. > > customerProfilesIntegrationConfig -> (structure) > > > Specifies the Customer Profiles integration configuration for sending matched output directly to Customer Profiles. When configured, Entity Resolution automatically creates and updates customer profiles based on match clusters, eliminating the need for manual Amazon S3 integration setup. > > > domainArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Customer Profiles domain where the matched output will be sent. > > > > Constraints: > > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-9-]{1,255})` > > > objectTypeArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Customer Profiles object type that defines the structure for the matched customer data. > > > > Constraints: > > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):profile:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(domains/[a-zA-Z_0-9-]{1,255}/object-types/[a-zA-Z_0-9-]{1,255})` resolutionTechniques -> (structure) > An object which defines the `resolutionType` and the `ruleBasedProperties` . > resolutionType -> (string) [required] > > The type of matching workflow to create. Specify one of the following types: > > * `RULE_MATCHING` : Match records using configurable rule-based criteria > > * `ML_MATCHING` : Match records using machine learning models > > * `PROVIDER` : Match records using a third-party matching provider > > Possible values: > > * `RULE_MATCHING` > > * `ML_MATCHING` > > * `PROVIDER` > ruleBasedProperties -> (structure) > > An object which defines the list of matching rules to run and has a field `rules` , which is a list of rule objects. > > rules -> (list) [required] > > > A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` . > > > Constraints: > > > * min: `1` > > > * max: `25` > > > (structure) > > > > An object containing the `ruleName` and `matchingKeys` . > > > > ruleName -> (string) [required] > > > > > A name for the matching rule. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > matchingKeys -> (list) [required] > > > > > A list of `MatchingKeys` . The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `15` > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `255` > > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > attributeMatchingModel -> (string) [required] > > > The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` . > > > If you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B. > > > If you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A and the value of `BusinessEmail` field of Profile B matches, the two profiles are matched on the `Email` attribute type. > > > Possible values: > > > * `ONE_TO_ONE` > > > * `MANY_TO_MANY` > > matchPurpose -> (string) > > > An indicator of whether to generate IDs and index the data or not. > > > If you choose `IDENTIFIER_GENERATION` , the process generates IDs and indexes the data. > > > If you choose `INDEXING` , the process indexes the data without generating IDs. > > > Possible values: > > > * `IDENTIFIER_GENERATION` > > > * `INDEXING` > ruleConditionProperties -> (structure) > > An object containing the `rules` for a matching workflow. > > rules -> (list) [required] > > > A list of rule objects, each of which have fields `ruleName` and `condition` . > > > Constraints: > > > * min: `1` > > > * max: `25` > > > (structure) > > > > An object that defines the `ruleCondition` and the `ruleName` to use in a matching workflow. > > > > ruleName -> (string) [required] > > > > > A name for the matching rule. > > > > > For example: `Rule1` > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > condition -> (string) [required] > > > > > A statement that specifies the conditions for a matching rule. > > > > > If your data is accurate, use an Exact matching function: `Exact` or `ExactManyToMany` . > > > > > If your data has variations in spelling or pronunciation, use a Fuzzy matching function: `Cosine` , `Levenshtein` , or `Soundex` . > > > > > Use operators if you want to combine (`AND` ), separate (`OR` ), or group matching functions `(...)` . > > > > > For example: `(Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)` > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `2048` > > matchingConfig -> (structure) > > > An object that contains configuration settings for the matching process. > > > enableTransitiveMatching -> (boolean) > > > > Enables transitive matching for the rule-based matching workflow. When enabled, records that match through different rules are grouped together into the same match group. > enableRealTimeMatching -> (boolean) > > Specifies whether real-time matching is enabled for the rule-based matching workflow. When you enable real-time matching, you can use the `GenerateMatchId` operation with the workflow. > providerProperties -> (structure) > > The properties of the provider service. > > providerServiceArn -> (string) [required] > > > The ARN of the provider service. > > > Constraints: > > > * min: `20` > > > * max: `255` > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})` > > providerConfiguration -> (document) > > > The required configuration fields to use with the provider service. > > intermediateSourceConfiguration -> (structure) > > > The Amazon S3 location that temporarily stores your data while it processes. Your information won’t be saved permanently. > > > intermediateS3Path -> (string) [required] > > > > The Amazon S3 location (bucket and prefix). For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET` > > > > Constraints: > > > > * min: `1` > > > > * max: `1024` > > > > * pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?` incrementalRunConfig -> (structure) > An object which defines an incremental run type and has only `incrementalRunType` as a field. > incrementalRunType -> (string) > > The type of incremental run. The only valid value is `IMMEDIATE` . This appears as “Automatic” in the console. > > #### WARNING > > For workflows where `resolutionType` is `PROVIDER` , incremental processing is not supported. > > Possible values: > > * `IMMEDIATE` roleArn -> (string) > The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.