|
16 | 16 | "GetIdMappingJob": "<p>Gets the status, metrics, and errors (if there are any) that are associated with a job.</p>",
|
17 | 17 | "GetIdMappingWorkflow": "<p>Returns the <code>IdMappingWorkflow</code> with a given name, if it exists.</p>",
|
18 | 18 | "GetIdNamespace": "<p>Returns the <code>IdNamespace</code> with a given name, if it exists.</p>",
|
19 |
| - "GetMatchId": "<p>Returns the corresponding Match ID of a customer record if the record has been processed.</p>", |
| 19 | + "GetMatchId": "<p>Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow or ML matching workflow.</p> <p>You can call this API as a dry run of an incremental load on the rule-based matching workflow.</p>", |
20 | 20 | "GetMatchingJob": "<p>Gets the status, metrics, and errors (if there are any) that are associated with a job.</p>",
|
21 | 21 | "GetMatchingWorkflow": "<p>Returns the <code>MatchingWorkflow</code> with a given name, if it exists.</p>",
|
22 | 22 | "GetPolicy": "<p>Returns the resource-based policy.</p>",
|
|
72 | 72 | "ProviderSchemaAttribute$subType": "<p>The sub type of the provider schema attribute.</p>",
|
73 | 73 | "RuleMatchingKeysList$member": null,
|
74 | 74 | "SchemaInputAttribute$fieldName": "<p>A string containing the field name.</p>",
|
75 |
| - "SchemaInputAttribute$groupName": "<p>A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type. </p> <p>For example, when working with columns such as <code>first_name</code>, <code>middle_name</code>, and <code>last_name</code>, assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate them into a single value.</p>", |
| 75 | + "SchemaInputAttribute$groupName": "<p>A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type. </p> <p>For example, when working with columns such as <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and <code>NAME_LAST</code>, assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate them into a single value.</p>", |
76 | 76 | "SchemaInputAttribute$matchKey": "<p>A key that allows grouping of multiple input attributes into a unified matching group. </p> <p>For example, consider a scenario where the source table contains various addresses, such as <code>business_address</code> and <code>shipping_address</code>. By assigning a <code>matchKey</code> called <code>address</code> to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.</p> <p>If no <code>matchKey</code> is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.</p>",
|
77 | 77 | "SchemaInputAttribute$subType": "<p>The subtype of the attribute, selected from a list of values.</p>"
|
78 | 78 | }
|
|
115 | 115 | "OutputAttribute$hashed": "<p>Enables the ability to hash the column values in the output.</p>",
|
116 | 116 | "OutputSource$applyNormalization": "<p>Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.</p>",
|
117 | 117 | "ProviderSchemaAttribute$hashing": "<p>The hashing attribute of the provider schema.</p>",
|
118 |
| - "SchemaInputAttribute$hashed": "<p> Indicates if the column values are hashed in the schema input. If the value is set to <code>TRUE</code>, the column values are hashed. If the value is set to <code>FALSE</code>, the column values are cleartext.</p>", |
| 118 | + "SchemaInputAttribute$hashed": "<p> Indicates if the column values are hashed in the schema input. </p> <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p> <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>", |
119 | 119 | "SchemaMappingSummary$hasWorkflows": "<p>Specifies whether the schema mapping has been applied to a workflow.</p>"
|
120 | 120 | }
|
121 | 121 | },
|
|
286 | 286 | "base": null,
|
287 | 287 | "refs": {
|
288 | 288 | "GetProviderServiceOutput$providerConfigurationDefinition": "<p>The definition of the provider configuration.</p>",
|
289 |
| - "GetProviderServiceOutput$providerEntityOutputDefinition": "<p>The definition of the provider entity output.</p>", |
290 | 289 | "GetProviderServiceOutput$providerJobConfiguration": "<p>Provider service job configurations.</p>",
|
| 290 | + "GetProviderServiceOutput$providerEntityOutputDefinition": "<p>The definition of the provider entity output.</p>", |
291 | 291 | "NamespaceProviderProperties$providerConfiguration": "<p>An object which defines any additional configurations required by the provider service.</p>",
|
292 |
| - "ProviderIdNameSpaceConfiguration$providerSourceConfigurationDefinition": "<p>Configurations required for the source ID namespace.</p>", |
293 | 292 | "ProviderIdNameSpaceConfiguration$providerTargetConfigurationDefinition": "<p>Configurations required for the target ID namespace.</p>",
|
| 293 | + "ProviderIdNameSpaceConfiguration$providerSourceConfigurationDefinition": "<p>Configurations required for the source ID namespace.</p>", |
294 | 294 | "ProviderProperties$providerConfiguration": "<p>The required configuration fields to use with the provider service.</p>"
|
295 | 295 | }
|
296 | 296 | },
|
|
473 | 473 | "refs": {
|
474 | 474 | }
|
475 | 475 | },
|
| 476 | + "HeaderSafeUniqueId": { |
| 477 | + "base": null, |
| 478 | + "refs": { |
| 479 | + "DeleteUniqueIdError$uniqueId": "<p>The unique ID that could not be deleted.</p>", |
| 480 | + "DeletedUniqueId$uniqueId": "<p> The unique ID of the deleted item.</p>", |
| 481 | + "DisconnectedUniqueIdsList$member": null, |
| 482 | + "UniqueIdList$member": null |
| 483 | + } |
| 484 | + }, |
476 | 485 | "IdMappingJobMetrics": {
|
477 |
| - "base": "<p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>, <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>, <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>", |
| 486 | + "base": "<p>An object that contains metrics about an ID mapping job, including counts of input records, processed records, and mapped records between source and target identifiers. </p>", |
478 | 487 | "refs": {
|
479 | 488 | "GetIdMappingJobOutput$metrics": "<p>Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.</p>"
|
480 | 489 | }
|
|
730 | 739 | "refs": {
|
731 | 740 | "ExceedsLimitException$quotaValue": "<p>The current quota value for the customers.</p>",
|
732 | 741 | "IdMappingJobMetrics$inputRecords": "<p>The total number of records that were input for processing.</p>",
|
| 742 | + "IdMappingJobMetrics$totalRecordsProcessed": "<p>The total number of records that were processed.</p>", |
733 | 743 | "IdMappingJobMetrics$recordsNotProcessed": "<p>The total number of records that did not get processed.</p>",
|
734 | 744 | "IdMappingJobMetrics$totalMappedRecords": "<p> The total number of records that were mapped.</p>",
|
735 | 745 | "IdMappingJobMetrics$totalMappedSourceRecords": "<p> The total number of mapped source records.</p>",
|
736 | 746 | "IdMappingJobMetrics$totalMappedTargetRecords": "<p> The total number of distinct mapped target records.</p>",
|
737 |
| - "IdMappingJobMetrics$totalRecordsProcessed": "<p>The total number of records that were processed.</p>", |
| 747 | + "IdMappingJobMetrics$uniqueRecordsLoaded": "<p>The number of records remaining after loading and aggregating duplicate records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the same value in this field are considered duplicates. For example, if you specified \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric. </p>", |
738 | 748 | "JobMetrics$inputRecords": "<p>The total number of input records.</p>",
|
739 |
| - "JobMetrics$matchIDs": "<p>The total number of <code>matchID</code>s generated.</p>", |
| 749 | + "JobMetrics$totalRecordsProcessed": "<p>The total number of records processed.</p>", |
740 | 750 | "JobMetrics$recordsNotProcessed": "<p>The total number of records that did not get processed.</p>",
|
741 |
| - "JobMetrics$totalRecordsProcessed": "<p>The total number of records processed.</p>" |
| 751 | + "JobMetrics$matchIDs": "<p>The total number of <code>matchID</code>s generated.</p>" |
742 | 752 | }
|
743 | 753 | },
|
744 | 754 | "IntermediateSourceConfiguration": {
|
|
1250 | 1260 | "base": null,
|
1251 | 1261 | "refs": {
|
1252 | 1262 | "ProviderSchemaAttribute$type": "<p>The type of the provider schema attribute.</p>",
|
1253 |
| - "SchemaInputAttribute$type": "<p>The type of the attribute, selected from a list of values.</p>" |
| 1263 | + "SchemaInputAttribute$type": "<p>The type of the attribute, selected from a list of values.</p> <note> <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>, <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p> <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and <code>NAME_LAST</code>, you must group them by assigning them to the <code>NAME</code> <code>groupName</code>. </p> <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>, <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>, <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group them by assigning them to the <code>ADDRESS</code> <code>groupName</code>. </p> <p>If you want to normalize <code>PHONE_NUMBER</code> and <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the <code>PHONE</code> <code>groupName</code>. </p> </note>" |
1254 | 1264 | }
|
1255 | 1265 | },
|
1256 | 1266 | "SchemaInputAttribute": {
|
1257 |
| - "base": "<p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>, <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>", |
| 1267 | + "base": "<p>A configuration object for defining input data fields in Entity Resolution. The SchemaInputAttribute specifies how individual fields in your input data should be processed and matched.</p>", |
1258 | 1268 | "refs": {
|
1259 | 1269 | "SchemaInputAttributes$member": null
|
1260 | 1270 | }
|
|
1386 | 1396 | "GetMatchIdOutput$matchRule": "<p>The rule the record matched on.</p>",
|
1387 | 1397 | "GetMatchingWorkflowOutput$roleArn": "<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.</p>",
|
1388 | 1398 | "ProviderIdNameSpaceConfiguration$description": "<p>The description of the ID namespace.</p>",
|
1389 |
| - "ProviderMarketplaceConfiguration$assetId": "<p>The asset ID on Data Exchange.</p>", |
1390 | 1399 | "ProviderMarketplaceConfiguration$dataSetId": "<p>The dataset ID on Data Exchange.</p>",
|
1391 |
| - "ProviderMarketplaceConfiguration$listingId": "<p>The listing ID on Data Exchange.</p>", |
1392 | 1400 | "ProviderMarketplaceConfiguration$revisionId": "<p>The revision ID on Data Exchange.</p>",
|
| 1401 | + "ProviderMarketplaceConfiguration$assetId": "<p>The asset ID on Data Exchange.</p>", |
| 1402 | + "ProviderMarketplaceConfiguration$listingId": "<p>The listing ID on Data Exchange.</p>", |
1393 | 1403 | "RequiredBucketActionsList$member": null,
|
1394 | 1404 | "SchemaList$member": null,
|
1395 | 1405 | "UpdateMatchingWorkflowInput$roleArn": "<p>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.</p>",
|
|
1451 | 1461 | "refs": {
|
1452 | 1462 | "CreateIdNamespaceOutput$createdAt": "<p>The timestamp of when the ID namespace was created.</p>",
|
1453 | 1463 | "CreateIdNamespaceOutput$updatedAt": "<p>The timestamp of when the ID namespace was last updated.</p>",
|
1454 |
| - "GetIdMappingJobOutput$endTime": "<p>The time at which the job has finished.</p>", |
1455 | 1464 | "GetIdMappingJobOutput$startTime": "<p>The time at which the job was started.</p>",
|
| 1465 | + "GetIdMappingJobOutput$endTime": "<p>The time at which the job has finished.</p>", |
1456 | 1466 | "GetIdMappingWorkflowOutput$createdAt": "<p>The timestamp of when the workflow was created.</p>",
|
1457 | 1467 | "GetIdMappingWorkflowOutput$updatedAt": "<p>The timestamp of when the workflow was last updated.</p>",
|
1458 | 1468 | "GetIdNamespaceOutput$createdAt": "<p>The timestamp of when the ID namespace was created.</p>",
|
1459 | 1469 | "GetIdNamespaceOutput$updatedAt": "<p>The timestamp of when the ID namespace was last updated.</p>",
|
1460 |
| - "GetMatchingJobOutput$endTime": "<p>The time at which the job has finished.</p>", |
1461 | 1470 | "GetMatchingJobOutput$startTime": "<p>The time at which the job was started.</p>",
|
| 1471 | + "GetMatchingJobOutput$endTime": "<p>The time at which the job has finished.</p>", |
1462 | 1472 | "GetMatchingWorkflowOutput$createdAt": "<p>The timestamp of when the workflow was created.</p>",
|
1463 | 1473 | "GetMatchingWorkflowOutput$updatedAt": "<p>The timestamp of when the workflow was last updated.</p>",
|
1464 | 1474 | "GetSchemaMappingOutput$createdAt": "<p>The timestamp of when the <code>SchemaMapping</code> was created.</p>",
|
|
1467 | 1477 | "IdMappingWorkflowSummary$updatedAt": "<p>The timestamp of when the workflow was last updated.</p>",
|
1468 | 1478 | "IdNamespaceSummary$createdAt": "<p>The timestamp of when the ID namespace was created.</p>",
|
1469 | 1479 | "IdNamespaceSummary$updatedAt": "<p>The timestamp of when the ID namespace was last updated.</p>",
|
1470 |
| - "JobSummary$endTime": "<p>The time at which the job has finished.</p>", |
1471 | 1480 | "JobSummary$startTime": "<p>The time at which the job was started.</p>",
|
| 1481 | + "JobSummary$endTime": "<p>The time at which the job has finished.</p>", |
1472 | 1482 | "MatchingWorkflowSummary$createdAt": "<p>The timestamp of when the workflow was created.</p>",
|
1473 | 1483 | "MatchingWorkflowSummary$updatedAt": "<p>The timestamp of when the workflow was last updated.</p>",
|
1474 | 1484 | "SchemaMappingSummary$createdAt": "<p>The timestamp of when the <code>SchemaMapping</code> was created.</p>",
|
|
1477 | 1487 | "UpdateIdNamespaceOutput$updatedAt": "<p>The timestamp of when the ID namespace was last updated.</p>"
|
1478 | 1488 | }
|
1479 | 1489 | },
|
1480 |
| - "UniqueId": { |
1481 |
| - "base": null, |
1482 |
| - "refs": { |
1483 |
| - "DeleteUniqueIdError$uniqueId": "<p>The unique ID that could not be deleted.</p>", |
1484 |
| - "DeletedUniqueId$uniqueId": "<p> The unique ID of the deleted item.</p>", |
1485 |
| - "DisconnectedUniqueIdsList$member": null, |
1486 |
| - "UniqueIdList$member": null |
1487 |
| - } |
1488 |
| - }, |
1489 | 1490 | "UniqueIdList": {
|
1490 | 1491 | "base": null,
|
1491 | 1492 | "refs": {
|
|
0 commit comments