Skip to content

Commit f36fbb4

Browse files
author
awstools
committed
feat(client-entityresolution): Add support for creating advanced rule-based matching workflows in AWS Entity Resolution.
1 parent 1af8f7e commit f36fbb4

File tree

9 files changed

+226
-74
lines changed

9 files changed

+226
-74
lines changed

clients/client-entityresolution/src/commands/CreateIdMappingWorkflowCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateIdMappingWorkflowCommandInput extends CreateIdMappingWork
2828
export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the <code>UpdateIdMappingWorkflow</code> API.</p>
31+
* <p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-entityresolution/src/commands/CreateIdNamespaceCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateIdNamespaceCommandInput extends CreateIdNamespaceInput {}
2828
export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the <code>UpdateIdNamespace</code> API.</p>
31+
* <p>Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateMatchingWorkflowCommandInput extends CreateMatchingWorkfl
2828
export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a <code>MatchingWorkflow</code> 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 <code>MatchingWorkflow</code> with the same name. To modify an existing workflow, utilize the <code>UpdateMatchingWorkflow</code> API.</p>
31+
* <p>Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use <code>UpdateMatchingWorkflow</code>. </p> <important> <p>For workflows where <code>resolutionType</code> is ML_MATCHING, incremental processing is not supported. </p> </important>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -72,6 +72,14 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
7272
* attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
7373
* matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
7474
* },
75+
* ruleConditionProperties: { // RuleConditionProperties
76+
* rules: [ // RuleConditionList // required
77+
* { // RuleCondition
78+
* ruleName: "STRING_VALUE", // required
79+
* condition: "STRING_VALUE", // required
80+
* },
81+
* ],
82+
* },
7583
* providerProperties: { // ProviderProperties
7684
* providerServiceArn: "STRING_VALUE", // required
7785
* providerConfiguration: "DOCUMENT_VALUE",
@@ -128,6 +136,14 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
128136
* // attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
129137
* // matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
130138
* // },
139+
* // ruleConditionProperties: { // RuleConditionProperties
140+
* // rules: [ // RuleConditionList // required
141+
* // { // RuleCondition
142+
* // ruleName: "STRING_VALUE", // required
143+
* // condition: "STRING_VALUE", // required
144+
* // },
145+
* // ],
146+
* // },
131147
* // providerProperties: { // ProviderProperties
132148
* // providerServiceArn: "STRING_VALUE", // required
133149
* // providerConfiguration: "DOCUMENT_VALUE",

clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,14 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
7878
* // attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
7979
* // matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
8080
* // },
81+
* // ruleConditionProperties: { // RuleConditionProperties
82+
* // rules: [ // RuleConditionList // required
83+
* // { // RuleCondition
84+
* // ruleName: "STRING_VALUE", // required
85+
* // condition: "STRING_VALUE", // required
86+
* // },
87+
* // ],
88+
* // },
8189
* // providerProperties: { // ProviderProperties
8290
* // providerServiceArn: "STRING_VALUE", // required
8391
* // providerConfiguration: "DOCUMENT_VALUE",

clients/client-entityresolution/src/commands/UpdateIdMappingWorkflowCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdateIdMappingWorkflowCommandInput extends UpdateIdMappingWork
2828
export interface UpdateIdMappingWorkflowCommandOutput extends UpdateIdMappingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates an existing <code>IdMappingWorkflow</code>. This method is identical to <code>CreateIdMappingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>IdMappingWorkflow</code> must already exist for the method to succeed.</p>
31+
* <p>Updates an existing <code>IdMappingWorkflow</code>. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>IdMappingWorkflow</code> must already exist for the method to succeed.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-entityresolution/src/commands/UpdateMatchingWorkflowCommand.ts

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdateMatchingWorkflowCommandInput extends UpdateMatchingWorkfl
2828
export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates an existing <code>MatchingWorkflow</code>. This method is identical to <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already exist for the method to succeed.</p>
31+
* <p>Updates an existing matching workflow. The workflow must already exist for this operation to succeed.</p> <important> <p>For workflows where <code>resolutionType</code> is ML_MATCHING, incremental processing is not supported. </p> </important>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
@@ -72,6 +72,14 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
7272
* attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
7373
* matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
7474
* },
75+
* ruleConditionProperties: { // RuleConditionProperties
76+
* rules: [ // RuleConditionList // required
77+
* { // RuleCondition
78+
* ruleName: "STRING_VALUE", // required
79+
* condition: "STRING_VALUE", // required
80+
* },
81+
* ],
82+
* },
7583
* providerProperties: { // ProviderProperties
7684
* providerServiceArn: "STRING_VALUE", // required
7785
* providerConfiguration: "DOCUMENT_VALUE",
@@ -124,6 +132,14 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
124132
* // attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
125133
* // matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
126134
* // },
135+
* // ruleConditionProperties: { // RuleConditionProperties
136+
* // rules: [ // RuleConditionList // required
137+
* // { // RuleCondition
138+
* // ruleName: "STRING_VALUE", // required
139+
* // condition: "STRING_VALUE", // required
140+
* // },
141+
* // ],
142+
* // },
127143
* // providerProperties: { // ProviderProperties
128144
* // providerServiceArn: "STRING_VALUE", // required
129145
* // providerConfiguration: "DOCUMENT_VALUE",

0 commit comments

Comments
 (0)