Update Matching Workflow

entityresolution_update_matching_workflow

R Documentation

Updates an existing MatchingWorkflow

Description

Updates an existing MatchingWorkflow. This method is identical to create_matching_workflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.

Usage

entityresolution_update_matching_workflow(description,
  incrementalRunConfig, inputSourceConfig, outputSourceConfig,
  resolutionTechniques, roleArn, workflowName)

Arguments

description

A description of the workflow.

incrementalRunConfig

An object which defines an incremental run type and has only incrementalRunType as a field.

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.

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.

workflowName

[required] The name of the workflow to be retrieved.

Value

A list with the following syntax:

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

Request syntax

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