Creates a matching workflow that defines the configuration for a data processing job¶

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 update_matching_workflow.

For workflows where resolutionType is PROVIDER, incremental processing is not supported.

Usage¶

entityresolution_create_matching_workflow(workflowName, description,
  inputSourceConfig, outputSourceConfig, resolutionTechniques,
  incrementalRunConfig, roleArn, tags)

Arguments¶

workflowName

[required] The name of the workflow. There can't be multiple MatchingWorkflows with the same name.
description

A description of the workflow.
inputSourceConfig

[required] A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
outputSourceConfig

[required] A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.
resolutionTechniques

[required] An object which defines the resolutionType and the ruleBasedProperties.
incrementalRunConfig

Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console.

For workflows where resolutionType is PROVIDER, incremental processing is not supported.
roleArn

[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

The tags used to organize, track, or control access for this resource.

Value¶

A list with the following syntax:

list(
  workflowName = "string",
  workflowArn = "string",
  description = "string",
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string",
      applyNormalization = TRUE|FALSE
    )
  ),
  outputSourceConfig = list(
    list(
      KMSArn = "string",
      outputS3Path = "string",
      output = list(
        list(
          name = "string",
          hashed = TRUE|FALSE
        )
      ),
      applyNormalization = TRUE|FALSE,
      customerProfilesIntegrationConfig = list(
        domainArn = "string",
        objectTypeArn = "string"
      )
    )
  ),
  resolutionTechniques = list(
    resolutionType = "RULE_MATCHING"|"ML_MATCHING"|"PROVIDER",
    ruleBasedProperties = list(
      rules = list(
        list(
          ruleName = "string",
          matchingKeys = list(
            "string"
          )
        )
      ),
      attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      matchPurpose = "IDENTIFIER_GENERATION"|"INDEXING"
    ),
    ruleConditionProperties = list(
      rules = list(
        list(
          ruleName = "string",
          condition = "string"
        )
      ),
      matchingConfig = list(
        enableTransitiveMatching = TRUE|FALSE
      )
    ),
    enableRealTimeMatching = TRUE|FALSE,
    providerProperties = list(
      providerServiceArn = "string",
      providerConfiguration = list(),
      intermediateSourceConfiguration = list(
        intermediateS3Path = "string"
      )
    )
  ),
  incrementalRunConfig = list(
    incrementalRunType = "IMMEDIATE"
  ),
  roleArn = "string"
)

Request syntax¶

svc$create_matching_workflow(
  workflowName = "string",
  description = "string",
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string",
      applyNormalization = TRUE|FALSE
    )
  ),
  outputSourceConfig = list(
    list(
      KMSArn = "string",
      outputS3Path = "string",
      output = list(
        list(
          name = "string",
          hashed = TRUE|FALSE
        )
      ),
      applyNormalization = TRUE|FALSE,
      customerProfilesIntegrationConfig = list(
        domainArn = "string",
        objectTypeArn = "string"
      )
    )
  ),
  resolutionTechniques = list(
    resolutionType = "RULE_MATCHING"|"ML_MATCHING"|"PROVIDER",
    ruleBasedProperties = list(
      rules = list(
        list(
          ruleName = "string",
          matchingKeys = list(
            "string"
          )
        )
      ),
      attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      matchPurpose = "IDENTIFIER_GENERATION"|"INDEXING"
    ),
    ruleConditionProperties = list(
      rules = list(
        list(
          ruleName = "string",
          condition = "string"
        )
      ),
      matchingConfig = list(
        enableTransitiveMatching = TRUE|FALSE
      )
    ),
    enableRealTimeMatching = TRUE|FALSE,
    providerProperties = list(
      providerServiceArn = "string",
      providerConfiguration = list(),
      intermediateSourceConfiguration = list(
        intermediateS3Path = "string"
      )
    )
  ),
  incrementalRunConfig = list(
    incrementalRunType = "IMMEDIATE"
  ),
  roleArn = "string",
  tags = list(
    "string"
  )
)