aws-sdk-entityresolution 1.30.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-entityresolution/client.rb +86 -3
- data/lib/aws-sdk-entityresolution/client_api.rb +70 -0
- data/lib/aws-sdk-entityresolution/types.rb +151 -3
- data/lib/aws-sdk-entityresolution.rb +1 -1
- data/sig/client.rbs +19 -0
- data/sig/types.rbs +40 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d2f56397d267013d707081767d19a4258b26b73948c4a6bc1511b3fcfdbadb50
|
4
|
+
data.tar.gz: 6b0259bd6e9a5d10925cd03c48058bec75423d0e75f92c2b46c16f409c58d63c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e2fd00c161ff033eff641e358a8bf1b8febb06b0c90d6138cc66fc3a39da643b64fc5aa988944df3c13a33ce017afdc1b258986b3a1d23d769cfd452ef0036cd
|
7
|
+
data.tar.gz: 3bb4b2e6728c22b4ad77caa03fc15b3caa6aea5b1ccd3f0bbdc0f574265d5b0241f65c3d04891a53b8d0bc1c59865c2b028338350b7abb35e6230ea3454eccee
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.31.0
|
@@ -1187,7 +1187,90 @@ module Aws::EntityResolution
|
|
1187
1187
|
req.send_request(options)
|
1188
1188
|
end
|
1189
1189
|
|
1190
|
-
#
|
1190
|
+
# Generates or retrieves Match IDs for records using a rule-based
|
1191
|
+
# matching workflow. When you call this operation, it processes your
|
1192
|
+
# records against the workflow's matching rules to identify potential
|
1193
|
+
# matches. For existing records, it retrieves their Match IDs and
|
1194
|
+
# associated rules. For records without matches, it generates new Match
|
1195
|
+
# IDs. The operation saves results to Amazon S3.
|
1196
|
+
#
|
1197
|
+
# The processing type (`processingType`) you choose affects both the
|
1198
|
+
# accuracy and response time of the operation. Additional charges apply
|
1199
|
+
# for each API call, whether made through the Entity Resolution console
|
1200
|
+
# or directly via the API. The rule-based matching workflow must exist
|
1201
|
+
# and be active before calling this operation.
|
1202
|
+
#
|
1203
|
+
# @option params [required, String] :workflow_name
|
1204
|
+
# The name of the rule-based matching workflow.
|
1205
|
+
#
|
1206
|
+
# @option params [required, Array<Types::Record>] :records
|
1207
|
+
# The records to match.
|
1208
|
+
#
|
1209
|
+
# @option params [String] :processing_type
|
1210
|
+
# The processing mode that determines how Match IDs are generated and
|
1211
|
+
# results are saved. Each mode provides different levels of accuracy,
|
1212
|
+
# response time, and completeness of results.
|
1213
|
+
#
|
1214
|
+
# If not specified, defaults to `CONSISTENT`.
|
1215
|
+
#
|
1216
|
+
# `CONSISTENT`: Performs immediate lookup and matching against all
|
1217
|
+
# existing records, with results saved synchronously. Provides highest
|
1218
|
+
# accuracy but slower response time.
|
1219
|
+
#
|
1220
|
+
# `EVENTUAL` (shown as *Background* in the console): Performs initial
|
1221
|
+
# match ID lookup or generation immediately, with record updates
|
1222
|
+
# processed asynchronously in the background. Offers faster initial
|
1223
|
+
# response time, with complete matching results available later in S3.
|
1224
|
+
#
|
1225
|
+
# `EVENTUAL_NO_LOOKUP` (shown as *Quick ID generation* in the console):
|
1226
|
+
# Generates new match IDs without checking existing matches, with
|
1227
|
+
# updates processed asynchronously. Provides fastest response time but
|
1228
|
+
# should only be used for records known to be unique.
|
1229
|
+
#
|
1230
|
+
# @return [Types::GenerateMatchIdOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1231
|
+
#
|
1232
|
+
# * {Types::GenerateMatchIdOutput#match_groups #match_groups} => Array<Types::MatchGroup>
|
1233
|
+
# * {Types::GenerateMatchIdOutput#failed_records #failed_records} => Array<Types::FailedRecord>
|
1234
|
+
#
|
1235
|
+
# @example Request syntax with placeholder values
|
1236
|
+
#
|
1237
|
+
# resp = client.generate_match_id({
|
1238
|
+
# workflow_name: "EntityName", # required
|
1239
|
+
# records: [ # required
|
1240
|
+
# {
|
1241
|
+
# input_source_arn: "RecordInputSourceARNString", # required
|
1242
|
+
# unique_id: "UniqueId", # required
|
1243
|
+
# record_attribute_map: { # required
|
1244
|
+
# "RecordAttributeMapString255KeyString" => "RecordAttributeMapString255ValueString",
|
1245
|
+
# },
|
1246
|
+
# },
|
1247
|
+
# ],
|
1248
|
+
# processing_type: "CONSISTENT", # accepts CONSISTENT, EVENTUAL, EVENTUAL_NO_LOOKUP
|
1249
|
+
# })
|
1250
|
+
#
|
1251
|
+
# @example Response structure
|
1252
|
+
#
|
1253
|
+
# resp.match_groups #=> Array
|
1254
|
+
# resp.match_groups[0].records #=> Array
|
1255
|
+
# resp.match_groups[0].records[0].input_source_arn #=> String
|
1256
|
+
# resp.match_groups[0].records[0].record_id #=> String
|
1257
|
+
# resp.match_groups[0].match_id #=> String
|
1258
|
+
# resp.match_groups[0].match_rule #=> String
|
1259
|
+
# resp.failed_records #=> Array
|
1260
|
+
# resp.failed_records[0].input_source_arn #=> String
|
1261
|
+
# resp.failed_records[0].unique_id #=> String
|
1262
|
+
# resp.failed_records[0].error_message #=> String
|
1263
|
+
#
|
1264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GenerateMatchId AWS API Documentation
|
1265
|
+
#
|
1266
|
+
# @overload generate_match_id(params = {})
|
1267
|
+
# @param [Hash] params ({})
|
1268
|
+
def generate_match_id(params = {}, options = {})
|
1269
|
+
req = build_request(:generate_match_id, params)
|
1270
|
+
req.send_request(options)
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
# Returns the status, metrics, and errors (if there are any) that are
|
1191
1274
|
# associated with a job.
|
1192
1275
|
#
|
1193
1276
|
# @option params [required, String] :workflow_name
|
@@ -1410,7 +1493,7 @@ module Aws::EntityResolution
|
|
1410
1493
|
req.send_request(options)
|
1411
1494
|
end
|
1412
1495
|
|
1413
|
-
#
|
1496
|
+
# Returns the status, metrics, and errors (if there are any) that are
|
1414
1497
|
# associated with a job.
|
1415
1498
|
#
|
1416
1499
|
# @option params [required, String] :workflow_name
|
@@ -2626,7 +2709,7 @@ module Aws::EntityResolution
|
|
2626
2709
|
tracer: tracer
|
2627
2710
|
)
|
2628
2711
|
context[:gem_name] = 'aws-sdk-entityresolution'
|
2629
|
-
context[:gem_version] = '1.
|
2712
|
+
context[:gem_version] = '1.31.0'
|
2630
2713
|
Seahorse::Client::Request.new(handlers, context)
|
2631
2714
|
end
|
2632
2715
|
|
@@ -59,6 +59,12 @@ module Aws::EntityResolution
|
|
59
59
|
ErrorDetails = Shapes::StructureShape.new(name: 'ErrorDetails')
|
60
60
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
61
61
|
ExceedsLimitException = Shapes::StructureShape.new(name: 'ExceedsLimitException')
|
62
|
+
FailedRecord = Shapes::StructureShape.new(name: 'FailedRecord')
|
63
|
+
FailedRecordInputSourceARNString = Shapes::StringShape.new(name: 'FailedRecordInputSourceARNString')
|
64
|
+
FailedRecordsList = Shapes::ListShape.new(name: 'FailedRecordsList')
|
65
|
+
GenerateMatchIdInput = Shapes::StructureShape.new(name: 'GenerateMatchIdInput')
|
66
|
+
GenerateMatchIdInputRecordsList = Shapes::ListShape.new(name: 'GenerateMatchIdInputRecordsList')
|
67
|
+
GenerateMatchIdOutput = Shapes::StructureShape.new(name: 'GenerateMatchIdOutput')
|
62
68
|
GetIdMappingJobInput = Shapes::StructureShape.new(name: 'GetIdMappingJobInput')
|
63
69
|
GetIdMappingJobOutput = Shapes::StructureShape.new(name: 'GetIdMappingJobOutput')
|
64
70
|
GetIdMappingWorkflowInput = Shapes::StructureShape.new(name: 'GetIdMappingWorkflowInput')
|
@@ -146,7 +152,12 @@ module Aws::EntityResolution
|
|
146
152
|
ListSchemaMappingsOutput = Shapes::StructureShape.new(name: 'ListSchemaMappingsOutput')
|
147
153
|
ListTagsForResourceInput = Shapes::StructureShape.new(name: 'ListTagsForResourceInput')
|
148
154
|
ListTagsForResourceOutput = Shapes::StructureShape.new(name: 'ListTagsForResourceOutput')
|
155
|
+
MatchGroup = Shapes::StructureShape.new(name: 'MatchGroup')
|
156
|
+
MatchGroupsList = Shapes::ListShape.new(name: 'MatchGroupsList')
|
149
157
|
MatchPurpose = Shapes::StringShape.new(name: 'MatchPurpose')
|
158
|
+
MatchedRecord = Shapes::StructureShape.new(name: 'MatchedRecord')
|
159
|
+
MatchedRecordInputSourceARNString = Shapes::StringShape.new(name: 'MatchedRecordInputSourceARNString')
|
160
|
+
MatchedRecordsList = Shapes::ListShape.new(name: 'MatchedRecordsList')
|
150
161
|
MatchingWorkflowArn = Shapes::StringShape.new(name: 'MatchingWorkflowArn')
|
151
162
|
MatchingWorkflowList = Shapes::ListShape.new(name: 'MatchingWorkflowList')
|
152
163
|
MatchingWorkflowSummary = Shapes::StructureShape.new(name: 'MatchingWorkflowSummary')
|
@@ -160,6 +171,7 @@ module Aws::EntityResolution
|
|
160
171
|
OutputSourceOutputList = Shapes::ListShape.new(name: 'OutputSourceOutputList')
|
161
172
|
PolicyDocument = Shapes::StringShape.new(name: 'PolicyDocument')
|
162
173
|
PolicyToken = Shapes::StringShape.new(name: 'PolicyToken')
|
174
|
+
ProcessingType = Shapes::StringShape.new(name: 'ProcessingType')
|
163
175
|
ProviderComponentSchema = Shapes::StructureShape.new(name: 'ProviderComponentSchema')
|
164
176
|
ProviderEndpointConfiguration = Shapes::UnionShape.new(name: 'ProviderEndpointConfiguration')
|
165
177
|
ProviderIdNameSpaceConfiguration = Shapes::StructureShape.new(name: 'ProviderIdNameSpaceConfiguration')
|
@@ -174,9 +186,14 @@ module Aws::EntityResolution
|
|
174
186
|
ProviderServiceSummary = Shapes::StructureShape.new(name: 'ProviderServiceSummary')
|
175
187
|
PutPolicyInput = Shapes::StructureShape.new(name: 'PutPolicyInput')
|
176
188
|
PutPolicyOutput = Shapes::StructureShape.new(name: 'PutPolicyOutput')
|
189
|
+
Record = Shapes::StructureShape.new(name: 'Record')
|
177
190
|
RecordAttributeMap = Shapes::MapShape.new(name: 'RecordAttributeMap')
|
178
191
|
RecordAttributeMapKeyString = Shapes::StringShape.new(name: 'RecordAttributeMapKeyString')
|
192
|
+
RecordAttributeMapString255 = Shapes::MapShape.new(name: 'RecordAttributeMapString255')
|
193
|
+
RecordAttributeMapString255KeyString = Shapes::StringShape.new(name: 'RecordAttributeMapString255KeyString')
|
194
|
+
RecordAttributeMapString255ValueString = Shapes::StringShape.new(name: 'RecordAttributeMapString255ValueString')
|
179
195
|
RecordAttributeMapValueString = Shapes::StringShape.new(name: 'RecordAttributeMapValueString')
|
196
|
+
RecordInputSourceARNString = Shapes::StringShape.new(name: 'RecordInputSourceARNString')
|
180
197
|
RecordMatchingModel = Shapes::StringShape.new(name: 'RecordMatchingModel')
|
181
198
|
RecordMatchingModelList = Shapes::ListShape.new(name: 'RecordMatchingModelList')
|
182
199
|
RequiredBucketActionsList = Shapes::ListShape.new(name: 'RequiredBucketActionsList')
|
@@ -219,6 +236,7 @@ module Aws::EntityResolution
|
|
219
236
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
220
237
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
221
238
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
239
|
+
UniqueId = Shapes::StringShape.new(name: 'UniqueId')
|
222
240
|
UniqueIdList = Shapes::ListShape.new(name: 'UniqueIdList')
|
223
241
|
UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
|
224
242
|
UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput')
|
@@ -390,6 +408,24 @@ module Aws::EntityResolution
|
|
390
408
|
ExceedsLimitException.add_member(:quota_value, Shapes::ShapeRef.new(shape: Integer, location_name: "quotaValue"))
|
391
409
|
ExceedsLimitException.struct_class = Types::ExceedsLimitException
|
392
410
|
|
411
|
+
FailedRecord.add_member(:input_source_arn, Shapes::ShapeRef.new(shape: FailedRecordInputSourceARNString, required: true, location_name: "inputSourceARN"))
|
412
|
+
FailedRecord.add_member(:unique_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "uniqueId"))
|
413
|
+
FailedRecord.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "errorMessage"))
|
414
|
+
FailedRecord.struct_class = Types::FailedRecord
|
415
|
+
|
416
|
+
FailedRecordsList.member = Shapes::ShapeRef.new(shape: FailedRecord)
|
417
|
+
|
418
|
+
GenerateMatchIdInput.add_member(:workflow_name, Shapes::ShapeRef.new(shape: EntityName, required: true, location: "uri", location_name: "workflowName"))
|
419
|
+
GenerateMatchIdInput.add_member(:records, Shapes::ShapeRef.new(shape: GenerateMatchIdInputRecordsList, required: true, location_name: "records"))
|
420
|
+
GenerateMatchIdInput.add_member(:processing_type, Shapes::ShapeRef.new(shape: ProcessingType, location_name: "processingType"))
|
421
|
+
GenerateMatchIdInput.struct_class = Types::GenerateMatchIdInput
|
422
|
+
|
423
|
+
GenerateMatchIdInputRecordsList.member = Shapes::ShapeRef.new(shape: Record)
|
424
|
+
|
425
|
+
GenerateMatchIdOutput.add_member(:match_groups, Shapes::ShapeRef.new(shape: MatchGroupsList, required: true, location_name: "matchGroups"))
|
426
|
+
GenerateMatchIdOutput.add_member(:failed_records, Shapes::ShapeRef.new(shape: FailedRecordsList, required: true, location_name: "failedRecords"))
|
427
|
+
GenerateMatchIdOutput.struct_class = Types::GenerateMatchIdOutput
|
428
|
+
|
393
429
|
GetIdMappingJobInput.add_member(:workflow_name, Shapes::ShapeRef.new(shape: EntityNameOrIdMappingWorkflowArn, required: true, location: "uri", location_name: "workflowName"))
|
394
430
|
GetIdMappingJobInput.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
|
395
431
|
GetIdMappingJobInput.struct_class = Types::GetIdMappingJobInput
|
@@ -694,6 +730,19 @@ module Aws::EntityResolution
|
|
694
730
|
ListTagsForResourceOutput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, required: true, location_name: "tags"))
|
695
731
|
ListTagsForResourceOutput.struct_class = Types::ListTagsForResourceOutput
|
696
732
|
|
733
|
+
MatchGroup.add_member(:records, Shapes::ShapeRef.new(shape: MatchedRecordsList, required: true, location_name: "records"))
|
734
|
+
MatchGroup.add_member(:match_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "matchId"))
|
735
|
+
MatchGroup.add_member(:match_rule, Shapes::ShapeRef.new(shape: String, required: true, location_name: "matchRule"))
|
736
|
+
MatchGroup.struct_class = Types::MatchGroup
|
737
|
+
|
738
|
+
MatchGroupsList.member = Shapes::ShapeRef.new(shape: MatchGroup)
|
739
|
+
|
740
|
+
MatchedRecord.add_member(:input_source_arn, Shapes::ShapeRef.new(shape: MatchedRecordInputSourceARNString, required: true, location_name: "inputSourceARN"))
|
741
|
+
MatchedRecord.add_member(:record_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "recordId"))
|
742
|
+
MatchedRecord.struct_class = Types::MatchedRecord
|
743
|
+
|
744
|
+
MatchedRecordsList.member = Shapes::ShapeRef.new(shape: MatchedRecord)
|
745
|
+
|
697
746
|
MatchingWorkflowList.member = Shapes::ShapeRef.new(shape: MatchingWorkflowSummary)
|
698
747
|
|
699
748
|
MatchingWorkflowSummary.add_member(:workflow_name, Shapes::ShapeRef.new(shape: EntityName, required: true, location_name: "workflowName"))
|
@@ -786,9 +835,17 @@ module Aws::EntityResolution
|
|
786
835
|
PutPolicyOutput.add_member(:policy, Shapes::ShapeRef.new(shape: PolicyDocument, location_name: "policy"))
|
787
836
|
PutPolicyOutput.struct_class = Types::PutPolicyOutput
|
788
837
|
|
838
|
+
Record.add_member(:input_source_arn, Shapes::ShapeRef.new(shape: RecordInputSourceARNString, required: true, location_name: "inputSourceARN"))
|
839
|
+
Record.add_member(:unique_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location_name: "uniqueId"))
|
840
|
+
Record.add_member(:record_attribute_map, Shapes::ShapeRef.new(shape: RecordAttributeMapString255, required: true, location_name: "recordAttributeMap"))
|
841
|
+
Record.struct_class = Types::Record
|
842
|
+
|
789
843
|
RecordAttributeMap.key = Shapes::ShapeRef.new(shape: RecordAttributeMapKeyString)
|
790
844
|
RecordAttributeMap.value = Shapes::ShapeRef.new(shape: RecordAttributeMapValueString)
|
791
845
|
|
846
|
+
RecordAttributeMapString255.key = Shapes::ShapeRef.new(shape: RecordAttributeMapString255KeyString)
|
847
|
+
RecordAttributeMapString255.value = Shapes::ShapeRef.new(shape: RecordAttributeMapString255ValueString)
|
848
|
+
|
792
849
|
RecordMatchingModelList.member = Shapes::ShapeRef.new(shape: RecordMatchingModel)
|
793
850
|
|
794
851
|
RequiredBucketActionsList.member = Shapes::ShapeRef.new(shape: String)
|
@@ -1111,6 +1168,19 @@ module Aws::EntityResolution
|
|
1111
1168
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1112
1169
|
end)
|
1113
1170
|
|
1171
|
+
api.add_operation(:generate_match_id, Seahorse::Model::Operation.new.tap do |o|
|
1172
|
+
o.name = "GenerateMatchId"
|
1173
|
+
o.http_method = "POST"
|
1174
|
+
o.http_request_uri = "/matchingworkflows/{workflowName}/generateMatches"
|
1175
|
+
o.input = Shapes::ShapeRef.new(shape: GenerateMatchIdInput)
|
1176
|
+
o.output = Shapes::ShapeRef.new(shape: GenerateMatchIdOutput)
|
1177
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1178
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1179
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1180
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1181
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1182
|
+
end)
|
1183
|
+
|
1114
1184
|
api.add_operation(:get_id_mapping_job, Seahorse::Model::Operation.new.tap do |o|
|
1115
1185
|
o.name = "GetIdMappingJob"
|
1116
1186
|
o.http_method = "GET"
|
@@ -757,6 +757,87 @@ module Aws::EntityResolution
|
|
757
757
|
include Aws::Structure
|
758
758
|
end
|
759
759
|
|
760
|
+
# The record that didn't generate a Match ID.
|
761
|
+
#
|
762
|
+
# @!attribute [rw] input_source_arn
|
763
|
+
# The input source ARN of the record that didn't generate a Match ID.
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] unique_id
|
767
|
+
# The unique ID of the record that didn't generate a Match ID.
|
768
|
+
# @return [String]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] error_message
|
771
|
+
# The error message for the record that didn't generate a Match ID.
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/FailedRecord AWS API Documentation
|
775
|
+
#
|
776
|
+
class FailedRecord < Struct.new(
|
777
|
+
:input_source_arn,
|
778
|
+
:unique_id,
|
779
|
+
:error_message)
|
780
|
+
SENSITIVE = []
|
781
|
+
include Aws::Structure
|
782
|
+
end
|
783
|
+
|
784
|
+
# @!attribute [rw] workflow_name
|
785
|
+
# The name of the rule-based matching workflow.
|
786
|
+
# @return [String]
|
787
|
+
#
|
788
|
+
# @!attribute [rw] records
|
789
|
+
# The records to match.
|
790
|
+
# @return [Array<Types::Record>]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] processing_type
|
793
|
+
# The processing mode that determines how Match IDs are generated and
|
794
|
+
# results are saved. Each mode provides different levels of accuracy,
|
795
|
+
# response time, and completeness of results.
|
796
|
+
#
|
797
|
+
# If not specified, defaults to `CONSISTENT`.
|
798
|
+
#
|
799
|
+
# `CONSISTENT`: Performs immediate lookup and matching against all
|
800
|
+
# existing records, with results saved synchronously. Provides highest
|
801
|
+
# accuracy but slower response time.
|
802
|
+
#
|
803
|
+
# `EVENTUAL` (shown as *Background* in the console): Performs initial
|
804
|
+
# match ID lookup or generation immediately, with record updates
|
805
|
+
# processed asynchronously in the background. Offers faster initial
|
806
|
+
# response time, with complete matching results available later in S3.
|
807
|
+
#
|
808
|
+
# `EVENTUAL_NO_LOOKUP` (shown as *Quick ID generation* in the
|
809
|
+
# console): Generates new match IDs without checking existing matches,
|
810
|
+
# with updates processed asynchronously. Provides fastest response
|
811
|
+
# time but should only be used for records known to be unique.
|
812
|
+
# @return [String]
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GenerateMatchIdInput AWS API Documentation
|
815
|
+
#
|
816
|
+
class GenerateMatchIdInput < Struct.new(
|
817
|
+
:workflow_name,
|
818
|
+
:records,
|
819
|
+
:processing_type)
|
820
|
+
SENSITIVE = []
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
824
|
+
# @!attribute [rw] match_groups
|
825
|
+
# The match groups from the generated match ID.
|
826
|
+
# @return [Array<Types::MatchGroup>]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] failed_records
|
829
|
+
# The records that didn't receive a generated Match ID.
|
830
|
+
# @return [Array<Types::FailedRecord>]
|
831
|
+
#
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GenerateMatchIdOutput AWS API Documentation
|
833
|
+
#
|
834
|
+
class GenerateMatchIdOutput < Struct.new(
|
835
|
+
:match_groups,
|
836
|
+
:failed_records)
|
837
|
+
SENSITIVE = []
|
838
|
+
include Aws::Structure
|
839
|
+
end
|
840
|
+
|
760
841
|
# @!attribute [rw] workflow_name
|
761
842
|
# The name of the workflow.
|
762
843
|
# @return [String]
|
@@ -1035,7 +1116,7 @@ module Aws::EntityResolution
|
|
1035
1116
|
end
|
1036
1117
|
|
1037
1118
|
# @!attribute [rw] job_id
|
1038
|
-
# The
|
1119
|
+
# The unique identifier of the matching job.
|
1039
1120
|
# @return [String]
|
1040
1121
|
#
|
1041
1122
|
# @!attribute [rw] status
|
@@ -1321,7 +1402,7 @@ module Aws::EntityResolution
|
|
1321
1402
|
# @!attribute [rw] mapped_input_fields
|
1322
1403
|
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
1323
1404
|
# to a column the source data table, and contains column name plus
|
1324
|
-
# additional information
|
1405
|
+
# additional information Entity Resolution uses for matching.
|
1325
1406
|
# @return [Array<Types::SchemaInputAttribute>]
|
1326
1407
|
#
|
1327
1408
|
# @!attribute [rw] created_at
|
@@ -2154,6 +2235,49 @@ module Aws::EntityResolution
|
|
2154
2235
|
include Aws::Structure
|
2155
2236
|
end
|
2156
2237
|
|
2238
|
+
# The match group.
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] records
|
2241
|
+
# The matched records.
|
2242
|
+
# @return [Array<Types::MatchedRecord>]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] match_id
|
2245
|
+
# The match ID.
|
2246
|
+
# @return [String]
|
2247
|
+
#
|
2248
|
+
# @!attribute [rw] match_rule
|
2249
|
+
# The match rule of the match group.
|
2250
|
+
# @return [String]
|
2251
|
+
#
|
2252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/MatchGroup AWS API Documentation
|
2253
|
+
#
|
2254
|
+
class MatchGroup < Struct.new(
|
2255
|
+
:records,
|
2256
|
+
:match_id,
|
2257
|
+
:match_rule)
|
2258
|
+
SENSITIVE = []
|
2259
|
+
include Aws::Structure
|
2260
|
+
end
|
2261
|
+
|
2262
|
+
# The matched record.
|
2263
|
+
#
|
2264
|
+
# @!attribute [rw] input_source_arn
|
2265
|
+
# The input source ARN of the matched record.
|
2266
|
+
# @return [String]
|
2267
|
+
#
|
2268
|
+
# @!attribute [rw] record_id
|
2269
|
+
# The record ID of the matched record.
|
2270
|
+
# @return [String]
|
2271
|
+
#
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/MatchedRecord AWS API Documentation
|
2273
|
+
#
|
2274
|
+
class MatchedRecord < Struct.new(
|
2275
|
+
:input_source_arn,
|
2276
|
+
:record_id)
|
2277
|
+
SENSITIVE = []
|
2278
|
+
include Aws::Structure
|
2279
|
+
end
|
2280
|
+
|
2157
2281
|
# A list of `MatchingWorkflowSummary` objects, each of which contain the
|
2158
2282
|
# fields `WorkflowName`, `WorkflowArn`, `CreatedAt`, `UpdatedAt`.
|
2159
2283
|
#
|
@@ -2596,6 +2720,30 @@ module Aws::EntityResolution
|
|
2596
2720
|
include Aws::Structure
|
2597
2721
|
end
|
2598
2722
|
|
2723
|
+
# The record.
|
2724
|
+
#
|
2725
|
+
# @!attribute [rw] input_source_arn
|
2726
|
+
# The input source ARN of the record.
|
2727
|
+
# @return [String]
|
2728
|
+
#
|
2729
|
+
# @!attribute [rw] unique_id
|
2730
|
+
# The unique ID of the record.
|
2731
|
+
# @return [String]
|
2732
|
+
#
|
2733
|
+
# @!attribute [rw] record_attribute_map
|
2734
|
+
# The record's attribute map.
|
2735
|
+
# @return [Hash<String,String>]
|
2736
|
+
#
|
2737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/Record AWS API Documentation
|
2738
|
+
#
|
2739
|
+
class Record < Struct.new(
|
2740
|
+
:input_source_arn,
|
2741
|
+
:unique_id,
|
2742
|
+
:record_attribute_map)
|
2743
|
+
SENSITIVE = [:record_attribute_map]
|
2744
|
+
include Aws::Structure
|
2745
|
+
end
|
2746
|
+
|
2599
2747
|
# An object which defines the `resolutionType` and the
|
2600
2748
|
# `ruleBasedProperties`.
|
2601
2749
|
#
|
@@ -3204,7 +3352,7 @@ module Aws::EntityResolution
|
|
3204
3352
|
#
|
3205
3353
|
# @!attribute [rw] resolution_techniques
|
3206
3354
|
# An object which defines the `resolutionType` and the
|
3207
|
-
# `ruleBasedProperties
|
3355
|
+
# `ruleBasedProperties`.
|
3208
3356
|
# @return [Types::ResolutionTechniques]
|
3209
3357
|
#
|
3210
3358
|
# @!attribute [rw] incremental_run_config
|
data/sig/client.rbs
CHANGED
@@ -355,6 +355,25 @@ module Aws
|
|
355
355
|
) -> _DeleteSchemaMappingResponseSuccess
|
356
356
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteSchemaMappingResponseSuccess
|
357
357
|
|
358
|
+
interface _GenerateMatchIdResponseSuccess
|
359
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateMatchIdOutput]
|
360
|
+
def match_groups: () -> ::Array[Types::MatchGroup]
|
361
|
+
def failed_records: () -> ::Array[Types::FailedRecord]
|
362
|
+
end
|
363
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EntityResolution/Client.html#generate_match_id-instance_method
|
364
|
+
def generate_match_id: (
|
365
|
+
workflow_name: ::String,
|
366
|
+
records: Array[
|
367
|
+
{
|
368
|
+
input_source_arn: ::String,
|
369
|
+
unique_id: ::String,
|
370
|
+
record_attribute_map: Hash[::String, ::String]
|
371
|
+
},
|
372
|
+
],
|
373
|
+
?processing_type: ("CONSISTENT" | "EVENTUAL" | "EVENTUAL_NO_LOOKUP")
|
374
|
+
) -> _GenerateMatchIdResponseSuccess
|
375
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateMatchIdResponseSuccess
|
376
|
+
|
358
377
|
interface _GetIdMappingJobResponseSuccess
|
359
378
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetIdMappingJobOutput]
|
360
379
|
def job_id: () -> ::String
|
data/sig/types.rbs
CHANGED
@@ -213,6 +213,26 @@ module Aws::EntityResolution
|
|
213
213
|
SENSITIVE: []
|
214
214
|
end
|
215
215
|
|
216
|
+
class FailedRecord
|
217
|
+
attr_accessor input_source_arn: ::String
|
218
|
+
attr_accessor unique_id: ::String
|
219
|
+
attr_accessor error_message: ::String
|
220
|
+
SENSITIVE: []
|
221
|
+
end
|
222
|
+
|
223
|
+
class GenerateMatchIdInput
|
224
|
+
attr_accessor workflow_name: ::String
|
225
|
+
attr_accessor records: ::Array[Types::Record]
|
226
|
+
attr_accessor processing_type: ("CONSISTENT" | "EVENTUAL" | "EVENTUAL_NO_LOOKUP")
|
227
|
+
SENSITIVE: []
|
228
|
+
end
|
229
|
+
|
230
|
+
class GenerateMatchIdOutput
|
231
|
+
attr_accessor match_groups: ::Array[Types::MatchGroup]
|
232
|
+
attr_accessor failed_records: ::Array[Types::FailedRecord]
|
233
|
+
SENSITIVE: []
|
234
|
+
end
|
235
|
+
|
216
236
|
class GetIdMappingJobInput
|
217
237
|
attr_accessor workflow_name: ::String
|
218
238
|
attr_accessor job_id: ::String
|
@@ -595,6 +615,19 @@ module Aws::EntityResolution
|
|
595
615
|
SENSITIVE: []
|
596
616
|
end
|
597
617
|
|
618
|
+
class MatchGroup
|
619
|
+
attr_accessor records: ::Array[Types::MatchedRecord]
|
620
|
+
attr_accessor match_id: ::String
|
621
|
+
attr_accessor match_rule: ::String
|
622
|
+
SENSITIVE: []
|
623
|
+
end
|
624
|
+
|
625
|
+
class MatchedRecord
|
626
|
+
attr_accessor input_source_arn: ::String
|
627
|
+
attr_accessor record_id: ::String
|
628
|
+
SENSITIVE: []
|
629
|
+
end
|
630
|
+
|
598
631
|
class MatchingWorkflowSummary
|
599
632
|
attr_accessor workflow_name: ::String
|
600
633
|
attr_accessor workflow_arn: ::String
|
@@ -708,6 +741,13 @@ module Aws::EntityResolution
|
|
708
741
|
SENSITIVE: []
|
709
742
|
end
|
710
743
|
|
744
|
+
class Record
|
745
|
+
attr_accessor input_source_arn: ::String
|
746
|
+
attr_accessor unique_id: ::String
|
747
|
+
attr_accessor record_attribute_map: ::Hash[::String, ::String]
|
748
|
+
SENSITIVE: [:record_attribute_map]
|
749
|
+
end
|
750
|
+
|
711
751
|
class ResolutionTechniques
|
712
752
|
attr_accessor resolution_type: ("RULE_MATCHING" | "ML_MATCHING" | "PROVIDER")
|
713
753
|
attr_accessor rule_based_properties: Types::RuleBasedProperties
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-entityresolution
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.31.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
@@ -18,7 +18,7 @@ dependencies:
|
|
18
18
|
version: '3'
|
19
19
|
- - ">="
|
20
20
|
- !ruby/object:Gem::Version
|
21
|
-
version: 3.
|
21
|
+
version: 3.225.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -28,7 +28,7 @@ dependencies:
|
|
28
28
|
version: '3'
|
29
29
|
- - ">="
|
30
30
|
- !ruby/object:Gem::Version
|
31
|
-
version: 3.
|
31
|
+
version: 3.225.0
|
32
32
|
- !ruby/object:Gem::Dependency
|
33
33
|
name: aws-sigv4
|
34
34
|
requirement: !ruby/object:Gem::Requirement
|
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
83
83
|
requirements:
|
84
84
|
- - ">="
|
85
85
|
- !ruby/object:Gem::Version
|
86
|
-
version: '2.
|
86
|
+
version: '2.7'
|
87
87
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
88
|
requirements:
|
89
89
|
- - ">="
|