UpdateMatchingWorkflow - AWS Entity Resolution

UpdateMatchingWorkflow

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

Request Syntax

PUT /matchingworkflows/workflowName 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", "rules": [ { "matchingKeys": [ "string" ], "ruleName": "string" } ] } }, "roleArn": "string" }

URI Request Parameters

The request uses the following URI parameters.

workflowName

The name of the workflow to be retrieved.

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

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

Required: Yes

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 incrementalRunType as a field.

Type: IncrementalRunConfig object

Required: No

inputSourceConfig

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

Type: Array of InputSource objects

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

Required: Yes

outputSourceConfig

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

Type: Array of OutputSource objects

Array Members: Fixed number of 1 item.

Required: Yes

resolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties.

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

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", "rules": [ { "matchingKeys": [ "string" ], "ruleName": "string" } ] } }, "roleArn": "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 incrementalRunType as a field.

Type: IncrementalRunConfig object

inputSourceConfig

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

Type: Array of InputSource objects

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

outputSourceConfig

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

Type: Array of OutputSource objects

Array Members: Fixed number of 1 item.

resolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties

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

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

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found. HTTP Status Code: 404

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. HTTP Status Code: 429

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: