Creates a MatchingWorkflow object which stores the configuration of the
data processing job to be run. It is important to note that there should not be a
pre-existing MatchingWorkflow with the same name. To modify an existing
workflow, utilize the UpdateMatchingWorkflow API.
Request Syntax
POST /matchingworkflows HTTP/1.1
Content-type: application/json
{
"description": "string",
"incrementalRunConfig": {
"incrementalRunType": "string"
},
"inputSourceConfig": [
{
"applyNormalization": boolean,
"inputSourceARN": "string",
"schemaName": "string"
}
],
"outputSourceConfig": [
{
"applyNormalization": boolean,
"KMSArn": "string",
"output": [
{
"hashed": boolean,
"name": "string"
}
],
"outputS3Path": "string"
}
],
"resolutionTechniques": {
"providerProperties": {
"intermediateSourceConfiguration": {
"intermediateS3Path": "string"
},
"providerConfiguration": JSON value,
"providerServiceArn": "string"
},
"resolutionType": "string",
"ruleBasedProperties": {
"attributeMatchingModel": "string",
"matchPurpose": "string",
"rules": [
{
"matchingKeys": [ "string" ],
"ruleName": "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
- incrementalRunConfig
-
An object which defines an incremental run type and has only
incrementalRunTypeas a field.Type: IncrementalRunConfig object
Required: No
- inputSourceConfig
-
A list of
InputSourceobjects, which have the fieldsInputSourceARNandSchemaName.Type: Array of InputSource objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes
- outputSourceConfig
-
A list of
OutputSourceobjects, each of which contains fieldsOutputS3Path,ApplyNormalization, andOutput.Type: Array of OutputSource objects
Array Members: Fixed number of 1 item.
Required: Yes
- resolutionTechniques
-
An object which defines the
resolutionTypeand theruleBasedProperties.Type: ResolutionTechniques object
Required: Yes
- 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
Required: Yes
-
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
MatchingWorkflowswith 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",
"incrementalRunConfig": {
"incrementalRunType": "string"
},
"inputSourceConfig": [
{
"applyNormalization": boolean,
"inputSourceARN": "string",
"schemaName": "string"
}
],
"outputSourceConfig": [
{
"applyNormalization": boolean,
"KMSArn": "string",
"output": [
{
"hashed": boolean,
"name": "string"
}
],
"outputS3Path": "string"
}
],
"resolutionTechniques": {
"providerProperties": {
"intermediateSourceConfiguration": {
"intermediateS3Path": "string"
},
"providerConfiguration": JSON value,
"providerServiceArn": "string"
},
"resolutionType": "string",
"ruleBasedProperties": {
"attributeMatchingModel": "string",
"matchPurpose": "string",
"rules": [
{
"matchingKeys": [ "string" ],
"ruleName": "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.
- incrementalRunConfig
-
An object which defines an incremental run type and has only
incrementalRunTypeas a field.Type: IncrementalRunConfig object
- inputSourceConfig
-
A list of
InputSourceobjects, which have the fieldsInputSourceARNandSchemaName.Type: Array of InputSource objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
- outputSourceConfig
-
A list of
OutputSourceobjects, each of which contains fieldsOutputS3Path,ApplyNormalization, andOutput.Type: Array of OutputSource objects
Array Members: Fixed number of 1 item.
- resolutionTechniques
-
An object which defines the
resolutionTypeand theruleBasedProperties.Type: ResolutionTechniques object
- 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
- workflowArn
-
The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the
MatchingWorkflow.Type: String
Pattern:
arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[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 could not 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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
