AWS entityresolution documentation change
Summary
Expanded documentation for looking up Match IDs in rule-based workflows, adding detailed API instructions (GetMatchID), error codes, and console steps reorganization
Security assessment
The changes focus on improving operational documentation clarity and API usage details. While error codes like 403 (access denied) are mentioned, these are standard API responses and do not indicate a specific security vulnerability. No evidence of addressing a security weakness or introducing security features.
Diff
diff --git a/entityresolution/latest/userguide/find-match-id.md b/entityresolution/latest/userguide/find-match-id.md index d4af03f8f..630c12109 100644 --- a//entityresolution/latest/userguide/find-match-id.md +++ b//entityresolution/latest/userguide/find-match-id.md @@ -5 +5 @@ -# Finding a Match ID for a rule-based matching workflow +# Looking up a Match ID for a rule-based matching workflow @@ -7 +7 @@ -After you’ve run a rule-based matching workflow, you can find the corresponding Match ID and associated rule for the processed records. +After completing a rule-based matching workflow, you can retrieve the Match ID and associated rule for each processed record. This information helps you understand how records were matched and which rules were applied. The following procedure demonstrates how to access this data using either the AWS Entity Resolution Console or the `GetMatchID` API. @@ -9 +9 @@ After you’ve run a rule-based matching workflow, you can find the correspondin -###### To find a Match ID for a rule-based matching workflow: +Console @@ -11 +11,4 @@ After you’ve run a rule-based matching workflow, you can find the correspondin - 1. Sign in to the AWS Management Console and open the [AWS Entity Resolution console](https://console.aws.amazon.com/entityresolution/home) with your AWS account, if you haven't yet done so. + +###### To look up a Match ID using the console + + 1. Sign in to the AWS Management Console and open the AWS Entity Resolution console at [https://console.aws.amazon.com/entityresolution/](https://console.aws.amazon.com/entityresolution/). @@ -17 +20,3 @@ After you’ve run a rule-based matching workflow, you can find the correspondin - 4. On the matching workflow details page, choose the **Find match ID** tab. + 4. On the matching workflow details page, choose the **Match IDs** tab. + + 5. Choose **Look up match ID**. @@ -19 +24 @@ After you’ve run a rule-based matching workflow, you can find the correspondin - 5. Do one of the following: + 6. Do one of the following: @@ -26,5 +31 @@ There is more than one schema mapping associated with this workflow. | Choose th - 6. Expand the **Matching rules**. - - 7. Enter a **Value** for each **Match key**. - -The **Normalize data** option is selected by default, so that data inputs are normalized before matching. If you don't want to normalize data, deselect the **Normalize data** option. + 7. For **Record attributes** , enter the **Value** for an existing **Match key** to look up for each existing record. @@ -36 +37,78 @@ Enter as many values as you can to help find the Match ID. - 8. Choose **Look up**. + 8. The **Normalize data** option is selected by default, so that data inputs are normalized before matching. If you don't want to normalize data, deselect the **Normalize data** option. + + 9. If you want to view the matching rules expand the **View matching rules**. + + 10. Choose **Look up**. + +A success message appears, stating that the Match ID was found. + + 11. View the corresponding Match ID and the associated rule that was found. + + + + +API + + +###### To look up a Match ID using the API + +###### Note + +To call this API successfully, you must have first successfully run a rule-based matching workflow using the [StartMatchingJob API](https://docs.aws.amazon.com/entityresolution/latest/apireference/API_StartMatchingJob.html). + +For a complete list of supported programming languages, see the [See Also](https://docs.aws.amazon.com/entityresolution/latest/apireference/API_GetMatchId.html#API_GetMatchId_SeeAlso) section of the [GetMatchID API](https://docs.aws.amazon.com/entityresolution/latest/apireference/API_GetMatchId.html). + + 1. Open a terminal or command prompt to make the API request. + + 2. Create a POST request to the following endpoint: + + /matchingworkflows/workflowName/matches + + + 3. In the request header, set the Content-type to application/json. + + 4. In the request URI, specify your `workflowName`. + +The `workflowName` must: + + * Be between 1 and 255 characters long + + * Match the pattern [a-zA-Z_0-9-]* + + 5. For the request body, provide the following JSON: + + { + "applyNormalization": boolean, + "record": { + "string" : "string" + } + } + + +Where: + +`applyNormalization` (optional) - Set to `true` to normalize attributes defined in the schema + +`record` (required) - The record to fetch the Match ID for + + 6. Send the request. + +If successful, you'll receive a response with status code 200 and a JSON body containing: + + { + "matchId": "string", + "matchRule": "string" + } + + +The `matchId` is the unique identifier for this group of matched records, and `matchRule` indicates which rule the record matched on. + +If the call is unsuccessful, you might receive one of these errors: + + * 403 - AccessDeniedException if you don't have sufficient access + + * 404 - ResourceNotFoundException if the resource can't be found + + * 429 - ThrottlingException if the request was throttled + + * 400 - ValidationException if the input fails validation @@ -38 +116 @@ Enter as many values as you can to help find the Match ID. - 9. View the corresponding Match ID and the associated rule that was used for matching. + * 500 - InternalServerException if there's an internal service failure @@ -49 +127 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Deleting a matching workflow +Modifying or generating a Match ID