Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateIdMappingWorkflow

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.

Important

Incremental processing is not supported for ID mapping workflows.

Request Syntax


POST /idmappingworkflows HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "idMappingTechniques": { 
      "idMappingType": "string",
      "providerProperties": { 
         "intermediateSourceConfiguration": { 
            "intermediateS3Path": "string"
         },
         "providerConfiguration": JSON value,
         "providerServiceArn": "string"
      },
      "ruleBasedProperties": { 
         "attributeMatchingModel": "string",
         "recordMatchingModel": "string",
         "ruleDefinitionType": "string",
         "rules": [ 
            { 
               "matchingKeys": [ "string" ],
               "ruleName": "string"
            }
         ]
      }
   },
   "incrementalRunConfig": { 
      "incrementalRunType": "string"
   },
   "inputSourceConfig": [ 
      { 
         "inputSourceARN": "string",
         "schemaName": "string",
         "type": "string"
      }
   ],
   "outputSourceConfig": [ 
      { 
         "KMSArn": "string",
         "outputS3Path": "string"
      }
   ],
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "workflowName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

A description of the workflow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

idMappingTechniques

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

Type: IdMappingTechniques object

Required: Yes

incrementalRunConfig

The incremental run configuration for the ID mapping workflow.

Type: IdMappingIncrementalRunConfig object

Required: No

inputSourceConfig

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

Type: Array of IdMappingWorkflowInputSource objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

outputSourceConfig

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

Type: Array of IdMappingWorkflowOutputSource objects

Array Members: Fixed number of 1 item.

Required: No

roleArn

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Pattern: $|^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Required: No

tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

workflowName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_0-9-]*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "idMappingTechniques": { 
      "idMappingType": "string",
      "providerProperties": { 
         "intermediateSourceConfiguration": { 
            "intermediateS3Path": "string"
         },
         "providerConfiguration": JSON value,
         "providerServiceArn": "string"
      },
      "ruleBasedProperties": { 
         "attributeMatchingModel": "string",
         "recordMatchingModel": "string",
         "ruleDefinitionType": "string",
         "rules": [ 
            { 
               "matchingKeys": [ "string" ],
               "ruleName": "string"
            }
         ]
      }
   },
   "incrementalRunConfig": { 
      "incrementalRunType": "string"
   },
   "inputSourceConfig": [ 
      { 
         "inputSourceARN": "string",
         "schemaName": "string",
         "type": "string"
      }
   ],
   "outputSourceConfig": [ 
      { 
         "KMSArn": "string",
         "outputS3Path": "string"
      }
   ],
   "roleArn": "string",
   "workflowArn": "string",
   "workflowName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

description

A description of the workflow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

idMappingTechniques

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

Type: IdMappingTechniques object

incrementalRunConfig

The incremental run configuration for the ID mapping workflow.

Type: IdMappingIncrementalRunConfig object

inputSourceConfig

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

Type: Array of IdMappingWorkflowInputSource objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

outputSourceConfig

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

Type: Array of IdMappingWorkflowOutputSource objects

Array Members: Fixed number of 1 item.

roleArn

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Pattern: $|^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

workflowArn

The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the IDMappingWorkflow.

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})

workflowName

The name of the workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_0-9-]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

HTTP Status Code: 400

ExceedsLimitException

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded.

quotaName: The name of the quota that has been breached.
quotaValue: The current quota value for the customers.

HTTP Status Code: 402

InternalServerException

This exception occurs when there is an internal failure in the AWS Entity Resolution service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by AWS Entity Resolution.

HTTP Status Code: 400