Skip to content

Commit 6c75f9f

Browse files
author
awstools
committed
feat(client-entityresolution): This is to add new metrics to our GetIdMappingJob API and also update uniqueId naming for batchDeleteUniqueIds API to be more accurate
1 parent 24e5bc7 commit 6c75f9f

File tree

4 files changed

+80
-36
lines changed

4 files changed

+80
-36
lines changed

Diff for: clients/client-entityresolution/src/commands/GetIdMappingJobCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export interface GetIdMappingJobCommandOutput extends GetIdMappingJobOutput, __M
5454
* // totalMappedRecords: Number("int"),
5555
* // totalMappedSourceRecords: Number("int"),
5656
* // totalMappedTargetRecords: Number("int"),
57+
* // uniqueRecordsLoaded: Number("int"),
5758
* // },
5859
* // errorDetails: { // ErrorDetails
5960
* // errorMessage: "STRING_VALUE",

Diff for: clients/client-entityresolution/src/commands/GetMatchIdCommand.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,11 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
2929

3030
/**
3131
* <p>Returns the corresponding Match ID of a customer record if the record has been
32-
* processed.</p>
32+
* processed in a
33+
* rule-based matching workflow or ML matching workflow.</p>
34+
* <p>You can call this API as a dry run of an incremental load on the rule-based
35+
* matching
36+
* workflow.</p>
3337
* @example
3438
* Use a bare-bones client and the command you need to make an API call.
3539
* ```javascript

Diff for: clients/client-entityresolution/src/models/models_0.ts

+46-12
Original file line numberDiff line numberDiff line change
@@ -1333,8 +1333,10 @@ export const SchemaAttributeType = {
13331333
export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
13341334

13351335
/**
1336-
* <p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>,
1337-
* <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>
1336+
* <p>A
1337+
* configuration object for defining input data fields in Entity Resolution. The
1338+
* SchemaInputAttribute specifies how individual fields in your input data should be processed
1339+
* and matched.</p>
13381340
* @public
13391341
*/
13401342
export interface SchemaInputAttribute {
@@ -1346,17 +1348,37 @@ export interface SchemaInputAttribute {
13461348

13471349
/**
13481350
* <p>The type of the attribute, selected from a list of values.</p>
1351+
* <note>
1352+
* <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,
1353+
* <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>
1354+
* <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and
1355+
* <code>NAME_LAST</code>, you must group them by assigning them to the
1356+
* <code>NAME</code>
1357+
* <code>groupName</code>. </p>
1358+
* <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>,
1359+
* <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>,
1360+
* <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group
1361+
* them by assigning them to the <code>ADDRESS</code>
1362+
* <code>groupName</code>. </p>
1363+
* <p>If you want to normalize <code>PHONE_NUMBER</code> and
1364+
* <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the
1365+
* <code>PHONE</code>
1366+
* <code>groupName</code>. </p>
1367+
* </note>
13491368
* @public
13501369
*/
13511370
type: SchemaAttributeType | undefined;
13521371

13531372
/**
13541373
* <p>A string that instructs Entity Resolution to combine several columns into a unified
13551374
* column with the identical attribute type. </p>
1356-
* <p>For example, when working with columns such as <code>first_name</code>,
1357-
* <code>middle_name</code>, and <code>last_name</code>, assigning them a common
1358-
* <code>groupName</code> will prompt Entity Resolution to concatenate them into a single
1359-
* value.</p>
1375+
* <p>For example, when working with columns such as
1376+
* <code>NAME_FIRST</code>,
1377+
* <code>NAME_MIDDLE</code>,
1378+
* and
1379+
* <code>NAME_LAST</code>,
1380+
* assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate
1381+
* them into a single value.</p>
13601382
* @public
13611383
*/
13621384
groupName?: string | undefined;
@@ -1380,9 +1402,9 @@ export interface SchemaInputAttribute {
13801402
subType?: string | undefined;
13811403

13821404
/**
1383-
* <p> Indicates if the column values are hashed in the schema input. If the value is set to
1384-
* <code>TRUE</code>, the column values are hashed. If the value is set to
1385-
* <code>FALSE</code>, the column values are cleartext.</p>
1405+
* <p> Indicates if the column values are hashed in the schema input. </p>
1406+
* <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p>
1407+
* <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>
13861408
* @public
13871409
*/
13881410
hashed?: boolean | undefined;
@@ -1611,9 +1633,10 @@ export interface ErrorDetails {
16111633
}
16121634

16131635
/**
1614-
* <p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>,
1615-
* <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>,
1616-
* <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>
1636+
* <p>An
1637+
* object that contains metrics about an ID mapping job, including counts of input records,
1638+
* processed records, and mapped records between source and target identifiers.
1639+
* </p>
16171640
* @public
16181641
*/
16191642
export interface IdMappingJobMetrics {
@@ -1652,6 +1675,17 @@ export interface IdMappingJobMetrics {
16521675
* @public
16531676
*/
16541677
totalMappedTargetRecords?: number | undefined;
1678+
1679+
/**
1680+
* <p>The
1681+
* number of records remaining after loading and aggregating duplicate records. Duplicates are
1682+
* determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the
1683+
* same value in this field are considered duplicates. For example, if you specified
1684+
* "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value,
1685+
* they would count as one unique record in this metric. </p>
1686+
* @public
1687+
*/
1688+
uniqueRecordsLoaded?: number | undefined;
16551689
}
16561690

16571691
/**

Diff for: codegen/sdk-codegen/aws-models/entityresolution.json

+28-23
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@
960960
"smithy.api#length": {
961961
"max": 255
962962
},
963-
"smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$"
963+
"smithy.api#pattern": "^[a-zA-Z_0-9- ]*$"
964964
}
965965
},
966966
"com.amazonaws.entityresolution#AwsAccountId": {
@@ -2016,7 +2016,7 @@
20162016
"type": "structure",
20172017
"members": {
20182018
"uniqueId": {
2019-
"target": "com.amazonaws.entityresolution#UniqueId",
2019+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId",
20202020
"traits": {
20212021
"smithy.api#documentation": "<p>The unique ID that could not be deleted.</p>",
20222022
"smithy.api#required": {}
@@ -2078,7 +2078,7 @@
20782078
"type": "structure",
20792079
"members": {
20802080
"uniqueId": {
2081-
"target": "com.amazonaws.entityresolution#UniqueId",
2081+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId",
20822082
"traits": {
20832083
"smithy.api#documentation": "<p> The unique ID of the deleted item.</p>",
20842084
"smithy.api#required": {}
@@ -2106,7 +2106,7 @@
21062106
"com.amazonaws.entityresolution#DisconnectedUniqueIdsList": {
21072107
"type": "list",
21082108
"member": {
2109-
"target": "com.amazonaws.entityresolution#UniqueId"
2109+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId"
21102110
}
21112111
},
21122112
"com.amazonaws.entityresolution#EntityName": {
@@ -2565,7 +2565,7 @@
25652565
}
25662566
],
25672567
"traits": {
2568-
"smithy.api#documentation": "<p>Returns the corresponding Match ID of a customer record if the record has been\n processed.</p>",
2568+
"smithy.api#documentation": "<p>Returns the corresponding Match ID of a customer record if the record has been\n processed in a\n rule-based matching workflow or ML matching workflow.</p>\n <p>You can call this API as a dry run of an incremental load on the rule-based\n matching\n workflow.</p>",
25692569
"smithy.api#http": {
25702570
"code": 200,
25712571
"method": "POST",
@@ -3214,6 +3214,16 @@
32143214
"smithy.api#output": {}
32153215
}
32163216
},
3217+
"com.amazonaws.entityresolution#HeaderSafeUniqueId": {
3218+
"type": "string",
3219+
"traits": {
3220+
"smithy.api#length": {
3221+
"min": 1,
3222+
"max": 780
3223+
},
3224+
"smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$"
3225+
}
3226+
},
32173227
"com.amazonaws.entityresolution#IdMappingJobMetrics": {
32183228
"type": "structure",
32193229
"members": {
@@ -3252,10 +3262,16 @@
32523262
"traits": {
32533263
"smithy.api#documentation": "<p> The total number of distinct mapped target records.</p>"
32543264
}
3265+
},
3266+
"uniqueRecordsLoaded": {
3267+
"target": "smithy.api#Integer",
3268+
"traits": {
3269+
"smithy.api#documentation": "<p>The\n number of records remaining after loading and aggregating duplicate records. Duplicates are\n determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the\n same value in this field are considered duplicates. For example, if you specified\n \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value,\n they would count as one unique record in this metric. </p>"
3270+
}
32553271
}
32563272
},
32573273
"traits": {
3258-
"smithy.api#documentation": "<p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>,\n <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>,\n <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>"
3274+
"smithy.api#documentation": "<p>An\n object that contains metrics about an ID mapping job, including counts of input records,\n processed records, and mapped records between source and target identifiers.\n </p>"
32593275
}
32603276
},
32613277
"com.amazonaws.entityresolution#IdMappingJobOutputSource": {
@@ -5361,7 +5377,7 @@
53615377
"smithy.api#length": {
53625378
"max": 255
53635379
},
5364-
"smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$",
5380+
"smithy.api#pattern": "^[a-zA-Z_0-9- ]*$",
53655381
"smithy.api#required": {}
53665382
}
53675383
},
@@ -5370,7 +5386,6 @@
53705386
"traits": {
53715387
"smithy.api#documentation": "<p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been\n defined in the <code>SchemaMapping</code>. Two records are considered to match according to\n this rule if all of the <code>MatchingKeys</code> match.</p>",
53725388
"smithy.api#length": {
5373-
"min": 1,
53745389
"max": 15
53755390
},
53765391
"smithy.api#required": {}
@@ -5567,14 +5582,14 @@
55675582
"type": {
55685583
"target": "com.amazonaws.entityresolution#SchemaAttributeType",
55695584
"traits": {
5570-
"smithy.api#documentation": "<p>The type of the attribute, selected from a list of values.</p>",
5585+
"smithy.api#documentation": "<p>The type of the attribute, selected from a list of values.</p>\n <note>\n <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,\n <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>\n <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and\n <code>NAME_LAST</code>, you must group them by assigning them to the\n <code>NAME</code>\n <code>groupName</code>. </p>\n <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>,\n <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>,\n <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group\n them by assigning them to the <code>ADDRESS</code>\n <code>groupName</code>. </p>\n <p>If you want to normalize <code>PHONE_NUMBER</code> and\n <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the\n <code>PHONE</code>\n <code>groupName</code>. </p>\n </note>",
55715586
"smithy.api#required": {}
55725587
}
55735588
},
55745589
"groupName": {
55755590
"target": "com.amazonaws.entityresolution#AttributeName",
55765591
"traits": {
5577-
"smithy.api#documentation": "<p>A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type. </p>\n <p>For example, when working with columns such as <code>first_name</code>,\n <code>middle_name</code>, and <code>last_name</code>, assigning them a common\n <code>groupName</code> will prompt Entity Resolution to concatenate them into a single\n value.</p>"
5592+
"smithy.api#documentation": "<p>A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type. </p>\n <p>For example, when working with columns such as\n <code>NAME_FIRST</code>,\n <code>NAME_MIDDLE</code>,\n and\n <code>NAME_LAST</code>,\n assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate\n them into a single value.</p>"
55785593
}
55795594
},
55805595
"matchKey": {
@@ -5592,12 +5607,12 @@
55925607
"hashed": {
55935608
"target": "smithy.api#Boolean",
55945609
"traits": {
5595-
"smithy.api#documentation": "<p> Indicates if the column values are hashed in the schema input. If the value is set to\n <code>TRUE</code>, the column values are hashed. If the value is set to\n <code>FALSE</code>, the column values are cleartext.</p>"
5610+
"smithy.api#documentation": "<p> Indicates if the column values are hashed in the schema input. </p>\n <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p>\n <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>"
55965611
}
55975612
}
55985613
},
55995614
"traits": {
5600-
"smithy.api#documentation": "<p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>,\n <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>"
5615+
"smithy.api#documentation": "<p>A\n configuration object for defining input data fields in Entity Resolution. The\n SchemaInputAttribute specifies how individual fields in your input data should be processed\n and matched.</p>"
56015616
}
56025617
},
56035618
"com.amazonaws.entityresolution#SchemaInputAttributes": {
@@ -6046,20 +6061,10 @@
60466061
}
60476062
}
60486063
},
6049-
"com.amazonaws.entityresolution#UniqueId": {
6050-
"type": "string",
6051-
"traits": {
6052-
"smithy.api#length": {
6053-
"min": 1,
6054-
"max": 760
6055-
},
6056-
"smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$"
6057-
}
6058-
},
60596064
"com.amazonaws.entityresolution#UniqueIdList": {
60606065
"type": "list",
60616066
"member": {
6062-
"target": "com.amazonaws.entityresolution#UniqueId"
6067+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId"
60636068
}
60646069
},
60656070
"com.amazonaws.entityresolution#UntagResource": {

0 commit comments

Comments
 (0)