Skip to content

Commit f5dd707

Browse files
author
awstools
committed
feat(client-entityresolution): Changed "ResolutionTechniques" and "MappedInputFields" in workflow and schema mapping operations to be required fields.
1 parent 51a93f3 commit f5dd707

22 files changed

+155
-148
lines changed

‎clients/client-entityresolution/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,17 @@
66

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

9-
<p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
10-
<p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
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
1111
that enable developers and analysts at advertising and marketing companies to build an accurate and
1212
complete view of their consumers.</p>
1313
<p>
14-
With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
15-
such as name, email address, and phone number. This holds true even when these records have incomplete or
16-
conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
17-
customer relationship management (CRM) system, which includes account information like first name, last name,
18-
postal address, phone number, and email address, with a source record from a marketing system containing
19-
campaign information, such as username and email address.</p>
20-
<p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
21-
<a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
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>
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
2220
User Guide</a>.</p>
2321

2422
## Installing

‎clients/client-entityresolution/src/EntityResolution.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -350,19 +350,17 @@ export interface EntityResolution {
350350

351351
/**
352352
* @public
353-
* <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
354-
* <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
353+
* <p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
354+
* <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities
355355
* that enable developers and analysts at advertising and marketing companies to build an accurate and
356356
* complete view of their consumers.</p>
357357
* <p>
358-
* With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
359-
* such as name, email address, and phone number. This holds true even when these records have incomplete or
360-
* conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
361-
* customer relationship management (CRM) system, which includes account information like first name, last name,
362-
* postal address, phone number, and email address, with a source record from a marketing system containing
363-
* campaign information, such as username and email address.</p>
364-
* <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
365-
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
358+
* With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address,
359+
* and phone number. This is true even when these records have incomplete or conflicting identifiers. For example,
360+
* Entity Resolution can effectively match a source record from a customer relationship management (CRM) system
361+
* with a source record from a marketing system containing campaign information.</p>
362+
* <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
363+
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution
366364
* User Guide</a>.</p>
367365
*/
368366
export class EntityResolution extends EntityResolutionClient implements EntityResolution {}

‎clients/client-entityresolution/src/EntityResolutionClient.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -313,19 +313,17 @@ export interface EntityResolutionClientResolvedConfig extends EntityResolutionCl
313313

314314
/**
315315
* @public
316-
* <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
317-
* <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
316+
* <p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
317+
* <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities
318318
* that enable developers and analysts at advertising and marketing companies to build an accurate and
319319
* complete view of their consumers.</p>
320320
* <p>
321-
* With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
322-
* such as name, email address, and phone number. This holds true even when these records have incomplete or
323-
* conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
324-
* customer relationship management (CRM) system, which includes account information like first name, last name,
325-
* postal address, phone number, and email address, with a source record from a marketing system containing
326-
* campaign information, such as username and email address.</p>
327-
* <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
328-
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
321+
* With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address,
322+
* and phone number. This is true even when these records have incomplete or conflicting identifiers. For example,
323+
* Entity Resolution can effectively match a source record from a customer relationship management (CRM) system
324+
* with a source record from a marketing system containing campaign information.</p>
325+
* <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
326+
* <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution
329327
* User Guide</a>.</p>
330328
*/
331329
export class EntityResolutionClient extends __Client<

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
5858
* outputSourceConfig: [ // OutputSourceConfig // required
5959
* { // OutputSource
6060
* outputS3Path: "STRING_VALUE", // required
61+
* KMSArn: "STRING_VALUE",
6162
* output: [ // OutputAttributes // required
6263
* { // OutputAttribute
6364
* name: "STRING_VALUE", // required
6465
* hashed: true || false,
6566
* },
6667
* ],
67-
* KMSArn: "STRING_VALUE",
6868
* applyNormalization: true || false,
6969
* },
7070
* ],
7171
* resolutionTechniques: { // ResolutionTechniques
72-
* resolutionType: "RULE_MATCHING" || "ML_MATCHING",
72+
* resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
7373
* ruleBasedProperties: { // RuleBasedProperties
7474
* rules: [ // RuleList // required
7575
* { // Rule
@@ -106,18 +106,18 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
106106
* // outputSourceConfig: [ // OutputSourceConfig // required
107107
* // { // OutputSource
108108
* // outputS3Path: "STRING_VALUE", // required
109+
* // KMSArn: "STRING_VALUE",
109110
* // output: [ // OutputAttributes // required
110111
* // { // OutputAttribute
111112
* // name: "STRING_VALUE", // required
112113
* // hashed: true || false,
113114
* // },
114115
* // ],
115-
* // KMSArn: "STRING_VALUE",
116116
* // applyNormalization: true || false,
117117
* // },
118118
* // ],
119119
* // resolutionTechniques: { // ResolutionTechniques
120-
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING",
120+
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
121121
* // ruleBasedProperties: { // RuleBasedProperties
122122
* // rules: [ // RuleList // required
123123
* // { // Rule
@@ -154,20 +154,20 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
154154
* </p>
155155
*
156156
* @throws {@link ExceedsLimitException} (client fault)
157-
* <p>The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
157+
* <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits.
158158
* The error message describes the limit exceeded. <code>HTTP Status Code: 402</code>
159159
* </p>
160160
*
161161
* @throws {@link InternalServerException} (server fault)
162-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
162+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
163163
* </p>
164164
*
165165
* @throws {@link ThrottlingException} (client fault)
166166
* <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
167167
* </p>
168168
*
169169
* @throws {@link ValidationException} (client fault)
170-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
170+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
171171
* </p>
172172
*
173173
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
4848
* const input = { // CreateSchemaMappingInput
4949
* schemaName: "STRING_VALUE", // required
5050
* description: "STRING_VALUE",
51-
* mappedInputFields: [ // SchemaInputAttributes
51+
* mappedInputFields: [ // SchemaInputAttributes // required
5252
* { // SchemaInputAttribute
5353
* fieldName: "STRING_VALUE", // required
5454
* 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", // required
@@ -94,20 +94,20 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
9494
* </p>
9595
*
9696
* @throws {@link ExceedsLimitException} (client fault)
97-
* <p>The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
97+
* <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits.
9898
* The error message describes the limit exceeded. <code>HTTP Status Code: 402</code>
9999
* </p>
100100
*
101101
* @throws {@link InternalServerException} (server fault)
102-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
102+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
103103
* </p>
104104
*
105105
* @throws {@link ThrottlingException} (client fault)
106106
* <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
107107
* </p>
108108
*
109109
* @throws {@link ValidationException} (client fault)
110-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
110+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
111111
* </p>
112112
*
113113
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf
6666
* </p>
6767
*
6868
* @throws {@link InternalServerException} (server fault)
69-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
69+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
7070
* </p>
7171
*
7272
* @throws {@link ThrottlingException} (client fault)
7373
* <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
7474
* </p>
7575
*
7676
* @throws {@link ValidationException} (client fault)
77-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
77+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
7878
* </p>
7979
*
8080
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut
7272
* </p>
7373
*
7474
* @throws {@link InternalServerException} (server fault)
75-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
75+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
7676
* </p>
7777
*
7878
* @throws {@link ThrottlingException} (client fault)
7979
* <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
8080
* </p>
8181
*
8282
* @throws {@link ValidationException} (client fault)
83-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
83+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
8484
* </p>
8585
*
8686
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/GetMatchIdCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
6868
* </p>
6969
*
7070
* @throws {@link InternalServerException} (server fault)
71-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
71+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
7272
* </p>
7373
*
7474
* @throws {@link ResourceNotFoundException} (client fault)
@@ -80,7 +80,7 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
8080
* </p>
8181
*
8282
* @throws {@link ValidationException} (client fault)
83-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
83+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
8484
* </p>
8585
*
8686
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/GetMatchingJobCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
5757
* // metrics: { // JobMetrics
5858
* // inputRecords: Number("int"),
5959
* // totalRecordsProcessed: Number("int"),
60-
* // matchIDs: Number("int"),
6160
* // recordsNotProcessed: Number("int"),
61+
* // matchIDs: Number("int"),
6262
* // },
6363
* // errorDetails: { // ErrorDetails
6464
* // errorMessage: "STRING_VALUE",
@@ -78,7 +78,7 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
7878
* </p>
7979
*
8080
* @throws {@link InternalServerException} (server fault)
81-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
81+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
8282
* </p>
8383
*
8484
* @throws {@link ResourceNotFoundException} (client fault)
@@ -90,7 +90,7 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
9090
* </p>
9191
*
9292
* @throws {@link ValidationException} (client fault)
93-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
93+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
9494
* </p>
9595
*
9696
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
6262
* // outputSourceConfig: [ // OutputSourceConfig // required
6363
* // { // OutputSource
6464
* // outputS3Path: "STRING_VALUE", // required
65+
* // KMSArn: "STRING_VALUE",
6566
* // output: [ // OutputAttributes // required
6667
* // { // OutputAttribute
6768
* // name: "STRING_VALUE", // required
6869
* // hashed: true || false,
6970
* // },
7071
* // ],
71-
* // KMSArn: "STRING_VALUE",
7272
* // applyNormalization: true || false,
7373
* // },
7474
* // ],
7575
* // resolutionTechniques: { // ResolutionTechniques
76-
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING",
76+
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
7777
* // ruleBasedProperties: { // RuleBasedProperties
7878
* // rules: [ // RuleList // required
7979
* // { // Rule
@@ -110,7 +110,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
110110
* </p>
111111
*
112112
* @throws {@link InternalServerException} (server fault)
113-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
113+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
114114
* </p>
115115
*
116116
* @throws {@link ResourceNotFoundException} (client fault)
@@ -122,7 +122,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
122122
* </p>
123123
*
124124
* @throws {@link ValidationException} (client fault)
125-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
125+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
126126
* </p>
127127
*
128128
* @throws {@link EntityResolutionServiceException}

‎clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _
8080
* </p>
8181
*
8282
* @throws {@link InternalServerException} (server fault)
83-
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
83+
* <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
8484
* </p>
8585
*
8686
* @throws {@link ResourceNotFoundException} (client fault)
@@ -92,7 +92,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _
9292
* </p>
9393
*
9494
* @throws {@link ValidationException} (client fault)
95-
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
95+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
9696
* </p>
9797
*
9898
* @throws {@link EntityResolutionServiceException}

0 commit comments

Comments
 (0)