UpdateIdMappingWorkflowCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EntityResolutionClient, UpdateIdMappingWorkflowCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
// const { EntityResolutionClient, UpdateIdMappingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
const client = new EntityResolutionClient(config);
const input = { // UpdateIdMappingWorkflowInput
  workflowName: "STRING_VALUE", // required
  description: "STRING_VALUE",
  inputSourceConfig: [ // IdMappingWorkflowInputSourceConfig // required
    { // IdMappingWorkflowInputSource
      inputSourceARN: "STRING_VALUE", // required
      schemaName: "STRING_VALUE",
      type: "SOURCE" || "TARGET",
    },
  ],
  outputSourceConfig: [ // IdMappingWorkflowOutputSourceConfig
    { // IdMappingWorkflowOutputSource
      outputS3Path: "STRING_VALUE", // required
      KMSArn: "STRING_VALUE",
    },
  ],
  idMappingTechniques: { // IdMappingTechniques
    idMappingType: "PROVIDER" || "RULE_BASED", // required
    ruleBasedProperties: { // IdMappingRuleBasedProperties
      rules: [ // RuleList
        { // Rule
          ruleName: "STRING_VALUE", // required
          matchingKeys: [ // MatchingKeys // required
            "STRING_VALUE",
          ],
        },
      ],
      ruleDefinitionType: "SOURCE" || "TARGET", // required
      attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
      recordMatchingModel: "ONE_SOURCE_TO_ONE_TARGET" || "MANY_SOURCE_TO_ONE_TARGET", // required
    },
    providerProperties: { // ProviderProperties
      providerServiceArn: "STRING_VALUE", // required
      providerConfiguration: "DOCUMENT_VALUE",
      intermediateSourceConfiguration: { // IntermediateSourceConfiguration
        intermediateS3Path: "STRING_VALUE", // required
      },
    },
  },
  roleArn: "STRING_VALUE",
};
const command = new UpdateIdMappingWorkflowCommand(input);
const response = await client.send(command);
// { // UpdateIdMappingWorkflowOutput
//   workflowName: "STRING_VALUE", // required
//   workflowArn: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   inputSourceConfig: [ // IdMappingWorkflowInputSourceConfig // required
//     { // IdMappingWorkflowInputSource
//       inputSourceARN: "STRING_VALUE", // required
//       schemaName: "STRING_VALUE",
//       type: "SOURCE" || "TARGET",
//     },
//   ],
//   outputSourceConfig: [ // IdMappingWorkflowOutputSourceConfig
//     { // IdMappingWorkflowOutputSource
//       outputS3Path: "STRING_VALUE", // required
//       KMSArn: "STRING_VALUE",
//     },
//   ],
//   idMappingTechniques: { // IdMappingTechniques
//     idMappingType: "PROVIDER" || "RULE_BASED", // required
//     ruleBasedProperties: { // IdMappingRuleBasedProperties
//       rules: [ // RuleList
//         { // Rule
//           ruleName: "STRING_VALUE", // required
//           matchingKeys: [ // MatchingKeys // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       ruleDefinitionType: "SOURCE" || "TARGET", // required
//       attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
//       recordMatchingModel: "ONE_SOURCE_TO_ONE_TARGET" || "MANY_SOURCE_TO_ONE_TARGET", // required
//     },
//     providerProperties: { // ProviderProperties
//       providerServiceArn: "STRING_VALUE", // required
//       providerConfiguration: "DOCUMENT_VALUE",
//       intermediateSourceConfiguration: { // IntermediateSourceConfiguration
//         intermediateS3Path: "STRING_VALUE", // required
//       },
//     },
//   },
//   roleArn: "STRING_VALUE",
// };

UpdateIdMappingWorkflowCommand Input

See UpdateIdMappingWorkflowCommandInput for more details

Parameter
Type
Description
idMappingTechniques
Required
IdMappingTechniques | undefined

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

inputSourceConfig
Required
IdMappingWorkflowInputSource[] | undefined

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

workflowName
Required
string | undefined

The name of the workflow.

description
string | undefined

A description of the workflow.

outputSourceConfig
IdMappingWorkflowOutputSource[] | undefined

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

roleArn
string | undefined

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

UpdateIdMappingWorkflowCommand Output

See UpdateIdMappingWorkflowCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
idMappingTechniques
Required
IdMappingTechniques | undefined

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

inputSourceConfig
Required
IdMappingWorkflowInputSource[] | undefined

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

workflowArn
Required
string | undefined

The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

workflowName
Required
string | undefined

The name of the workflow.

description
string | undefined

A description of the workflow.

outputSourceConfig
IdMappingWorkflowOutputSource[] | undefined

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

roleArn
string | undefined

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The resource could not be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

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

EntityResolutionServiceException
Base exception class for all service exceptions from EntityResolution service.