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 UpdateIdMappingWorkflow API.

Incremental processing is not supported for ID mapping workflows.

Usage¶

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

Arguments¶

workflowName

[required] The name of the workflow. There can't be multiple IdMappingWorkflows 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

A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.
idMappingTechniques

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

The incremental run configuration for the ID mapping workflow.
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.

Value¶

A list with the following syntax:

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

Request syntax¶

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