feat(client-entityresolution): Support First Party ID Mapping

aws · Jul 23, 2024 · 9175354 · 9175354
1 parent 0be56cb
commit 9175354
Show file tree

Hide file tree

Showing 41 changed files with 963 additions and 604 deletions.
diff --git a/clients/client-entityresolution/src/auth/httpAuthSchemeProvider.ts b/clients/client-entityresolution/src/auth/httpAuthSchemeProvider.ts
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: EntityResolutionHttpAu
       name: "entityresolution",
       region: authParameters.region,
     },
-    propertiesExtractor: (config: EntityResolutionClientConfig, context) => ({
+    propertiesExtractor: (config: Partial<EntityResolutionClientConfig>, context) => ({
       /**
        * @internal
        */

diff --git a/clients/client-entityresolution/src/commands/AddPolicyStatementCommand.ts b/clients/client-entityresolution/src/commands/AddPolicyStatementCommand.ts
@@ -65,34 +65,25 @@ export interface AddPolicyStatementCommandOutput extends AddPolicyStatementOutpu
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
- *             403</code>
- *          </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link ConflictException} (client fault)
  *  <p>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. <code>HTTP Status Code: 400</code>
- *          </p>
+ *          running, etc. </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource could not be found. <code>HTTP Status Code: 404</code>
- *          </p>
+ *  <p>The resource could not be found. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling. <code>HTTP Status Code:
- *          429</code>
- *          </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>

diff --git a/clients/client-entityresolution/src/commands/BatchDeleteUniqueIdCommand.ts b/clients/client-entityresolution/src/commands/BatchDeleteUniqueIdCommand.ts
@@ -72,17 +72,13 @@ export interface BatchDeleteUniqueIdCommandOutput extends BatchDeleteUniqueIdOut
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource could not be found. <code>HTTP Status Code: 404</code>
- *          </p>
+ *  <p>The resource could not be found. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>

diff --git a/clients/client-entityresolution/src/commands/CreateIdMappingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/CreateIdMappingWorkflowCommand.ts
@@ -55,7 +55,20 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
  *     },
  *   ],
  *   idMappingTechniques: { // IdMappingTechniques
- *     idMappingType: "PROVIDER", // required
+ *     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",
@@ -64,7 +77,7 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
  *       },
  *     },
  *   },
- *   roleArn: "STRING_VALUE", // required
+ *   roleArn: "STRING_VALUE",
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
@@ -89,7 +102,20 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
  * //     },
  * //   ],
  * //   idMappingTechniques: { // IdMappingTechniques
- * //     idMappingType: "PROVIDER", // required
+ * //     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",
@@ -98,7 +124,7 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
  * //       },
  * //     },
  * //   },
- * //   roleArn: "STRING_VALUE", // required
+ * //   roleArn: "STRING_VALUE",
  * // };
  *
  * ```
@@ -110,36 +136,27 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
- *             403</code>
- *          </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link ConflictException} (client fault)
  *  <p>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. <code>HTTP Status Code: 400</code>
- *          </p>
+ *          running, etc. </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
  *  <p>The request was rejected because it attempted to create resources beyond the current
  *             Entity Resolution account limits. The error message describes the limit exceeded.
- *             <code>HTTP Status Code: 402</code>
- *          </p>
+ *       </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling. <code>HTTP Status Code:
- *          429</code>
- *          </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>

diff --git a/clients/client-entityresolution/src/commands/CreateIdNamespaceCommand.ts b/clients/client-entityresolution/src/commands/CreateIdNamespaceCommand.ts
@@ -48,7 +48,24 @@ export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput,
  *   ],
  *   idMappingWorkflowProperties: [ // IdNamespaceIdMappingWorkflowPropertiesList
  *     { // IdNamespaceIdMappingWorkflowProperties
- *       idMappingType: "PROVIDER", // required
+ *       idMappingType: "PROVIDER" || "RULE_BASED", // required
+ *       ruleBasedProperties: { // NamespaceRuleBasedProperties
+ *         rules: [ // RuleList
+ *           { // Rule
+ *             ruleName: "STRING_VALUE", // required
+ *             matchingKeys: [ // MatchingKeys // required
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         ],
+ *         ruleDefinitionTypes: [ // IdMappingWorkflowRuleDefinitionTypeList
+ *           "SOURCE" || "TARGET",
+ *         ],
+ *         attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY",
+ *         recordMatchingModels: [ // RecordMatchingModelList
+ *           "ONE_SOURCE_TO_ONE_TARGET" || "MANY_SOURCE_TO_ONE_TARGET",
+ *         ],
+ *       },
  *       providerProperties: { // NamespaceProviderProperties
  *         providerServiceArn: "STRING_VALUE", // required
  *         providerConfiguration: "DOCUMENT_VALUE",
@@ -75,7 +92,24 @@ export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput,
  * //   ],
  * //   idMappingWorkflowProperties: [ // IdNamespaceIdMappingWorkflowPropertiesList
  * //     { // IdNamespaceIdMappingWorkflowProperties
- * //       idMappingType: "PROVIDER", // required
+ * //       idMappingType: "PROVIDER" || "RULE_BASED", // required
+ * //       ruleBasedProperties: { // NamespaceRuleBasedProperties
+ * //         rules: [ // RuleList
+ * //           { // Rule
+ * //             ruleName: "STRING_VALUE", // required
+ * //             matchingKeys: [ // MatchingKeys // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         ],
+ * //         ruleDefinitionTypes: [ // IdMappingWorkflowRuleDefinitionTypeList
+ * //           "SOURCE" || "TARGET",
+ * //         ],
+ * //         attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY",
+ * //         recordMatchingModels: [ // RecordMatchingModelList
+ * //           "ONE_SOURCE_TO_ONE_TARGET" || "MANY_SOURCE_TO_ONE_TARGET",
+ * //         ],
+ * //       },
  * //       providerProperties: { // NamespaceProviderProperties
  * //         providerServiceArn: "STRING_VALUE", // required
  * //         providerConfiguration: "DOCUMENT_VALUE",
@@ -100,36 +134,27 @@ export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput,
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
- *             403</code>
- *          </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link ConflictException} (client fault)
  *  <p>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. <code>HTTP Status Code: 400</code>
- *          </p>
+ *          running, etc. </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
  *  <p>The request was rejected because it attempted to create resources beyond the current
  *             Entity Resolution account limits. The error message describes the limit exceeded.
- *             <code>HTTP Status Code: 402</code>
- *          </p>
+ *       </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling. <code>HTTP Status Code:
- *          429</code>
- *          </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>

diff --git a/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts
@@ -73,6 +73,7 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  *         },
  *       ],
  *       attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ *       matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
  *     },
  *     providerProperties: { // ProviderProperties
  *       providerServiceArn: "STRING_VALUE", // required
@@ -128,6 +129,7 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  * //         },
  * //       ],
  * //       attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ * //       matchPurpose: "IDENTIFIER_GENERATION" || "INDEXING",
  * //     },
  * //     providerProperties: { // ProviderProperties
  * //       providerServiceArn: "STRING_VALUE", // required
@@ -152,36 +154,27 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
- *             403</code>
- *          </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link ConflictException} (client fault)
  *  <p>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. <code>HTTP Status Code: 400</code>
- *          </p>
+ *          running, etc. </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
  *  <p>The request was rejected because it attempted to create resources beyond the current
  *             Entity Resolution account limits. The error message describes the limit exceeded.
- *             <code>HTTP Status Code: 402</code>
- *          </p>
+ *       </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling. <code>HTTP Status Code:
- *          429</code>
- *          </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>

diff --git a/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts
@@ -47,6 +47,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
  *       groupName: "STRING_VALUE",
  *       matchKey: "STRING_VALUE",
  *       subType: "STRING_VALUE",
+ *       hashed: true || false,
  *     },
  *   ],
  *   tags: { // TagMap
@@ -66,6 +67,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
  * //       groupName: "STRING_VALUE",
  * //       matchKey: "STRING_VALUE",
  * //       subType: "STRING_VALUE",
+ * //       hashed: true || false,
  * //     },
  * //   ],
  * // };
@@ -79,36 +81,27 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
- *             403</code>
- *          </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link ConflictException} (client fault)
  *  <p>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. <code>HTTP Status Code: 400</code>
- *          </p>
+ *          running, etc. </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
  *  <p>The request was rejected because it attempted to create resources beyond the current
  *             Entity Resolution account limits. The error message describes the limit exceeded.
- *             <code>HTTP Status Code: 402</code>
- *          </p>
+ *       </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Entity Resolution
- *          service. <code>HTTP Status Code: 500</code>
- *          </p>
+ *          service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling. <code>HTTP Status Code:
- *          429</code>
- *          </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
- *             Status Code: 400</code>
- *          </p>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
  *
  * @throws {@link EntityResolutionServiceException}
  * <p>Base exception class for all service exceptions from EntityResolution service.</p>