Skip to content

Commit

Permalink
feat(client-entityresolution): This launch expands our matching techn…
Browse files Browse the repository at this point in the history 
…iques 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,.
  • Loading branch information
awstools committed Oct 16, 2023
1 parent 8a89009 commit ba8b3ef
Show file tree
Hide file tree
Showing 40 changed files with 10,270 additions and 3,585 deletions.
121 changes: 104 additions & 17 deletions clients/client-entityresolution/README.md
View file
Expand Up @@ -7,17 +7,16 @@
AWS SDK for JavaScript EntityResolution Client for Node.js, Browser and React Native.

<p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
<p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities
that enable developers and analysts at advertising and marketing companies to build an accurate and
complete view of their consumers.</p>
<p>
With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address,
and phone number. This is true even when these records have incomplete or conflicting identifiers. For example,
Entity Resolution can effectively match a source record from a customer relationship management (CRM) system
with a source record from a marketing system containing campaign information.</p>
<p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity
resolution capabilities that enable developers and analysts at advertising and marketing
companies to build an accurate and complete view of their consumers.</p>
<p> With Entity Resolution, you can match source records containing consumer identifiers,
such as name, email address, and phone number. This is true even when these records have
incomplete or conflicting identifiers. For example, Entity Resolution can effectively match
a source record from a customer relationship management (CRM) system with a source record
from a marketing system containing campaign information.</p>
<p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
<a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution
User Guide</a>.</p>
<a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution User Guide</a>.</p>

## Installing

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

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the `EntityResolutionClient` and
the commands you need, for example `ListMatchingJobsCommand`:
the commands you need, for example `ListIdMappingJobsCommand`:

```js
// ES5 example
const { EntityResolutionClient, ListMatchingJobsCommand } = require("@aws-sdk/client-entityresolution");
const { EntityResolutionClient, ListIdMappingJobsCommand } = require("@aws-sdk/client-entityresolution");
```

```ts
// ES6+ example
import { EntityResolutionClient, ListMatchingJobsCommand } from "@aws-sdk/client-entityresolution";
import { EntityResolutionClient, ListIdMappingJobsCommand } from "@aws-sdk/client-entityresolution";
```

### Usage
Expand All @@ -62,7 +61,7 @@ const client = new EntityResolutionClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListMatchingJobsCommand(params);
const command = new ListIdMappingJobsCommand(params);
```

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

// async/await.
try {
const data = await client.listMatchingJobs(params);
const data = await client.listIdMappingJobs(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listMatchingJobs(params)
.listIdMappingJobs(params)
.then((data) => {
// process data.
})
Expand All @@ -158,7 +157,7 @@ client
});

// callbacks.
client.listMatchingJobs(params, (err, data) => {
client.listIdMappingJobs(params, (err, data) => {
// process err and data.
});
```
Expand Down Expand Up @@ -214,6 +213,14 @@ see LICENSE for more information.

## Client Commands (Operations List)

<details>
<summary>
CreateIdMappingWorkflow
</summary>

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

</details>
<details>
<summary>
CreateMatchingWorkflow
Expand All @@ -229,6 +236,14 @@ CreateSchemaMapping

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

</details>
<details>
<summary>
DeleteIdMappingWorkflow
</summary>

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

</details>
<details>
<summary>
Expand All @@ -245,6 +260,22 @@ DeleteSchemaMapping

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

</details>
<details>
<summary>
GetIdMappingJob
</summary>

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

</details>
<details>
<summary>
GetIdMappingWorkflow
</summary>

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

</details>
<details>
<summary>
Expand All @@ -269,6 +300,14 @@ GetMatchingWorkflow

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

</details>
<details>
<summary>
GetProviderService
</summary>

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

</details>
<details>
<summary>
Expand All @@ -277,6 +316,22 @@ GetSchemaMapping

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

</details>
<details>
<summary>
ListIdMappingJobs
</summary>

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

</details>
<details>
<summary>
ListIdMappingWorkflows
</summary>

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

</details>
<details>
<summary>
Expand All @@ -293,6 +348,14 @@ ListMatchingWorkflows

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

</details>
<details>
<summary>
ListProviderServices
</summary>

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

</details>
<details>
<summary>
Expand All @@ -309,6 +372,14 @@ ListTagsForResource

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

</details>
<details>
<summary>
StartIdMappingJob
</summary>

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

</details>
<details>
<summary>
Expand All @@ -333,6 +404,14 @@ UntagResource

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

</details>
<details>
<summary>
UpdateIdMappingWorkflow
</summary>

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

</details>
<details>
<summary>
Expand All @@ -342,3 +421,11 @@ UpdateMatchingWorkflow
[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)

</details>
<details>
<summary>
UpdateSchemaMapping
</summary>

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

</details>

0 comments on commit ba8b3ef

Please sign in to comment.