@aws-sdk/client-entityresolution 3.787.0 → 3.794.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.
package/dist-cjs/index.js CHANGED
@@ -463,6 +463,9 @@ var SchemaAttributeType = {
463
463
  ADDRESS_STREET3: "ADDRESS_STREET3",
464
464
  DATE: "DATE",
465
465
  EMAIL_ADDRESS: "EMAIL_ADDRESS",
466
+ IPV4: "IPV4",
467
+ IPV6: "IPV6",
468
+ MAID: "MAID",
466
469
  NAME: "NAME",
467
470
  NAME_FIRST: "NAME_FIRST",
468
471
  NAME_LAST: "NAME_LAST",
@@ -147,6 +147,9 @@ export const SchemaAttributeType = {
147
147
  ADDRESS_STREET3: "ADDRESS_STREET3",
148
148
  DATE: "DATE",
149
149
  EMAIL_ADDRESS: "EMAIL_ADDRESS",
150
+ IPV4: "IPV4",
151
+ IPV6: "IPV6",
152
+ MAID: "MAID",
150
153
  NAME: "NAME",
151
154
  NAME_FIRST: "NAME_FIRST",
152
155
  NAME_LAST: "NAME_LAST",
@@ -42,7 +42,7 @@ declare const CreateSchemaMappingCommand_base: {
42
42
  * mappedInputFields: [ // SchemaInputAttributes // required
43
43
  * { // SchemaInputAttribute
44
44
  * fieldName: "STRING_VALUE", // required
45
- * type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
45
+ * type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
46
46
  * groupName: "STRING_VALUE",
47
47
  * matchKey: "STRING_VALUE",
48
48
  * subType: "STRING_VALUE",
@@ -62,7 +62,7 @@ declare const CreateSchemaMappingCommand_base: {
62
62
  * // mappedInputFields: [ // SchemaInputAttributes // required
63
63
  * // { // SchemaInputAttribute
64
64
  * // fieldName: "STRING_VALUE", // required
65
- * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
65
+ * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
66
66
  * // groupName: "STRING_VALUE",
67
67
  * // matchKey: "STRING_VALUE",
68
68
  * // subType: "STRING_VALUE",
@@ -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",
@@ -27,8 +27,10 @@ declare const GetMatchIdCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the corresponding Match ID of a customer record if the record has been
31
- * processed.</p>
30
+ * <p>Returns the corresponding Match ID of a customer record if the record has been processed
31
+ * in a rule-based matching workflow or ML matching workflow.</p>
32
+ * <p>You can call this API as a dry run of an incremental load on the rule-based matching
33
+ * workflow.</p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
34
36
  * ```javascript
@@ -80,7 +80,7 @@ declare const GetProviderServiceCommand_base: {
80
80
  * // providerSchemaAttributes: [ // ProviderSchemaAttributes
81
81
  * // { // ProviderSchemaAttribute
82
82
  * // fieldName: "STRING_VALUE", // required
83
- * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
83
+ * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
84
84
  * // subType: "STRING_VALUE",
85
85
  * // hashing: true || false,
86
86
  * // },
@@ -46,7 +46,7 @@ declare const GetSchemaMappingCommand_base: {
46
46
  * // mappedInputFields: [ // SchemaInputAttributes // required
47
47
  * // { // SchemaInputAttribute
48
48
  * // fieldName: "STRING_VALUE", // required
49
- * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
49
+ * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
50
50
  * // groupName: "STRING_VALUE",
51
51
  * // matchKey: "STRING_VALUE",
52
52
  * // subType: "STRING_VALUE",
@@ -44,7 +44,7 @@ declare const UpdateSchemaMappingCommand_base: {
44
44
  * mappedInputFields: [ // SchemaInputAttributes // required
45
45
  * { // SchemaInputAttribute
46
46
  * fieldName: "STRING_VALUE", // required
47
- * type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
47
+ * type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
48
48
  * groupName: "STRING_VALUE",
49
49
  * matchKey: "STRING_VALUE",
50
50
  * subType: "STRING_VALUE",
@@ -61,7 +61,7 @@ declare const UpdateSchemaMappingCommand_base: {
61
61
  * // mappedInputFields: [ // SchemaInputAttributes // required
62
62
  * // { // SchemaInputAttribute
63
63
  * // fieldName: "STRING_VALUE", // required
64
- * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
64
+ * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID" || "IPV4" || "IPV6" || "MAID", // required
65
65
  * // groupName: "STRING_VALUE",
66
66
  * // matchKey: "STRING_VALUE",
67
67
  * // subType: "STRING_VALUE",
@@ -1117,6 +1117,9 @@ export declare const SchemaAttributeType: {
1117
1117
  readonly ADDRESS_STREET3: "ADDRESS_STREET3";
1118
1118
  readonly DATE: "DATE";
1119
1119
  readonly EMAIL_ADDRESS: "EMAIL_ADDRESS";
1120
+ readonly IPV4: "IPV4";
1121
+ readonly IPV6: "IPV6";
1122
+ readonly MAID: "MAID";
1120
1123
  readonly NAME: "NAME";
1121
1124
  readonly NAME_FIRST: "NAME_FIRST";
1122
1125
  readonly NAME_LAST: "NAME_LAST";
@@ -1133,8 +1136,9 @@ export declare const SchemaAttributeType: {
1133
1136
  */
1134
1137
  export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
1135
1138
  /**
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>
1139
+ * <p>A configuration object for defining input data fields in Entity Resolution. The
1140
+ * <code>SchemaInputAttribute</code> specifies how individual fields in your input data
1141
+ * should be processed and matched.</p>
1138
1142
  * @public
1139
1143
  */
1140
1144
  export interface SchemaInputAttribute {
@@ -1145,14 +1149,48 @@ export interface SchemaInputAttribute {
1145
1149
  fieldName: string | undefined;
1146
1150
  /**
1147
1151
  * <p>The type of the attribute, selected from a list of values.</p>
1152
+ * <p>LiveRamp supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1153
+ * <code>NAME_MIDDLE</code> | <code>NAME_LAST</code> | <code>ADDRESS</code> |
1154
+ * <code>ADDRESS_STREET1</code> | <code>ADDRESS_STREET2</code> |
1155
+ * <code>ADDRESS_STREET3</code> | <code>ADDRESS_CITY</code> | <code>ADDRESS_STATE</code> |
1156
+ * <code>ADDRESS_COUNTRY</code> | <code>ADDRESS_POSTALCODE</code> | <code>PHONE</code> |
1157
+ * <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> | <code>UNIQUE_ID</code> |
1158
+ * <code>PROVIDER_ID</code>
1159
+ * </p>
1160
+ * <p>TransUnion supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1161
+ * <code>NAME_LAST</code> | <code>ADDRESS</code> | <code>ADDRESS_CITY</code> |
1162
+ * <code>ADDRESS_STATE</code> | <code>ADDRESS_COUNTRY</code> |
1163
+ * <code>ADDRESS_POSTALCODE</code> | <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code>
1164
+ * | <code>UNIQUE_ID</code> | <code>IPV4</code> | <code>IPV6</code> | <code>MAID</code>
1165
+ * </p>
1166
+ * <p>Unified ID 2.0 supports: <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> |
1167
+ * <code>UNIQUE_ID</code>
1168
+ * </p>
1169
+ * <note>
1170
+ * <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,
1171
+ * <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>
1172
+ * <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and
1173
+ * <code>NAME_LAST</code>, you must group them by assigning them to the
1174
+ * <code>NAME</code>
1175
+ * <code>groupName</code>. </p>
1176
+ * <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>,
1177
+ * <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>,
1178
+ * <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group
1179
+ * them by assigning them to the <code>ADDRESS</code>
1180
+ * <code>groupName</code>. </p>
1181
+ * <p>If you want to normalize <code>PHONE_NUMBER</code> and
1182
+ * <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the
1183
+ * <code>PHONE</code>
1184
+ * <code>groupName</code>. </p>
1185
+ * </note>
1148
1186
  * @public
1149
1187
  */
1150
1188
  type: SchemaAttributeType | undefined;
1151
1189
  /**
1152
1190
  * <p>A string that instructs Entity Resolution to combine several columns into a unified
1153
1191
  * 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
1192
+ * <p>For example, when working with columns such as <code>NAME_FIRST</code>,
1193
+ * <code>NAME_MIDDLE</code>, and <code>NAME_LAST</code>, assigning them a common
1156
1194
  * <code>groupName</code> will prompt Entity Resolution to concatenate them into a single
1157
1195
  * value.</p>
1158
1196
  * @public
@@ -1175,9 +1213,9 @@ export interface SchemaInputAttribute {
1175
1213
  */
1176
1214
  subType?: string | undefined;
1177
1215
  /**
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>
1216
+ * <p> Indicates if the column values are hashed in the schema input. </p>
1217
+ * <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p>
1218
+ * <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>
1181
1219
  * @public
1182
1220
  */
1183
1221
  hashed?: boolean | undefined;
@@ -1381,9 +1419,10 @@ export interface ErrorDetails {
1381
1419
  errorMessage?: string | undefined;
1382
1420
  }
1383
1421
  /**
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>
1422
+ * <p>An
1423
+ * object that contains metrics about an ID mapping job, including counts of input records,
1424
+ * processed records, and mapped records between source and target identifiers.
1425
+ * </p>
1387
1426
  * @public
1388
1427
  */
1389
1428
  export interface IdMappingJobMetrics {
@@ -1417,6 +1456,16 @@ export interface IdMappingJobMetrics {
1417
1456
  * @public
1418
1457
  */
1419
1458
  totalMappedTargetRecords?: number | undefined;
1459
+ /**
1460
+ * <p>The
1461
+ * number of records remaining after loading and aggregating duplicate records. Duplicates are
1462
+ * determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the
1463
+ * same value in this field are considered duplicates. For example, if you specified
1464
+ * "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value,
1465
+ * they would count as one unique record in this metric. </p>
1466
+ * @public
1467
+ */
1468
+ uniqueRecordsLoaded?: number | undefined;
1420
1469
  }
1421
1470
  /**
1422
1471
  * <p>An object containing <code>KMSArn</code>, <code>OutputS3Path</code>, and
@@ -1924,6 +1973,24 @@ export interface ProviderSchemaAttribute {
1924
1973
  fieldName: string | undefined;
1925
1974
  /**
1926
1975
  * <p>The type of the provider schema attribute.</p>
1976
+ * <p>LiveRamp supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1977
+ * <code>NAME_MIDDLE</code> | <code>NAME_LAST</code> | <code>ADDRESS</code> |
1978
+ * <code>ADDRESS_STREET1</code> | <code>ADDRESS_STREET2</code> |
1979
+ * <code>ADDRESS_STREET3</code> | <code>ADDRESS_CITY</code> | <code>ADDRESS_STATE</code> |
1980
+ * <code>ADDRESS_COUNTRY</code> | <code>ADDRESS_POSTALCODE</code> | <code>PHONE</code> |
1981
+ * <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> | <code>UNIQUE_ID</code> |
1982
+ * <code>PROVIDER_ID</code>
1983
+ * </p>
1984
+ * <p>TransUnion supports: <code>NAME</code> | <code>NAME_FIRST</code> |
1985
+ * <code>NAME_LAST</code> | <code>ADDRESS</code> | <code>ADDRESS_CITY</code> |
1986
+ * <code>ADDRESS_STATE</code> | <code>ADDRESS_COUNTRY</code> |
1987
+ * <code>ADDRESS_POSTALCODE</code> | <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code>
1988
+ * | <code>UNIQUE_ID</code> | <code>DATE</code> | <code>IPV4</code> | <code>IPV6</code> |
1989
+ * <code>MAID</code>
1990
+ * </p>
1991
+ * <p>Unified ID 2.0 supports: <code>PHONE_NUMBER</code> | <code>EMAIL_ADDRESS</code> |
1992
+ * <code>UNIQUE_ID</code>
1993
+ * </p>
1927
1994
  * @public
1928
1995
  */
1929
1996
  type: SchemaAttributeType | undefined;
@@ -302,6 +302,9 @@ export declare const SchemaAttributeType: {
302
302
  readonly ADDRESS_STREET3: "ADDRESS_STREET3";
303
303
  readonly DATE: "DATE";
304
304
  readonly EMAIL_ADDRESS: "EMAIL_ADDRESS";
305
+ readonly IPV4: "IPV4";
306
+ readonly IPV6: "IPV6";
307
+ readonly MAID: "MAID";
305
308
  readonly NAME: "NAME";
306
309
  readonly NAME_FIRST: "NAME_FIRST";
307
310
  readonly NAME_LAST: "NAME_LAST";
@@ -382,6 +385,7 @@ export interface IdMappingJobMetrics {
382
385
  totalMappedRecords?: number | undefined;
383
386
  totalMappedSourceRecords?: number | undefined;
384
387
  totalMappedTargetRecords?: number | undefined;
388
+ uniqueRecordsLoaded?: number | undefined;
385
389
  }
386
390
  export interface IdMappingJobOutputSource {
387
391
  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.794.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",