Skip to content

Commit ba8b3ef

Browse files
author
awstools
committed
feat(client-entityresolution): This launch expands our matching techniques to include provider-based matching to help customer match, link, and enhance records with minimal data movement. With data service providers, we have removed the need for customers to build bespoke integrations,.
1 parent 8a89009 commit ba8b3ef

40 files changed

+10270
-3585
lines changed

clients/client-entityresolution/README.md

Lines changed: 104 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,16 @@
77
AWS SDK for JavaScript EntityResolution Client for Node.js, Browser and React Native.
88

99
<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>
1818
<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>
2120

2221
## Installing
2322

@@ -34,16 +33,16 @@ using your favorite package manager:
3433

3534
The AWS SDK is modulized by clients and commands.
3635
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`:
3837

3938
```js
4039
// ES5 example
41-
const { EntityResolutionClient, ListMatchingJobsCommand } = require("@aws-sdk/client-entityresolution");
40+
const { EntityResolutionClient, ListIdMappingJobsCommand } = require("@aws-sdk/client-entityresolution");
4241
```
4342

4443
```ts
4544
// ES6+ example
46-
import { EntityResolutionClient, ListMatchingJobsCommand } from "@aws-sdk/client-entityresolution";
45+
import { EntityResolutionClient, ListIdMappingJobsCommand } from "@aws-sdk/client-entityresolution";
4746
```
4847

4948
### Usage
@@ -62,7 +61,7 @@ const client = new EntityResolutionClient({ region: "REGION" });
6261
const params = {
6362
/** input parameters */
6463
};
65-
const command = new ListMatchingJobsCommand(params);
64+
const command = new ListIdMappingJobsCommand(params);
6665
```
6766

6867
#### Async/await
@@ -141,15 +140,15 @@ const client = new AWS.EntityResolution({ region: "REGION" });
141140

142141
// async/await.
143142
try {
144-
const data = await client.listMatchingJobs(params);
143+
const data = await client.listIdMappingJobs(params);
145144
// process data.
146145
} catch (error) {
147146
// error handling.
148147
}
149148

150149
// Promises.
151150
client
152-
.listMatchingJobs(params)
151+
.listIdMappingJobs(params)
153152
.then((data) => {
154153
// process data.
155154
})
@@ -158,7 +157,7 @@ client
158157
});
159158

160159
// callbacks.
161-
client.listMatchingJobs(params, (err, data) => {
160+
client.listIdMappingJobs(params, (err, data) => {
162161
// process err and data.
163162
});
164163
```
@@ -214,6 +213,14 @@ see LICENSE for more information.
214213

215214
## Client Commands (Operations List)
216215

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>
217224
<details>
218225
<summary>
219226
CreateMatchingWorkflow
@@ -229,6 +236,14 @@ CreateSchemaMapping
229236

230237
[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)
231238

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+
232247
</details>
233248
<details>
234249
<summary>
@@ -245,6 +260,22 @@ DeleteSchemaMapping
245260

246261
[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)
247262

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+
248279
</details>
249280
<details>
250281
<summary>
@@ -269,6 +300,14 @@ GetMatchingWorkflow
269300

270301
[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)
271302

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+
272311
</details>
273312
<details>
274313
<summary>
@@ -277,6 +316,22 @@ GetSchemaMapping
277316

278317
[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)
279318

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+
280335
</details>
281336
<details>
282337
<summary>
@@ -293,6 +348,14 @@ ListMatchingWorkflows
293348

294349
[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)
295350

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+
296359
</details>
297360
<details>
298361
<summary>
@@ -309,6 +372,14 @@ ListTagsForResource
309372

310373
[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)
311374

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+
312383
</details>
313384
<details>
314385
<summary>
@@ -333,6 +404,14 @@ UntagResource
333404

334405
[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)
335406

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+
336415
</details>
337416
<details>
338417
<summary>
@@ -342,3 +421,11 @@ UpdateMatchingWorkflow
342421
[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)
343422

344423
</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

Comments
 (0)