From f5dd707c33d833b62b5c18349d04ea4026e2dc91 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 14 Sep 2023 19:50:11 +0000 Subject: [PATCH] feat(client-entityresolution): Changed "ResolutionTechniques" and "MappedInputFields" in workflow and schema mapping operations to be required fields. --- clients/client-entityresolution/README.md | 18 ++- .../src/EntityResolution.ts | 18 ++- .../src/EntityResolutionClient.ts | 18 ++- .../commands/CreateMatchingWorkflowCommand.ts | 14 +- .../commands/CreateSchemaMappingCommand.ts | 8 +- .../commands/DeleteMatchingWorkflowCommand.ts | 4 +- .../commands/DeleteSchemaMappingCommand.ts | 4 +- .../src/commands/GetMatchIdCommand.ts | 4 +- .../src/commands/GetMatchingJobCommand.ts | 6 +- .../commands/GetMatchingWorkflowCommand.ts | 8 +- .../src/commands/GetSchemaMappingCommand.ts | 4 +- .../src/commands/ListMatchingJobsCommand.ts | 4 +- .../commands/ListMatchingWorkflowsCommand.ts | 6 +- .../src/commands/ListSchemaMappingsCommand.ts | 6 +- .../commands/ListTagsForResourceCommand.ts | 6 +- .../src/commands/StartMatchingJobCommand.ts | 6 +- .../src/commands/TagResourceCommand.ts | 10 +- .../src/commands/UntagResourceCommand.ts | 4 +- .../commands/UpdateMatchingWorkflowCommand.ts | 12 +- clients/client-entityresolution/src/index.ts | 18 ++- .../src/models/models_0.ts | 122 ++++++++++-------- .../src/protocols/Aws_restJson1.ts | 3 + 22 files changed, 155 insertions(+), 148 deletions(-) diff --git a/clients/client-entityresolution/README.md b/clients/client-entityresolution/README.md index e40e03a2165a0..0003467328757 100644 --- 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. -

Welcome to the AWS Entity Resolution API Reference.

-

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities +

Welcome to the Entity Resolution API Reference.

+

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.

-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.

-

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the -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.

+

To learn more about Entity Resolution concepts, procedures, and best practices, see the +Entity Resolution User Guide.

## Installing diff --git a/clients/client-entityresolution/src/EntityResolution.ts b/clients/client-entityresolution/src/EntityResolution.ts index fe618f8732d76..db69858b3aa66 100644 --- a/clients/client-entityresolution/src/EntityResolution.ts +++ b/clients/client-entityresolution/src/EntityResolution.ts @@ -350,19 +350,17 @@ export interface EntityResolution { /** * @public - *

Welcome to the AWS Entity Resolution API Reference.

- *

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities + *

Welcome to the Entity Resolution API Reference.

+ *

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.

*

- * 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.

- *

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the - * 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.

+ *

To learn more about Entity Resolution concepts, procedures, and best practices, see the + * Entity Resolution * User Guide.

*/ export class EntityResolution extends EntityResolutionClient implements EntityResolution {} diff --git a/clients/client-entityresolution/src/EntityResolutionClient.ts b/clients/client-entityresolution/src/EntityResolutionClient.ts index b85c77ca2d1d8..918ceee3fb4fd 100644 --- a/clients/client-entityresolution/src/EntityResolutionClient.ts +++ b/clients/client-entityresolution/src/EntityResolutionClient.ts @@ -313,19 +313,17 @@ export interface EntityResolutionClientResolvedConfig extends EntityResolutionCl /** * @public - *

Welcome to the AWS Entity Resolution API Reference.

- *

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities + *

Welcome to the Entity Resolution API Reference.

+ *

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.

*

- * 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.

- *

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the - * 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.

+ *

To learn more about Entity Resolution concepts, procedures, and best practices, see the + * Entity Resolution * User Guide.

*/ export class EntityResolutionClient extends __Client< diff --git a/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts index 5476c7d8eda87..0d06b0712c13e 100644 --- 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,12 +154,12 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf *

* * @throws {@link ExceedsLimitException} (client fault) - *

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. + *

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. * The error message describes the limit exceeded. HTTP Status Code: 402 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -167,7 +167,7 @@ export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkf *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/CreateSchemaMappingCommand.ts index 338ed22d45b26..85e5e568e8ad6 100644 --- 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,12 +94,12 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut *

* * @throws {@link ExceedsLimitException} (client fault) - *

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. + *

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. * The error message describes the limit exceeded. HTTP Status Code: 402 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -107,7 +107,7 @@ export interface CreateSchemaMappingCommandOutput extends CreateSchemaMappingOut *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts index 9fcb92692af41..239f61026242e 100644 --- a/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts +++ b/clients/client-entityresolution/src/commands/DeleteMatchingWorkflowCommand.ts @@ -66,7 +66,7 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -74,7 +74,7 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts index 039c962217040..bf06f0ef0be40 100644 --- a/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts +++ b/clients/client-entityresolution/src/commands/DeleteSchemaMappingCommand.ts @@ -72,7 +72,7 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -80,7 +80,7 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/GetMatchIdCommand.ts b/clients/client-entityresolution/src/commands/GetMatchIdCommand.ts index c388660f77479..715dbe4d57a76 100644 --- 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 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -80,7 +80,7 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/GetMatchingJobCommand.ts b/clients/client-entityresolution/src/commands/GetMatchingJobCommand.ts index 1253453bfa808..19bd590579d48 100644 --- 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 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -90,7 +90,7 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/GetMatchingWorkflowCommand.ts index 35ec8c20d834b..f49583bdeb2ce 100644 --- 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 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -122,7 +122,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts b/clients/client-entityresolution/src/commands/GetSchemaMappingCommand.ts index 5a6683518f80e..946ac9223688d 100644 --- 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, _ *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -92,7 +92,7 @@ export interface GetSchemaMappingCommandOutput extends GetSchemaMappingOutput, _ *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/ListMatchingJobsCommand.ts b/clients/client-entityresolution/src/commands/ListMatchingJobsCommand.ts index bf19f2faaa917..4b0a00d9b55cd 100644 --- a/clients/client-entityresolution/src/commands/ListMatchingJobsCommand.ts +++ b/clients/client-entityresolution/src/commands/ListMatchingJobsCommand.ts @@ -75,7 +75,7 @@ export interface ListMatchingJobsCommandOutput extends ListMatchingJobsOutput, _ *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -87,7 +87,7 @@ export interface ListMatchingJobsCommandOutput extends ListMatchingJobsOutput, _ *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/ListMatchingWorkflowsCommand.ts b/clients/client-entityresolution/src/commands/ListMatchingWorkflowsCommand.ts index e48e6ac4c922c..4d3635219db63 100644 --- a/clients/client-entityresolution/src/commands/ListMatchingWorkflowsCommand.ts +++ b/clients/client-entityresolution/src/commands/ListMatchingWorkflowsCommand.ts @@ -36,7 +36,7 @@ export interface ListMatchingWorkflowsCommandOutput extends ListMatchingWorkflow /** * @public - *

Returns a list of all the MatchingWorkflows that have been created for an AWS account.

+ *

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -74,7 +74,7 @@ export interface ListMatchingWorkflowsCommandOutput extends ListMatchingWorkflow *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -82,7 +82,7 @@ export interface ListMatchingWorkflowsCommandOutput extends ListMatchingWorkflow *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/ListSchemaMappingsCommand.ts b/clients/client-entityresolution/src/commands/ListSchemaMappingsCommand.ts index 1f2fffe655ea3..f0bb01edb0fa7 100644 --- a/clients/client-entityresolution/src/commands/ListSchemaMappingsCommand.ts +++ b/clients/client-entityresolution/src/commands/ListSchemaMappingsCommand.ts @@ -36,7 +36,7 @@ export interface ListSchemaMappingsCommandOutput extends ListSchemaMappingsOutpu /** * @public - *

Returns a list of all the SchemaMappings that have been created for an AWS account.

+ *

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -74,7 +74,7 @@ export interface ListSchemaMappingsCommandOutput extends ListSchemaMappingsOutpu *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ThrottlingException} (client fault) @@ -82,7 +82,7 @@ export interface ListSchemaMappingsCommandOutput extends ListSchemaMappingsOutpu *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/ListTagsForResourceCommand.ts b/clients/client-entityresolution/src/commands/ListTagsForResourceCommand.ts index e7b308dc0017b..596e6896213cf 100644 --- a/clients/client-entityresolution/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-entityresolution/src/commands/ListTagsForResourceCommand.ts @@ -36,7 +36,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** * @public - *

Displays the tags associated with an AWS Entity Resolution resource. In Entity + *

Displays the tags associated with an Entity Resolution resource. In Entity * Resolution, SchemaMapping, and MatchingWorkflow can be * tagged.

* @example @@ -65,7 +65,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -73,7 +73,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/StartMatchingJobCommand.ts b/clients/client-entityresolution/src/commands/StartMatchingJobCommand.ts index d654dd2e0be51..82834cbc26f72 100644 --- a/clients/client-entityresolution/src/commands/StartMatchingJobCommand.ts +++ b/clients/client-entityresolution/src/commands/StartMatchingJobCommand.ts @@ -71,12 +71,12 @@ export interface StartMatchingJobCommandOutput extends StartMatchingJobOutput, _ *

* * @throws {@link ExceedsLimitException} (client fault) - *

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. + *

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. * The error message describes the limit exceeded. HTTP Status Code: 402 *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -88,7 +88,7 @@ export interface StartMatchingJobCommandOutput extends StartMatchingJobOutput, _ *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/TagResourceCommand.ts b/clients/client-entityresolution/src/commands/TagResourceCommand.ts index 24141bbf06653..4ea5bf5cbccfb 100644 --- a/clients/client-entityresolution/src/commands/TagResourceCommand.ts +++ b/clients/client-entityresolution/src/commands/TagResourceCommand.ts @@ -36,11 +36,11 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** * @public - *

Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution + *

Assigns one or more tags (key-value pairs) to the specified Entity Resolution * resource. Tags can help you organize and categorize your resources. You can also use them * to scope user permissions by granting a user permission to access or change only resources - * with certain tag values. In Entity Resolution, SchemaMapping, and - * MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS + * with certain tag values. In Entity Resolution, SchemaMapping and + * MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services * and are interpreted strictly as strings of characters. You can use the * TagResource action with a resource that already has tags. If you specify a * new tag key, this tag is appended to the list of tags associated with the resource. If you @@ -71,7 +71,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -79,7 +79,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/commands/UntagResourceCommand.ts b/clients/client-entityresolution/src/commands/UntagResourceCommand.ts index 01b28f7b2c649..c853bf52e1d3e 100644 --- a/clients/client-entityresolution/src/commands/UntagResourceCommand.ts +++ b/clients/client-entityresolution/src/commands/UntagResourceCommand.ts @@ -36,7 +36,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** * @public - *

Removes one or more tags from the specified AWS Entity Resolution resource. In Entity + *

Removes one or more tags from the specified Entity Resolution resource. In Entity * Resolution, SchemaMapping, and MatchingWorkflow can be * tagged.

* @example @@ -64,7 +64,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape. * * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) diff --git a/clients/client-entityresolution/src/commands/UpdateMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/UpdateMatchingWorkflowCommand.ts index 6a51bc72b2434..cb66887b95ef1 100644 --- a/clients/client-entityresolution/src/commands/UpdateMatchingWorkflowCommand.ts +++ b/clients/client-entityresolution/src/commands/UpdateMatchingWorkflowCommand.ts @@ -59,18 +59,18 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf * 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 @@ -103,18 +103,18 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf * // 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 @@ -146,7 +146,7 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf *

* * @throws {@link InternalServerException} (server fault) - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

* * @throws {@link ResourceNotFoundException} (client fault) @@ -158,7 +158,7 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf *

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

* * @throws {@link EntityResolutionServiceException} diff --git a/clients/client-entityresolution/src/index.ts b/clients/client-entityresolution/src/index.ts index e237e462643aa..15f04ef805d1d 100644 --- a/clients/client-entityresolution/src/index.ts +++ b/clients/client-entityresolution/src/index.ts @@ -1,19 +1,17 @@ // smithy-typescript generated code /* eslint-disable */ /** - *

Welcome to the AWS Entity Resolution API Reference.

- *

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities + *

Welcome to the Entity Resolution API Reference.

+ *

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.

*

- * 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.

- *

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the - * 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.

+ *

To learn more about Entity Resolution concepts, procedures, and best practices, see the + * Entity Resolution * User Guide.

* * @packageDocumentation diff --git a/clients/client-entityresolution/src/models/models_0.ts b/clients/client-entityresolution/src/models/models_0.ts index 653727a50a604..523b986b98e1a 100644 --- a/clients/client-entityresolution/src/models/models_0.ts +++ b/clients/client-entityresolution/src/models/models_0.ts @@ -115,9 +115,9 @@ export interface InputSource { /** * @public - *

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of - * these objects selects a column to be included in the output table, and whether the - * values of the column should be hashed.

+ *

A list of OutputAttribute objects, each of which have the fields + * Name and Hashed. Each of these objects selects a column to be + * included in the output table, and whether the values of the column should be hashed.

*/ export interface OutputAttribute { /** @@ -136,9 +136,9 @@ export interface OutputAttribute { /** * @public - *

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of - * these objects selects a column to be included in the output table, and whether the - * values of the column should be hashed.

+ *

A list of OutputAttribute objects, each of which have the fields + * Name and Hashed. Each of these objects selects a column to be + * included in the output table, and whether the values of the column should be hashed.

*/ export interface OutputSource { /** @@ -149,18 +149,18 @@ export interface OutputSource { /** * @public - *

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of - * these objects selects a column to be included in the output table, and whether the - * values of the column should be hashed.

+ *

Customer KMS ARN for encryption at rest. If not provided, system will use an + * Entity Resolution managed KMS key.

*/ - output: OutputAttribute[] | undefined; + KMSArn?: string; /** * @public - *

Customer KMS ARN for encryption at rest. If not provided, system will use an - * Entity Resolution managed KMS key.

+ *

A list of OutputAttribute objects, each of which have the fields + * Name and Hashed. Each of these objects selects a column to be + * included in the output table, and whether the values of the column should be hashed.

*/ - KMSArn?: string; + output: OutputAttribute[] | undefined; /** * @public @@ -214,34 +214,35 @@ export interface Rule { export interface RuleBasedProperties { /** * @public - *

A list of Rule objects, each of which have fields RuleName and MatchingKeys.

+ *

A list of Rule objects, each of which have fields RuleName and + * MatchingKeys.

*/ rules: Rule[] | undefined; /** * @public - *

You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When - * choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For - * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, - * the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if - * the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of - * the Email field of Profile B matches, the two profiles are matched on the Email type.

+ *

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When + * choosing MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For + * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, + * the two profiles are matched on the Email type. When choosing ONE_TO_ONE ,the system can only match if + * the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of + * the Email field of Profile B matches, the two profiles are matched on the Email type.

*/ attributeMatchingModel: AttributeMatchingModel | string | undefined; } /** * @public - *

An object which defines the resolutionType and the ruleBasedProperties - *

+ *

An object which defines the resolutionType and the + * ruleBasedProperties.

*/ export interface ResolutionTechniques { /** * @public - *

There are two types of matching, RULE_MATCHING and ML_MATCHING - *

+ *

The type of matching. There are two types of matching: RULE_MATCHING and + * ML_MATCHING.

*/ - resolutionType?: ResolutionType | string; + resolutionType: ResolutionType | string | undefined; /** * @public @@ -283,8 +284,8 @@ export interface CreateMatchingWorkflowInput { /** * @public - *

An object which defines the resolutionType and the ruleBasedProperties - *

+ *

An object which defines the resolutionType and the + * ruleBasedProperties.

*/ resolutionTechniques: ResolutionTechniques | undefined; @@ -296,7 +297,7 @@ export interface CreateMatchingWorkflowInput { /** * @public - *

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + *

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role * to create resources on your behalf as part of workflow execution.

*/ roleArn: string | undefined; @@ -346,8 +347,8 @@ export interface CreateMatchingWorkflowOutput { /** * @public - *

An object which defines the resolutionType and the ruleBasedProperties - *

+ *

An object which defines the resolutionType and the + * ruleBasedProperties.

*/ resolutionTechniques: ResolutionTechniques | undefined; @@ -359,7 +360,7 @@ export interface CreateMatchingWorkflowOutput { /** * @public - *

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + *

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role * to create resources on your behalf as part of workflow execution.

*/ roleArn: string | undefined; @@ -367,13 +368,25 @@ export interface CreateMatchingWorkflowOutput { /** * @public - *

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. + *

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. * The error message describes the limit exceeded. HTTP Status Code: 402 *

*/ export class ExceedsLimitException extends __BaseException { readonly name: "ExceedsLimitException" = "ExceedsLimitException"; readonly $fault: "client" = "client"; + /** + * @public + *

The name of the quota that has been breached.

+ */ + quotaName?: string; + + /** + * @public + *

The current quota value for the customers.

+ */ + quotaValue?: number; + /** * @internal */ @@ -384,12 +397,14 @@ export class ExceedsLimitException extends __BaseException { ...opts, }); Object.setPrototypeOf(this, ExceedsLimitException.prototype); + this.quotaName = opts.quotaName; + this.quotaValue = opts.quotaValue; } } /** * @public - *

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500 + *

This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500 *

*/ export class InternalServerException extends __BaseException { @@ -435,7 +450,7 @@ export class ThrottlingException extends __BaseException { /** * @public - *

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400 + *

The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400 *

*/ export class ValidationException extends __BaseException { @@ -517,10 +532,10 @@ export interface SchemaInputAttribute { *

A key that allows grouping of multiple input attributes into a unified matching group. * For example, let's consider a scenario where the source table contains various addresses, * such as business_address and shipping_address. By assigning the MatchKey - * Address' to both attributes, Entity Resolution will match records - * across these fields to create a consolidated matching group. If no MatchKey is - * specified for a column, it won't be utilized for matching purposes but will still be - * included in the output table.

+ * Address to both attributes, Entity Resolution will match records across these + * fields to create a consolidated matching group. If no MatchKey is specified + * for a column, it won't be utilized for matching purposes but will still be included in the + * output table.

*/ matchKey?: string; } @@ -548,7 +563,7 @@ export interface CreateSchemaMappingInput { * to a column the source data table, and contains column name plus additional information * that Entity Resolution uses for matching.

*/ - mappedInputFields?: SchemaInputAttribute[]; + mappedInputFields: SchemaInputAttribute[] | undefined; /** * @public @@ -731,15 +746,15 @@ export interface JobMetrics { /** * @public - *

The total number of matchIDs generated.

+ *

The total number of records that did not get processed.

*/ - matchIDs?: number; + recordsNotProcessed?: number; /** * @public - *

The total number of records that did not get processed,

+ *

The total number of matchIDs generated.

*/ - recordsNotProcessed?: number; + matchIDs?: number; } /** @@ -770,8 +785,7 @@ export interface GetMatchingJobOutput { /** * @public - *

The current status of the job. Either running, succeeded, - * queued, or failed.

+ *

The current status of the job.

*/ status: JobStatus | string | undefined; @@ -850,8 +864,8 @@ export interface GetMatchingWorkflowOutput { /** * @public - *

An object which defines the resolutionType and the ruleBasedProperties - *

+ *

An object which defines the resolutionType and the + * ruleBasedProperties.

*/ resolutionTechniques: ResolutionTechniques | undefined; @@ -875,7 +889,7 @@ export interface GetMatchingWorkflowOutput { /** * @public - *

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access + *

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access * resources on your behalf.

*/ roleArn: string | undefined; @@ -984,8 +998,7 @@ export interface JobSummary { /** * @public - *

The current status of the job. Either running, succeeded, - * queued, or failed.

+ *

The current status of the job.

*/ status: JobStatus | string | undefined; @@ -1008,7 +1021,7 @@ export interface JobSummary { export interface ListMatchingJobsOutput { /** * @public - *

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

+ *

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

*/ jobs?: JobSummary[]; @@ -1272,8 +1285,7 @@ export interface UpdateMatchingWorkflowInput { /** * @public - *

An object which defines the resolutionType and the ruleBasedProperties - *

+ *

An object which defines the resolutionType and the ruleBasedProperties.

*/ resolutionTechniques: ResolutionTechniques | undefined; @@ -1285,7 +1297,7 @@ export interface UpdateMatchingWorkflowInput { /** * @public - *

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + *

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role * to create resources on your behalf as part of workflow execution.

*/ roleArn: string | undefined; @@ -1336,7 +1348,7 @@ export interface UpdateMatchingWorkflowOutput { /** * @public - *

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + *

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role * to create resources on your behalf as part of workflow execution.

*/ roleArn: string | undefined; diff --git a/clients/client-entityresolution/src/protocols/Aws_restJson1.ts b/clients/client-entityresolution/src/protocols/Aws_restJson1.ts index db0586869d741..898432d115299 100644 --- a/clients/client-entityresolution/src/protocols/Aws_restJson1.ts +++ b/clients/client-entityresolution/src/protocols/Aws_restJson1.ts @@ -4,6 +4,7 @@ import { _json, collectBody, decorateServiceException as __decorateServiceException, + expectInt32 as __expectInt32, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectObject as __expectObject, @@ -1584,6 +1585,8 @@ const de_ExceedsLimitExceptionRes = async ( const data: any = parsedOutput.body; const doc = take(data, { message: __expectString, + quotaName: __expectString, + quotaValue: __expectInt32, }); Object.assign(contents, doc); const exception = new ExceedsLimitException({