UpdateIdMappingWorkflow - AWS Entity Resolution

UpdateIdMappingWorkflow

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

Request Syntax

PUT /idmappingworkflows/workflowName 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" } ] } }, "inputSourceConfig": [ { "inputSourceARN": "string", "schemaName": "string", "type": "string" } ], "outputSourceConfig": [ { "KMSArn": "string", "outputS3Path": "string" } ], "roleArn": "string" }

URI Request Parameters

The request uses the following URI parameters.

workflowName

The name of the workflow.

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

idMappingTechniques

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

Type: IdMappingTechniques object

Required: Yes

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 OutputSource 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 access AWS resources on your behalf.

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

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" } ] } }, "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

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 OutputSource 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 access AWS resources on your behalf.

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 Amazon Resource Name (ARN) of the workflow role. AWS Entity Resolution assumes this role to access AWS resources on your behalf.

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

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: