Skip to content

Create Id Mapping Workflow

entityresolution_create_id_mapping_workflow R Documentation

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run

Description

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the update_id_mapping_workflow API.

Usage

entityresolution_create_id_mapping_workflow(description,
  idMappingTechniques, inputSourceConfig, outputSourceConfig, roleArn,
  tags, workflowName)

Arguments

description

A description of the workflow.

idMappingTechniques

[required] An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

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

outputSourceConfig

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

roleArn

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.

workflowName

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

Value

A list with the following syntax: 

list(
  description = "string",
  idMappingTechniques = list(
    idMappingType = "PROVIDER"|"RULE_BASED",
    providerProperties = list(
      intermediateSourceConfiguration = list(
        intermediateS3Path = "string"
      ),
      providerConfiguration = list(),
      providerServiceArn = "string"
    ),
    ruleBasedProperties = list(
      attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      recordMatchingModel = "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET",
      ruleDefinitionType = "SOURCE"|"TARGET",
      rules = list(
        list(
          matchingKeys = list(
            "string"
          ),
          ruleName = "string"
        )
      )
    )
  ),
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string",
      type = "SOURCE"|"TARGET"
    )
  ),
  outputSourceConfig = list(
    list(
      KMSArn = "string",
      outputS3Path = "string"
    )
  ),
  roleArn = "string",
  workflowArn = "string",
  workflowName = "string"
)

Request syntax

svc$create_id_mapping_workflow(
  description = "string",
  idMappingTechniques = list(
    idMappingType = "PROVIDER"|"RULE_BASED",
    providerProperties = list(
      intermediateSourceConfiguration = list(
        intermediateS3Path = "string"
      ),
      providerConfiguration = list(),
      providerServiceArn = "string"
    ),
    ruleBasedProperties = list(
      attributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      recordMatchingModel = "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET",
      ruleDefinitionType = "SOURCE"|"TARGET",
      rules = list(
        list(
          matchingKeys = list(
            "string"
          ),
          ruleName = "string"
        )
      )
    )
  ),
  inputSourceConfig = list(
    list(
      inputSourceARN = "string",
      schemaName = "string",
      type = "SOURCE"|"TARGET"
    )
  ),
  outputSourceConfig = list(
    list(
      KMSArn = "string",
      outputS3Path = "string"
    )
  ),
  roleArn = "string",
  tags = list(
    "string"
  ),
  workflowName = "string"
)