@aws-sdk/client-entityresolution 3.787.0 → 3.789.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -53,6 +53,7 @@ declare const GetIdMappingJobCommand_base: {
53
53
  * // totalMappedRecords: Number("int"),
54
54
  * // totalMappedSourceRecords: Number("int"),
55
55
  * // totalMappedTargetRecords: Number("int"),
56
+ * // uniqueRecordsLoaded: Number("int"),
56
57
  * // },
57
58
  * // errorDetails: { // ErrorDetails
58
59
  * // errorMessage: "STRING_VALUE",
@@ -28,7 +28,11 @@ declare const GetMatchIdCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns the corresponding Match ID of a customer record if the record has been
31
- * processed.</p>
31
+ * processed in a
32
+ * rule-based matching workflow or ML matching workflow.</p>
33
+ * <p>You can call this API as a dry run of an incremental load on the rule-based
34
+ * matching
35
+ * workflow.</p>
32
36
  * @example
33
37
  * Use a bare-bones client and the command you need to make an API call.
34
38
  * ```javascript
@@ -1133,8 +1133,10 @@ export declare const SchemaAttributeType: {
1133
1133
  */
1134
1134
  export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
1135
1135
  /**
1136
- * <p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>,
1137
- * <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>
1136
+ * <p>A
1137
+ * configuration object for defining input data fields in Entity Resolution. The
1138
+ * SchemaInputAttribute specifies how individual fields in your input data should be processed
1139
+ * and matched.</p>
1138
1140
  * @public
1139
1141
  */
1140
1142
  export interface SchemaInputAttribute {
@@ -1145,16 +1147,36 @@ export interface SchemaInputAttribute {
1145
1147
  fieldName: string | undefined;
1146
1148
  /**
1147
1149
  * <p>The type of the attribute, selected from a list of values.</p>
1150
+ * <note>
1151
+ * <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,
1152
+ * <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>
1153
+ * <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and
1154
+ * <code>NAME_LAST</code>, you must group them by assigning them to the
1155
+ * <code>NAME</code>
1156
+ * <code>groupName</code>. </p>
1157
+ * <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>,
1158
+ * <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>,
1159
+ * <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group
1160
+ * them by assigning them to the <code>ADDRESS</code>
1161
+ * <code>groupName</code>. </p>
1162
+ * <p>If you want to normalize <code>PHONE_NUMBER</code> and
1163
+ * <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the
1164
+ * <code>PHONE</code>
1165
+ * <code>groupName</code>. </p>
1166
+ * </note>
1148
1167
  * @public
1149
1168
  */
1150
1169
  type: SchemaAttributeType | undefined;
1151
1170
  /**
1152
1171
  * <p>A string that instructs Entity Resolution to combine several columns into a unified
1153
1172
  * column with the identical attribute type. </p>
1154
- * <p>For example, when working with columns such as <code>first_name</code>,
1155
- * <code>middle_name</code>, and <code>last_name</code>, assigning them a common
1156
- * <code>groupName</code> will prompt Entity Resolution to concatenate them into a single
1157
- * value.</p>
1173
+ * <p>For example, when working with columns such as
1174
+ * <code>NAME_FIRST</code>,
1175
+ * <code>NAME_MIDDLE</code>,
1176
+ * and
1177
+ * <code>NAME_LAST</code>,
1178
+ * assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate
1179
+ * them into a single value.</p>
1158
1180
  * @public
1159
1181
  */
1160
1182
  groupName?: string | undefined;
@@ -1175,9 +1197,9 @@ export interface SchemaInputAttribute {
1175
1197
  */
1176
1198
  subType?: string | undefined;
1177
1199
  /**
1178
- * <p> Indicates if the column values are hashed in the schema input. If the value is set to
1179
- * <code>TRUE</code>, the column values are hashed. If the value is set to
1180
- * <code>FALSE</code>, the column values are cleartext.</p>
1200
+ * <p> Indicates if the column values are hashed in the schema input. </p>
1201
+ * <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p>
1202
+ * <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>
1181
1203
  * @public
1182
1204
  */
1183
1205
  hashed?: boolean | undefined;
@@ -1381,9 +1403,10 @@ export interface ErrorDetails {
1381
1403
  errorMessage?: string | undefined;
1382
1404
  }
1383
1405
  /**
1384
- * <p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>,
1385
- * <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>,
1386
- * <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>
1406
+ * <p>An
1407
+ * object that contains metrics about an ID mapping job, including counts of input records,
1408
+ * processed records, and mapped records between source and target identifiers.
1409
+ * </p>
1387
1410
  * @public
1388
1411
  */
1389
1412
  export interface IdMappingJobMetrics {
@@ -1417,6 +1440,16 @@ export interface IdMappingJobMetrics {
1417
1440
  * @public
1418
1441
  */
1419
1442
  totalMappedTargetRecords?: number | undefined;
1443
+ /**
1444
+ * <p>The
1445
+ * number of records remaining after loading and aggregating duplicate records. Duplicates are
1446
+ * determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the
1447
+ * same value in this field are considered duplicates. For example, if you specified
1448
+ * "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value,
1449
+ * they would count as one unique record in this metric. </p>
1450
+ * @public
1451
+ */
1452
+ uniqueRecordsLoaded?: number | undefined;
1420
1453
  }
1421
1454
  /**
1422
1455
  * <p>An object containing <code>KMSArn</code>, <code>OutputS3Path</code>, and
@@ -382,6 +382,7 @@ export interface IdMappingJobMetrics {
382
382
  totalMappedRecords?: number | undefined;
383
383
  totalMappedSourceRecords?: number | undefined;
384
384
  totalMappedTargetRecords?: number | undefined;
385
+ uniqueRecordsLoaded?: number | undefined;
385
386
  }
386
387
  export interface IdMappingJobOutputSource {
387
388
  roleArn: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-entityresolution",
3
3
  "description": "AWS SDK for JavaScript Entityresolution Client for Node.js, Browser and React Native",
4
- "version": "3.787.0",
4
+ "version": "3.789.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-entityresolution",