Skip to content

Commit 697753c

Browse files
author
awstools
committed
feat(client-entityresolution): Add support for generating match IDs in near real-time.
1 parent 88f2623 commit 697753c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1139
-976
lines changed

clients/client-entityresolution/README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,7 @@
66

77
AWS SDK for JavaScript EntityResolution Client for Node.js, Browser and React Native.
88

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
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-
<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 User Guide</a>.</p>
9+
<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>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>
2010

2111
## Installing
2212

@@ -300,6 +290,14 @@ DeleteSchemaMapping
300290

301291
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/entityresolution/command/DeleteSchemaMappingCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/DeleteSchemaMappingCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/DeleteSchemaMappingCommandOutput/)
302292

293+
</details>
294+
<details>
295+
<summary>
296+
GenerateMatchId
297+
</summary>
298+
299+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/entityresolution/command/GenerateMatchIdCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/GenerateMatchIdCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/GenerateMatchIdCommandOutput/)
300+
303301
</details>
304302
<details>
305303
<summary>

clients/client-entityresolution/src/EntityResolution.ts

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ import {
5757
DeleteSchemaMappingCommandInput,
5858
DeleteSchemaMappingCommandOutput,
5959
} from "./commands/DeleteSchemaMappingCommand";
60+
import {
61+
GenerateMatchIdCommand,
62+
GenerateMatchIdCommandInput,
63+
GenerateMatchIdCommandOutput,
64+
} from "./commands/GenerateMatchIdCommand";
6065
import {
6166
GetIdMappingJobCommand,
6267
GetIdMappingJobCommandInput,
@@ -185,6 +190,7 @@ const commands = {
185190
DeleteMatchingWorkflowCommand,
186191
DeletePolicyStatementCommand,
187192
DeleteSchemaMappingCommand,
193+
GenerateMatchIdCommand,
188194
GetIdMappingJobCommand,
189195
GetIdMappingWorkflowCommand,
190196
GetIdNamespaceCommand,
@@ -401,6 +407,20 @@ export interface EntityResolution {
401407
cb: (err: any, data?: DeleteSchemaMappingCommandOutput) => void
402408
): void;
403409

410+
/**
411+
* @see {@link GenerateMatchIdCommand}
412+
*/
413+
generateMatchId(
414+
args: GenerateMatchIdCommandInput,
415+
options?: __HttpHandlerOptions
416+
): Promise<GenerateMatchIdCommandOutput>;
417+
generateMatchId(args: GenerateMatchIdCommandInput, cb: (err: any, data?: GenerateMatchIdCommandOutput) => void): void;
418+
generateMatchId(
419+
args: GenerateMatchIdCommandInput,
420+
options: __HttpHandlerOptions,
421+
cb: (err: any, data?: GenerateMatchIdCommandOutput) => void
422+
): void;
423+
404424
/**
405425
* @see {@link GetIdMappingJobCommand}
406426
*/
@@ -811,17 +831,7 @@ export interface EntityResolution {
811831
}
812832

813833
/**
814-
* <p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
815-
* <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity
816-
* resolution capabilities that enable developers and analysts at advertising and marketing
817-
* companies to build an accurate and complete view of their consumers.</p>
818-
* <p> With Entity Resolution, you can match source records containing consumer identifiers,
819-
* such as name, email address, and phone number. This is true even when these records have
820-
* incomplete or conflicting identifiers. For example, Entity Resolution can effectively match
821-
* a source record from a customer relationship management (CRM) system with a source record
822-
* from a marketing system containing campaign information.</p>
823-
* <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
824-
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution User Guide</a>.</p>
834+
* <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>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>
825835
* @public
826836
*/
827837
export class EntityResolution extends EntityResolutionClient implements EntityResolution {}

clients/client-entityresolution/src/EntityResolutionClient.ts

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ import {
8888
DeleteSchemaMappingCommandInput,
8989
DeleteSchemaMappingCommandOutput,
9090
} from "./commands/DeleteSchemaMappingCommand";
91+
import { GenerateMatchIdCommandInput, GenerateMatchIdCommandOutput } from "./commands/GenerateMatchIdCommand";
9192
import { GetIdMappingJobCommandInput, GetIdMappingJobCommandOutput } from "./commands/GetIdMappingJobCommand";
9293
import {
9394
GetIdMappingWorkflowCommandInput,
@@ -167,6 +168,7 @@ export type ServiceInputTypes =
167168
| DeleteMatchingWorkflowCommandInput
168169
| DeletePolicyStatementCommandInput
169170
| DeleteSchemaMappingCommandInput
171+
| GenerateMatchIdCommandInput
170172
| GetIdMappingJobCommandInput
171173
| GetIdMappingWorkflowCommandInput
172174
| GetIdNamespaceCommandInput
@@ -209,6 +211,7 @@ export type ServiceOutputTypes =
209211
| DeleteMatchingWorkflowCommandOutput
210212
| DeletePolicyStatementCommandOutput
211213
| DeleteSchemaMappingCommandOutput
214+
| GenerateMatchIdCommandOutput
212215
| GetIdMappingJobCommandOutput
213216
| GetIdMappingWorkflowCommandOutput
214217
| GetIdNamespaceCommandOutput
@@ -427,17 +430,7 @@ export type EntityResolutionClientResolvedConfigType = __SmithyResolvedConfigura
427430
export interface EntityResolutionClientResolvedConfig extends EntityResolutionClientResolvedConfigType {}
428431

429432
/**
430-
* <p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
431-
* <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity
432-
* resolution capabilities that enable developers and analysts at advertising and marketing
433-
* companies to build an accurate and complete view of their consumers.</p>
434-
* <p> With Entity Resolution, you can match source records containing consumer identifiers,
435-
* such as name, email address, and phone number. This is true even when these records have
436-
* incomplete or conflicting identifiers. For example, Entity Resolution can effectively match
437-
* a source record from a customer relationship management (CRM) system with a source record
438-
* from a marketing system containing campaign information.</p>
439-
* <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
440-
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution User Guide</a>.</p>
433+
* <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>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>
441434
* @public
442435
*/
443436
export class EntityResolutionClient extends __Client<

clients/client-entityresolution/src/commands/AddPolicyStatementCommand.ts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface AddPolicyStatementCommandInput extends AddPolicyStatementInput
2828
export interface AddPolicyStatementCommandOutput extends AddPolicyStatementOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Adds a policy statement object. To retrieve a list of existing policy statements, use
32-
* the <code>GetPolicy</code> API.</p>
31+
* <p>Adds a policy statement object. To retrieve a list of existing policy statements, use the <code>GetPolicy</code> API.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -68,13 +67,10 @@ export interface AddPolicyStatementCommandOutput extends AddPolicyStatementOutpu
6867
* <p>You do not have sufficient access to perform this action. </p>
6968
*
7069
* @throws {@link ConflictException} (client fault)
71-
* <p>The request could not be processed because of conflict in the current state of the
72-
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
73-
* running, etc. </p>
70+
* <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
7471
*
7572
* @throws {@link InternalServerException} (server fault)
76-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
77-
* service. </p>
73+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
7874
*
7975
* @throws {@link ResourceNotFoundException} (client fault)
8076
* <p>The resource could not be found. </p>

clients/client-entityresolution/src/commands/BatchDeleteUniqueIdCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ export interface BatchDeleteUniqueIdCommandOutput extends BatchDeleteUniqueIdOut
7171
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
7272
*
7373
* @throws {@link InternalServerException} (server fault)
74-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
75-
* service. </p>
74+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
7675
*
7776
* @throws {@link ResourceNotFoundException} (client fault)
7877
* <p>The resource could not be found. </p>

clients/client-entityresolution/src/commands/CreateIdMappingWorkflowCommand.ts

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface CreateIdMappingWorkflowCommandInput extends CreateIdMappingWork
2828
export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the
32-
* data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique
33-
* workflow name. To modify an existing workflow, use the <code>UpdateIdMappingWorkflow</code>
34-
* API.</p>
31+
* <p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the <code>UpdateIdMappingWorkflow</code> API.</p>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript
@@ -139,18 +136,13 @@ export interface CreateIdMappingWorkflowCommandOutput extends CreateIdMappingWor
139136
* <p>You do not have sufficient access to perform this action. </p>
140137
*
141138
* @throws {@link ConflictException} (client fault)
142-
* <p>The request could not be processed because of conflict in the current state of the
143-
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
144-
* running, etc. </p>
139+
* <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
145140
*
146141
* @throws {@link ExceedsLimitException} (client fault)
147-
* <p>The request was rejected because it attempted to create resources beyond the current
148-
* Entity Resolution account limits. The error message describes the limit exceeded.
149-
* </p>
142+
* <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. </p>
150143
*
151144
* @throws {@link InternalServerException} (server fault)
152-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
153-
* service. </p>
145+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
154146
*
155147
* @throws {@link ThrottlingException} (client fault)
156148
* <p>The request was denied due to request throttling. </p>

clients/client-entityresolution/src/commands/CreateIdNamespaceCommand.ts

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface CreateIdNamespaceCommandInput extends CreateIdNamespaceInput {}
2828
export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an ID namespace object which will help customers provide metadata explaining
32-
* their dataset and how to use it. Each ID namespace must have a unique name. To modify an
33-
* existing ID namespace, use the <code>UpdateIdNamespace</code> API.</p>
31+
* <p>Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the <code>UpdateIdNamespace</code> API.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript
@@ -137,18 +135,13 @@ export interface CreateIdNamespaceCommandOutput extends CreateIdNamespaceOutput,
137135
* <p>You do not have sufficient access to perform this action. </p>
138136
*
139137
* @throws {@link ConflictException} (client fault)
140-
* <p>The request could not be processed because of conflict in the current state of the
141-
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
142-
* running, etc. </p>
138+
* <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
143139
*
144140
* @throws {@link ExceedsLimitException} (client fault)
145-
* <p>The request was rejected because it attempted to create resources beyond the current
146-
* Entity Resolution account limits. The error message describes the limit exceeded.
147-
* </p>
141+
* <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. </p>
148142
*
149143
* @throws {@link InternalServerException} (server fault)
150-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
151-
* service. </p>
144+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
152145
*
153146
* @throws {@link ThrottlingException} (client fault)
154147
* <p>The request was denied due to request throttling. </p>

clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface CreateMatchingWorkflowCommandInput extends CreateMatchingWorkfl
2828
export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkflowOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a <code>MatchingWorkflow</code> object which stores the configuration of the
32-
* data processing job to be run. It is important to note that there should not be a
33-
* pre-existing <code>MatchingWorkflow</code> with the same name. To modify an existing
34-
* workflow, utilize the <code>UpdateMatchingWorkflow</code> API.</p>
31+
* <p>Creates a <code>MatchingWorkflow</code> object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing <code>MatchingWorkflow</code> with the same name. To modify an existing workflow, utilize the <code>UpdateMatchingWorkflow</code> API.</p>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript
@@ -157,18 +154,13 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
157154
* <p>You do not have sufficient access to perform this action. </p>
158155
*
159156
* @throws {@link ConflictException} (client fault)
160-
* <p>The request could not be processed because of conflict in the current state of the
161-
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
162-
* running, etc. </p>
157+
* <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
163158
*
164159
* @throws {@link ExceedsLimitException} (client fault)
165-
* <p>The request was rejected because it attempted to create resources beyond the current
166-
* Entity Resolution account limits. The error message describes the limit exceeded.
167-
* </p>
160+
* <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. </p>
168161
*
169162
* @throws {@link InternalServerException} (server fault)
170-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
171-
* service. </p>
163+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
172164
*
173165
* @throws {@link ThrottlingException} (client fault)
174166
* <p>The request was denied due to request throttling. </p>

0 commit comments

Comments
 (0)