feat(client-entityresolution): Changed "ResolutionTechniques" and "Ma…

…ppedInputFields" in workflow and schema mapping operations to be required fields.
aws · Sep 14, 2023 · f5dd707 · f5dd707
1 parent 51a93f3
commit f5dd707
Show file tree

Hide file tree

Showing 22 changed files with 155 additions and 148 deletions.
diff --git a/clients/client-entityresolution/README.md b/clients/client-entityresolution/README.md
@@ -6,19 +6,17 @@
 
 AWS SDK for JavaScript EntityResolution Client for Node.js, Browser and React Native.
 
-<p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
-<p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
+<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 AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
-such as name, email address, and phone number. This holds true even when these records have incomplete or
-conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
-customer relationship management (CRM) system, which includes account information like first name, last name,
-postal address, phone number, and email address, with a source record from a marketing system containing
-campaign information, such as username and email address.</p>
-<p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
-<a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
+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>
 
 ## Installing

diff --git a/clients/client-entityresolution/src/EntityResolution.ts b/clients/client-entityresolution/src/EntityResolution.ts
@@ -350,19 +350,17 @@ export interface EntityResolution {
 
 /**
  * @public
- * <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
- *          <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
+ * <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 AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
- *          such as name, email address, and phone number. This holds true even when these records have incomplete or
- *          conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
- *          customer relationship management (CRM) system, which includes account information like first name, last name,
- *          postal address, phone number, and email address, with a source record from a marketing system containing
- *          campaign information, such as username and email address.</p>
- *          <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
- *          <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
+ *          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>
  */
 export class EntityResolution extends EntityResolutionClient implements EntityResolution {}

diff --git a/clients/client-entityresolution/src/EntityResolutionClient.ts b/clients/client-entityresolution/src/EntityResolutionClient.ts
@@ -313,19 +313,17 @@ export interface EntityResolutionClientResolvedConfig extends EntityResolutionCl
 
 /**
  * @public
- * <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
- *          <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
+ * <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 AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
- *          such as name, email address, and phone number. This holds true even when these records have incomplete or
- *          conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
- *          customer relationship management (CRM) system, which includes account information like first name, last name,
- *          postal address, phone number, and email address, with a source record from a marketing system containing
- *          campaign information, such as username and email address.</p>
- *          <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
- *          <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
+ *          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>
  */
 export class EntityResolutionClient extends __Client<

diff --git a/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts
@@ -58,18 +58,18 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  *   outputSourceConfig: [ // OutputSourceConfig // required
  *     { // OutputSource
  *       outputS3Path: "STRING_VALUE", // required
+ *       KMSArn: "STRING_VALUE",
  *       output: [ // OutputAttributes // required
  *         { // OutputAttribute
  *           name: "STRING_VALUE", // required
  *           hashed: true || false,
  *         },
  *       ],
- *       KMSArn: "STRING_VALUE",
  *       applyNormalization: true || false,
  *     },
  *   ],
  *   resolutionTechniques: { // ResolutionTechniques
- *     resolutionType: "RULE_MATCHING" || "ML_MATCHING",
+ *     resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
  *     ruleBasedProperties: { // RuleBasedProperties
  *       rules: [ // RuleList // required
  *         { // Rule
@@ -106,18 +106,18 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  * //   outputSourceConfig: [ // OutputSourceConfig // required
  * //     { // OutputSource
  * //       outputS3Path: "STRING_VALUE", // required
+ * //       KMSArn: "STRING_VALUE",
  * //       output: [ // OutputAttributes // required
  * //         { // OutputAttribute
  * //           name: "STRING_VALUE", // required
  * //           hashed: true || false,
  * //         },
  * //       ],
- * //       KMSArn: "STRING_VALUE",
  * //       applyNormalization: true || false,
  * //     },
  * //   ],
  * //   resolutionTechniques: { // ResolutionTechniques
- * //     resolutionType: "RULE_MATCHING" || "ML_MATCHING",
+ * //     resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
  * //     ruleBasedProperties: { // RuleBasedProperties
  * //       rules: [ // RuleList // required
  * //         { // Rule
@@ -154,20 +154,20 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf
  *          </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
- *  <p>The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ *  <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. <code>HTTP Status Code: 402</code>
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts
@@ -48,7 +48,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut
  * const input = { // CreateSchemaMappingInput
  *   schemaName: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   mappedInputFields: [ // SchemaInputAttributes
+ *   mappedInputFields: [ // SchemaInputAttributes // required
  *     { // SchemaInputAttribute
  *       fieldName: "STRING_VALUE", // required
  *       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
  *          </p>
  *
  * @throws {@link ExceedsLimitException} (client fault)
- *  <p>The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ *  <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. <code>HTTP Status Code: 402</code>
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts
@@ -66,15 +66,15 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts
@@ -72,15 +72,15 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/GetMatchIdCommand.ts b/clients/client-entityresolution/src/commands/GetMatchIdCommand.ts
@@ -68,7 +68,7 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -80,7 +80,7 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/GetMatchingJobCommand.ts b/clients/client-entityresolution/src/commands/GetMatchingJobCommand.ts
@@ -57,8 +57,8 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
  * //   metrics: { // JobMetrics
  * //     inputRecords: Number("int"),
  * //     totalRecordsProcessed: Number("int"),
- * //     matchIDs: Number("int"),
  * //     recordsNotProcessed: Number("int"),
+ * //     matchIDs: Number("int"),
  * //   },
  * //   errorDetails: { // ErrorDetails
  * //     errorMessage: "STRING_VALUE",
@@ -78,7 +78,7 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -90,7 +90,7 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts
@@ -62,18 +62,18 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
  * //   outputSourceConfig: [ // OutputSourceConfig // required
  * //     { // OutputSource
  * //       outputS3Path: "STRING_VALUE", // required
+ * //       KMSArn: "STRING_VALUE",
  * //       output: [ // OutputAttributes // required
  * //         { // OutputAttribute
  * //           name: "STRING_VALUE", // required
  * //           hashed: true || false,
  * //         },
  * //       ],
- * //       KMSArn: "STRING_VALUE",
  * //       applyNormalization: true || false,
  * //     },
  * //   ],
  * //   resolutionTechniques: { // ResolutionTechniques
- * //     resolutionType: "RULE_MATCHING" || "ML_MATCHING",
+ * //     resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
  * //     ruleBasedProperties: { // RuleBasedProperties
  * //       rules: [ // RuleList // required
  * //         { // Rule
@@ -110,7 +110,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -122,7 +122,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}

diff --git a/clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts
@@ -80,7 +80,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _
  *          </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *  <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
  *          </p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -92,7 +92,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _
  *          </p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *  <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
  *          </p>
  *
  * @throws {@link EntityResolutionServiceException}