Skip to content

Commit 73bb951

Browse files
Update API model
1 parent 2d2f18f commit 73bb951

File tree

2 files changed

+109
-25
lines changed

2 files changed

+109
-25
lines changed

tools/code-generation/smithy/api-descriptions/entityresolution.json

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,7 @@
964964
"smithy.api#length": {
965965
"max": 255
966966
},
967-
"smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$"
967+
"smithy.api#pattern": "^[a-zA-Z_0-9- ]*$"
968968
}
969969
},
970970
"com.amazonaws.entityresolution#AwsAccountId": {
@@ -2020,7 +2020,7 @@
20202020
"type": "structure",
20212021
"members": {
20222022
"uniqueId": {
2023-
"target": "com.amazonaws.entityresolution#UniqueId",
2023+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId",
20242024
"traits": {
20252025
"smithy.api#documentation": "<p>The unique ID that could not be deleted.</p>",
20262026
"smithy.api#required": {}
@@ -2082,7 +2082,7 @@
20822082
"type": "structure",
20832083
"members": {
20842084
"uniqueId": {
2085-
"target": "com.amazonaws.entityresolution#UniqueId",
2085+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId",
20862086
"traits": {
20872087
"smithy.api#documentation": "<p> The unique ID of the deleted item.</p>",
20882088
"smithy.api#required": {}
@@ -2110,7 +2110,7 @@
21102110
"com.amazonaws.entityresolution#DisconnectedUniqueIdsList": {
21112111
"type": "list",
21122112
"member": {
2113-
"target": "com.amazonaws.entityresolution#UniqueId"
2113+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId"
21142114
}
21152115
},
21162116
"com.amazonaws.entityresolution#EntityName": {
@@ -2569,7 +2569,7 @@
25692569
}
25702570
],
25712571
"traits": {
2572-
"smithy.api#documentation": "<p>Returns the corresponding Match ID of a customer record if the record has been\n processed.</p>",
2572+
"smithy.api#documentation": "<p>Returns the corresponding Match ID of a customer record if the record has been\n processed in a\n rule-based matching workflow or ML matching workflow.</p>\n <p>You can call this API as a dry run of an incremental load on the rule-based\n matching\n workflow.</p>",
25732573
"smithy.api#http": {
25742574
"code": 200,
25752575
"method": "POST",
@@ -3218,6 +3218,16 @@
32183218
"smithy.api#output": {}
32193219
}
32203220
},
3221+
"com.amazonaws.entityresolution#HeaderSafeUniqueId": {
3222+
"type": "string",
3223+
"traits": {
3224+
"smithy.api#length": {
3225+
"min": 1,
3226+
"max": 780
3227+
},
3228+
"smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$"
3229+
}
3230+
},
32213231
"com.amazonaws.entityresolution#IdMappingJobMetrics": {
32223232
"type": "structure",
32233233
"members": {
@@ -3256,10 +3266,16 @@
32563266
"traits": {
32573267
"smithy.api#documentation": "<p> The total number of distinct mapped target records.</p>"
32583268
}
3269+
},
3270+
"uniqueRecordsLoaded": {
3271+
"target": "smithy.api#Integer",
3272+
"traits": {
3273+
"smithy.api#documentation": "<p>The\n number of records remaining after loading and aggregating duplicate records. Duplicates are\n determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the\n same value in this field are considered duplicates. For example, if you specified\n \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value,\n they would count as one unique record in this metric. </p>"
3274+
}
32593275
}
32603276
},
32613277
"traits": {
3262-
"smithy.api#documentation": "<p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>,\n <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>,\n <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>"
3278+
"smithy.api#documentation": "<p>An\n object that contains metrics about an ID mapping job, including counts of input records,\n processed records, and mapped records between source and target identifiers.\n </p>"
32633279
}
32643280
},
32653281
"com.amazonaws.entityresolution#IdMappingJobOutputSource": {
@@ -5365,7 +5381,7 @@
53655381
"smithy.api#length": {
53665382
"max": 255
53675383
},
5368-
"smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$",
5384+
"smithy.api#pattern": "^[a-zA-Z_0-9- ]*$",
53695385
"smithy.api#required": {}
53705386
}
53715387
},
@@ -5374,7 +5390,6 @@
53745390
"traits": {
53755391
"smithy.api#documentation": "<p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been\n defined in the <code>SchemaMapping</code>. Two records are considered to match according to\n this rule if all of the <code>MatchingKeys</code> match.</p>",
53765392
"smithy.api#length": {
5377-
"min": 1,
53785393
"max": 15
53795394
},
53805395
"smithy.api#required": {}
@@ -5571,14 +5586,14 @@
55715586
"type": {
55725587
"target": "com.amazonaws.entityresolution#SchemaAttributeType",
55735588
"traits": {
5574-
"smithy.api#documentation": "<p>The type of the attribute, selected from a list of values.</p>",
5589+
"smithy.api#documentation": "<p>The type of the attribute, selected from a list of values.</p>\n <note>\n <p>Normalization is only supported for <code>NAME</code>, <code>ADDRESS</code>,\n <code>PHONE</code>, and <code>EMAIL_ADDRESS</code>. </p>\n <p>If you want to normalize <code>NAME_FIRST</code>, <code>NAME_MIDDLE</code>, and\n <code>NAME_LAST</code>, you must group them by assigning them to the\n <code>NAME</code>\n <code>groupName</code>. </p>\n <p>If you want to normalize <code>ADDRESS_STREET1</code>, <code>ADDRESS_STREET2</code>,\n <code>ADDRESS_STREET3</code>, <code>ADDRESS_CITY</code>, <code>ADDRESS_STATE</code>,\n <code>ADDRESS_COUNTRY</code>, and <code>ADDRESS_POSTALCODE</code>, you must group\n them by assigning them to the <code>ADDRESS</code>\n <code>groupName</code>. </p>\n <p>If you want to normalize <code>PHONE_NUMBER</code> and\n <code>PHONE_COUNTRYCODE</code>, you must group them by assigning them to the\n <code>PHONE</code>\n <code>groupName</code>. </p>\n </note>",
55755590
"smithy.api#required": {}
55765591
}
55775592
},
55785593
"groupName": {
55795594
"target": "com.amazonaws.entityresolution#AttributeName",
55805595
"traits": {
5581-
"smithy.api#documentation": "<p>A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type. </p>\n <p>For example, when working with columns such as <code>first_name</code>,\n <code>middle_name</code>, and <code>last_name</code>, assigning them a common\n <code>groupName</code> will prompt Entity Resolution to concatenate them into a single\n value.</p>"
5596+
"smithy.api#documentation": "<p>A string that instructs Entity Resolution to combine several columns into a unified\n column with the identical attribute type. </p>\n <p>For example, when working with columns such as\n <code>NAME_FIRST</code>,\n <code>NAME_MIDDLE</code>,\n and\n <code>NAME_LAST</code>,\n assigning them a common <code>groupName</code> will prompt Entity Resolution to concatenate\n them into a single value.</p>"
55825597
}
55835598
},
55845599
"matchKey": {
@@ -5596,12 +5611,12 @@
55965611
"hashed": {
55975612
"target": "smithy.api#Boolean",
55985613
"traits": {
5599-
"smithy.api#documentation": "<p> Indicates if the column values are hashed in the schema input. If the value is set to\n <code>TRUE</code>, the column values are hashed. If the value is set to\n <code>FALSE</code>, the column values are cleartext.</p>"
5614+
"smithy.api#documentation": "<p> Indicates if the column values are hashed in the schema input. </p>\n <p>If the value is set to <code>TRUE</code>, the column values are hashed. </p>\n <p>If the value is set to <code>FALSE</code>, the column values are cleartext.</p>"
56005615
}
56015616
}
56025617
},
56035618
"traits": {
5604-
"smithy.api#documentation": "<p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>,\n <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>"
5619+
"smithy.api#documentation": "<p>A\n configuration object for defining input data fields in Entity Resolution. The\n SchemaInputAttribute specifies how individual fields in your input data should be processed\n and matched.</p>"
56055620
}
56065621
},
56075622
"com.amazonaws.entityresolution#SchemaInputAttributes": {
@@ -6050,20 +6065,10 @@
60506065
}
60516066
}
60526067
},
6053-
"com.amazonaws.entityresolution#UniqueId": {
6054-
"type": "string",
6055-
"traits": {
6056-
"smithy.api#length": {
6057-
"min": 1,
6058-
"max": 760
6059-
},
6060-
"smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$"
6061-
}
6062-
},
60636068
"com.amazonaws.entityresolution#UniqueIdList": {
60646069
"type": "list",
60656070
"member": {
6066-
"target": "com.amazonaws.entityresolution#UniqueId"
6071+
"target": "com.amazonaws.entityresolution#HeaderSafeUniqueId"
60676072
}
60686073
},
60696074
"com.amazonaws.entityresolution#UntagResource": {

0 commit comments

Comments
 (0)