7
7
AWS SDK for JavaScript EntityResolution Client for Node.js, Browser and React Native.
8
8
9
9
<p >Welcome to the <i >Entity Resolution API Reference</i >.</p >
10
- <p >Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities
11
- that enable developers and analysts at advertising and marketing companies to build an accurate and
12
- complete view of their consumers.</p >
13
- <p >
14
- With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address,
15
- and phone number. This is true even when these records have incomplete or conflicting identifiers. For example,
16
- Entity Resolution can effectively match a source record from a customer relationship management (CRM) system
17
- with a source record from a marketing system containing campaign information.</p >
10
+ <p >Entity Resolution is an Amazon Web Services service that provides pre-configured entity
11
+ resolution capabilities that enable developers and analysts at advertising and marketing
12
+ companies to build an accurate and complete view of their consumers.</p >
13
+ <p > With Entity Resolution, you can match source records containing consumer identifiers,
14
+ such as name, email address, and phone number. This is true even when these records have
15
+ incomplete or conflicting identifiers. For example, Entity Resolution can effectively match
16
+ a source record from a customer relationship management (CRM) system with a source record
17
+ from a marketing system containing campaign information.</p >
18
18
<p >To learn more about Entity Resolution concepts, procedures, and best practices, see the
19
- <a href =" https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html " >Entity Resolution
20
- User Guide</a >.</p >
19
+ <a href =" https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html " >Entity Resolution User Guide</a >.</p >
21
20
22
21
## Installing
23
22
@@ -34,16 +33,16 @@ using your favorite package manager:
34
33
35
34
The AWS SDK is modulized by clients and commands.
36
35
To send a request, you only need to import the ` EntityResolutionClient ` and
37
- the commands you need, for example ` ListMatchingJobsCommand ` :
36
+ the commands you need, for example ` ListIdMappingJobsCommand ` :
38
37
39
38
``` js
40
39
// ES5 example
41
- const { EntityResolutionClient , ListMatchingJobsCommand } = require (" @aws-sdk/client-entityresolution" );
40
+ const { EntityResolutionClient , ListIdMappingJobsCommand } = require (" @aws-sdk/client-entityresolution" );
42
41
```
43
42
44
43
``` ts
45
44
// ES6+ example
46
- import { EntityResolutionClient , ListMatchingJobsCommand } from " @aws-sdk/client-entityresolution" ;
45
+ import { EntityResolutionClient , ListIdMappingJobsCommand } from " @aws-sdk/client-entityresolution" ;
47
46
```
48
47
49
48
### Usage
@@ -62,7 +61,7 @@ const client = new EntityResolutionClient({ region: "REGION" });
62
61
const params = {
63
62
/** input parameters */
64
63
};
65
- const command = new ListMatchingJobsCommand (params);
64
+ const command = new ListIdMappingJobsCommand (params);
66
65
```
67
66
68
67
#### Async/await
@@ -141,15 +140,15 @@ const client = new AWS.EntityResolution({ region: "REGION" });
141
140
142
141
// async/await.
143
142
try {
144
- const data = await client .listMatchingJobs (params );
143
+ const data = await client .listIdMappingJobs (params );
145
144
// process data.
146
145
} catch (error ) {
147
146
// error handling.
148
147
}
149
148
150
149
// Promises.
151
150
client
152
- .listMatchingJobs (params )
151
+ .listIdMappingJobs (params )
153
152
.then ((data ) => {
154
153
// process data.
155
154
})
@@ -158,7 +157,7 @@ client
158
157
});
159
158
160
159
// callbacks.
161
- client .listMatchingJobs (params , (err , data ) => {
160
+ client .listIdMappingJobs (params , (err , data ) => {
162
161
// process err and data.
163
162
});
164
163
```
@@ -214,6 +213,14 @@ see LICENSE for more information.
214
213
215
214
## Client Commands (Operations List)
216
215
216
+ <details >
217
+ <summary >
218
+ CreateIdMappingWorkflow
219
+ </summary >
220
+
221
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/createidmappingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/createidmappingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/createidmappingworkflowcommandoutput.html )
222
+
223
+ </details >
217
224
<details >
218
225
<summary >
219
226
CreateMatchingWorkflow
@@ -229,6 +236,14 @@ CreateSchemaMapping
229
236
230
237
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/createschemamappingcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/createschemamappingcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/createschemamappingcommandoutput.html )
231
238
239
+ </details >
240
+ <details >
241
+ <summary >
242
+ DeleteIdMappingWorkflow
243
+ </summary >
244
+
245
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/deleteidmappingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/deleteidmappingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/deleteidmappingworkflowcommandoutput.html )
246
+
232
247
</details >
233
248
<details >
234
249
<summary >
@@ -245,6 +260,22 @@ DeleteSchemaMapping
245
260
246
261
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/deleteschemamappingcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/deleteschemamappingcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/deleteschemamappingcommandoutput.html )
247
262
263
+ </details >
264
+ <details >
265
+ <summary >
266
+ GetIdMappingJob
267
+ </summary >
268
+
269
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/getidmappingjobcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getidmappingjobcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getidmappingjobcommandoutput.html )
270
+
271
+ </details >
272
+ <details >
273
+ <summary >
274
+ GetIdMappingWorkflow
275
+ </summary >
276
+
277
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/getidmappingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getidmappingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getidmappingworkflowcommandoutput.html )
278
+
248
279
</details >
249
280
<details >
250
281
<summary >
@@ -269,6 +300,14 @@ GetMatchingWorkflow
269
300
270
301
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/getmatchingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getmatchingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getmatchingworkflowcommandoutput.html )
271
302
303
+ </details >
304
+ <details >
305
+ <summary >
306
+ GetProviderService
307
+ </summary >
308
+
309
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/getproviderservicecommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getproviderservicecommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getproviderservicecommandoutput.html )
310
+
272
311
</details >
273
312
<details >
274
313
<summary >
@@ -277,6 +316,22 @@ GetSchemaMapping
277
316
278
317
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/getschemamappingcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getschemamappingcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/getschemamappingcommandoutput.html )
279
318
319
+ </details >
320
+ <details >
321
+ <summary >
322
+ ListIdMappingJobs
323
+ </summary >
324
+
325
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/listidmappingjobscommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listidmappingjobscommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listidmappingjobscommandoutput.html )
326
+
327
+ </details >
328
+ <details >
329
+ <summary >
330
+ ListIdMappingWorkflows
331
+ </summary >
332
+
333
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/listidmappingworkflowscommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listidmappingworkflowscommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listidmappingworkflowscommandoutput.html )
334
+
280
335
</details >
281
336
<details >
282
337
<summary >
@@ -293,6 +348,14 @@ ListMatchingWorkflows
293
348
294
349
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/listmatchingworkflowscommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listmatchingworkflowscommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listmatchingworkflowscommandoutput.html )
295
350
351
+ </details >
352
+ <details >
353
+ <summary >
354
+ ListProviderServices
355
+ </summary >
356
+
357
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/listproviderservicescommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listproviderservicescommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listproviderservicescommandoutput.html )
358
+
296
359
</details >
297
360
<details >
298
361
<summary >
@@ -309,6 +372,14 @@ ListTagsForResource
309
372
310
373
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/listtagsforresourcecommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listtagsforresourcecommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/listtagsforresourcecommandoutput.html )
311
374
375
+ </details >
376
+ <details >
377
+ <summary >
378
+ StartIdMappingJob
379
+ </summary >
380
+
381
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/startidmappingjobcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/startidmappingjobcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/startidmappingjobcommandoutput.html )
382
+
312
383
</details >
313
384
<details >
314
385
<summary >
@@ -333,6 +404,14 @@ UntagResource
333
404
334
405
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/untagresourcecommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/untagresourcecommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/untagresourcecommandoutput.html )
335
406
407
+ </details >
408
+ <details >
409
+ <summary >
410
+ UpdateIdMappingWorkflow
411
+ </summary >
412
+
413
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/updateidmappingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updateidmappingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updateidmappingworkflowcommandoutput.html )
414
+
336
415
</details >
337
416
<details >
338
417
<summary >
@@ -342,3 +421,11 @@ UpdateMatchingWorkflow
342
421
[ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/updatematchingworkflowcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updatematchingworkflowcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updatematchingworkflowcommandoutput.html )
343
422
344
423
</details >
424
+ <details >
425
+ <summary >
426
+ UpdateSchemaMapping
427
+ </summary >
428
+
429
+ [ Command API Reference] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/classes/updateschemamappingcommand.html ) / [ Input] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updateschemamappingcommandinput.html ) / [ Output] ( https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-entityresolution/interfaces/updateschemamappingcommandoutput.html )
430
+
431
+ </details >
0 commit comments