Create Matching Workflow

entityresolution_create_matching_workflow

R Documentation

Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run

Description

Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the update_matching_workflow API.

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, and Output.
resolutionTechniques	[required] An object which defines the resolutionType and the ruleBasedProperties.
incrementalRunConfig	An object which defines an incremental run type and has only incrementalRunType as a field.
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(
      outputS3Path = "string",
      KMSArn = "string",
      output = list(
        list(
          name = "string",
          hashed = TRUE|FALSE
        )
      ),
      applyNormalization = TRUE|FALSE
    )
  ),
  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"
    ),
    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(
      outputS3Path = "string",
      KMSArn = "string",
      output = list(
        list(
          name = "string",
          hashed = TRUE|FALSE
        )
      ),
      applyNormalization = TRUE|FALSE
    )
  ),
  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"
    ),
    providerProperties = list(
      providerServiceArn = "string",
      providerConfiguration = list(),
      intermediateSourceConfiguration = list(
        intermediateS3Path = "string"
      )
    )
  ),
  incrementalRunConfig = list(
    incrementalRunType = "IMMEDIATE"
  ),
  roleArn = "string",
  tags = list(
    "string"
  )
)