Skip to content

Start Id Mapping Job

entityresolution_start_id_mapping_job R Documentation

Starts the IdMappingJob of a workflow

Description

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the create_id_mapping_workflow endpoint.

Usage

entityresolution_start_id_mapping_job(workflowName, outputSourceConfig,
  jobType)

Arguments

workflowName

[required] The name of the ID mapping job to be retrieved.

outputSourceConfig

A list of OutputSource objects.

jobType

The job type for the ID mapping job.

If the jobType value is set to INCREMENTAL, only new or changed data is processed since the last job run. This is the default value if the create_id_mapping_workflow API is configured with an incrementalRunConfig.

If the jobType value is set to BATCH, all data is processed from the input source, regardless of previous job runs. This is the default value if the create_id_mapping_workflow API isn't configured with an incrementalRunConfig.

If the jobType value is set to DELETE_ONLY, only deletion requests from BatchDeleteUniqueIds are processed.

Value

A list with the following syntax:

list(
  jobId = "string",
  outputSourceConfig = list(
    list(
      roleArn = "string",
      outputS3Path = "string",
      KMSArn = "string"
    )
  ),
  jobType = "BATCH"|"INCREMENTAL"|"DELETE_ONLY"
)

Request syntax

svc$start_id_mapping_job(
  workflowName = "string",
  outputSourceConfig = list(
    list(
      roleArn = "string",
      outputS3Path = "string",
      KMSArn = "string"
    )
  ),
  jobType = "BATCH"|"INCREMENTAL"|"DELETE_ONLY"
)