aws-sdk-entityresolution 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-entityresolution/client.rb +1239 -0
- data/lib/aws-sdk-entityresolution/client_api.rb +619 -0
- data/lib/aws-sdk-entityresolution/customizations.rb +0 -0
- data/lib/aws-sdk-entityresolution/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-entityresolution/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-entityresolution/endpoints.rb +240 -0
- data/lib/aws-sdk-entityresolution/errors.rb +162 -0
- data/lib/aws-sdk-entityresolution/plugins/endpoints.rb +100 -0
- data/lib/aws-sdk-entityresolution/resource.rb +26 -0
- data/lib/aws-sdk-entityresolution/types.rb +1217 -0
- data/lib/aws-sdk-entityresolution.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1217 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::EntityResolution
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action. `HTTP Status
|
14
|
+
# Code: 403`
|
15
|
+
#
|
16
|
+
# @!attribute [rw] message
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/AccessDeniedException AWS API Documentation
|
20
|
+
#
|
21
|
+
class AccessDeniedException < Struct.new(
|
22
|
+
:message)
|
23
|
+
SENSITIVE = []
|
24
|
+
include Aws::Structure
|
25
|
+
end
|
26
|
+
|
27
|
+
# The request could not be processed because of conflict in the current
|
28
|
+
# state of the resource. Example: Workflow already exists, Schema
|
29
|
+
# already exists, Workflow is currently running, etc. `HTTP Status Code:
|
30
|
+
# 400`
|
31
|
+
#
|
32
|
+
# @!attribute [rw] message
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ConflictException AWS API Documentation
|
36
|
+
#
|
37
|
+
class ConflictException < Struct.new(
|
38
|
+
:message)
|
39
|
+
SENSITIVE = []
|
40
|
+
include Aws::Structure
|
41
|
+
end
|
42
|
+
|
43
|
+
# @!attribute [rw] description
|
44
|
+
# A description of the workflow.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] incremental_run_config
|
48
|
+
# An object which defines an incremental run type and has only
|
49
|
+
# `incrementalRunType` as a field.
|
50
|
+
# @return [Types::IncrementalRunConfig]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] input_source_config
|
53
|
+
# A list of `InputSource` objects, which have the fields
|
54
|
+
# `InputSourceARN` and `SchemaName`.
|
55
|
+
# @return [Array<Types::InputSource>]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] output_source_config
|
58
|
+
# A list of `OutputSource` objects, each of which contains fields
|
59
|
+
# `OutputS3Path`, `ApplyNormalization`, and `Output`.
|
60
|
+
# @return [Array<Types::OutputSource>]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] resolution_techniques
|
63
|
+
# An object which defines the `resolutionType` and the
|
64
|
+
# `ruleBasedProperties`
|
65
|
+
# @return [Types::ResolutionTechniques]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] role_arn
|
68
|
+
# The Amazon Resource Name (ARN) of the IAM role. AWS Entity
|
69
|
+
# Resolution assumes this role to create resources on your behalf as
|
70
|
+
# part of workflow execution.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] tags
|
74
|
+
# The tags used to organize, track, or control access for this
|
75
|
+
# resource.
|
76
|
+
# @return [Hash<String,String>]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] workflow_name
|
79
|
+
# The name of the workflow. There cannot be multiple
|
80
|
+
# `DataIntegrationWorkflows` with the same name.
|
81
|
+
# @return [String]
|
82
|
+
#
|
83
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateMatchingWorkflowInput AWS API Documentation
|
84
|
+
#
|
85
|
+
class CreateMatchingWorkflowInput < Struct.new(
|
86
|
+
:description,
|
87
|
+
:incremental_run_config,
|
88
|
+
:input_source_config,
|
89
|
+
:output_source_config,
|
90
|
+
:resolution_techniques,
|
91
|
+
:role_arn,
|
92
|
+
:tags,
|
93
|
+
:workflow_name)
|
94
|
+
SENSITIVE = []
|
95
|
+
include Aws::Structure
|
96
|
+
end
|
97
|
+
|
98
|
+
# @!attribute [rw] description
|
99
|
+
# A description of the workflow.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @!attribute [rw] incremental_run_config
|
103
|
+
# An object which defines an incremental run type and has only
|
104
|
+
# `incrementalRunType` as a field.
|
105
|
+
# @return [Types::IncrementalRunConfig]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] input_source_config
|
108
|
+
# A list of `InputSource` objects, which have the fields
|
109
|
+
# `InputSourceARN` and `SchemaName`.
|
110
|
+
# @return [Array<Types::InputSource>]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] output_source_config
|
113
|
+
# A list of `OutputSource` objects, each of which contains fields
|
114
|
+
# `OutputS3Path`, `ApplyNormalization`, and `Output`.
|
115
|
+
# @return [Array<Types::OutputSource>]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] resolution_techniques
|
118
|
+
# An object which defines the `resolutionType` and the
|
119
|
+
# `ruleBasedProperties`
|
120
|
+
# @return [Types::ResolutionTechniques]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] role_arn
|
123
|
+
# The Amazon Resource Name (ARN) of the IAM role. AWS Entity
|
124
|
+
# Resolution assumes this role to create resources on your behalf as
|
125
|
+
# part of workflow execution.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] workflow_arn
|
129
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
130
|
+
# the `MatchingWorkflow`.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] workflow_name
|
134
|
+
# The name of the workflow.
|
135
|
+
# @return [String]
|
136
|
+
#
|
137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateMatchingWorkflowOutput AWS API Documentation
|
138
|
+
#
|
139
|
+
class CreateMatchingWorkflowOutput < Struct.new(
|
140
|
+
:description,
|
141
|
+
:incremental_run_config,
|
142
|
+
:input_source_config,
|
143
|
+
:output_source_config,
|
144
|
+
:resolution_techniques,
|
145
|
+
:role_arn,
|
146
|
+
:workflow_arn,
|
147
|
+
:workflow_name)
|
148
|
+
SENSITIVE = []
|
149
|
+
include Aws::Structure
|
150
|
+
end
|
151
|
+
|
152
|
+
# @!attribute [rw] description
|
153
|
+
# A description of the schema.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] mapped_input_fields
|
157
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
158
|
+
# to a column the source data table, and contains column name plus
|
159
|
+
# additional information that Entity Resolution uses for matching.
|
160
|
+
# @return [Array<Types::SchemaInputAttribute>]
|
161
|
+
#
|
162
|
+
# @!attribute [rw] schema_name
|
163
|
+
# The name of the schema. There cannot be multiple `SchemaMappings`
|
164
|
+
# with the same name.
|
165
|
+
# @return [String]
|
166
|
+
#
|
167
|
+
# @!attribute [rw] tags
|
168
|
+
# The tags used to organize, track, or control access for this
|
169
|
+
# resource.
|
170
|
+
# @return [Hash<String,String>]
|
171
|
+
#
|
172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateSchemaMappingInput AWS API Documentation
|
173
|
+
#
|
174
|
+
class CreateSchemaMappingInput < Struct.new(
|
175
|
+
:description,
|
176
|
+
:mapped_input_fields,
|
177
|
+
:schema_name,
|
178
|
+
:tags)
|
179
|
+
SENSITIVE = []
|
180
|
+
include Aws::Structure
|
181
|
+
end
|
182
|
+
|
183
|
+
# @!attribute [rw] description
|
184
|
+
# A description of the schema.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] mapped_input_fields
|
188
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
189
|
+
# to a column the source data table, and contains column name plus
|
190
|
+
# additional information that Entity Resolution uses for matching.
|
191
|
+
# @return [Array<Types::SchemaInputAttribute>]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] schema_arn
|
194
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
195
|
+
# the `SchemaMapping`.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] schema_name
|
199
|
+
# The name of the schema.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/CreateSchemaMappingOutput AWS API Documentation
|
203
|
+
#
|
204
|
+
class CreateSchemaMappingOutput < Struct.new(
|
205
|
+
:description,
|
206
|
+
:mapped_input_fields,
|
207
|
+
:schema_arn,
|
208
|
+
:schema_name)
|
209
|
+
SENSITIVE = []
|
210
|
+
include Aws::Structure
|
211
|
+
end
|
212
|
+
|
213
|
+
# @!attribute [rw] workflow_name
|
214
|
+
# The name of the workflow to be retrieved.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteMatchingWorkflowInput AWS API Documentation
|
218
|
+
#
|
219
|
+
class DeleteMatchingWorkflowInput < Struct.new(
|
220
|
+
:workflow_name)
|
221
|
+
SENSITIVE = []
|
222
|
+
include Aws::Structure
|
223
|
+
end
|
224
|
+
|
225
|
+
# @!attribute [rw] message
|
226
|
+
# A successful operation message.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteMatchingWorkflowOutput AWS API Documentation
|
230
|
+
#
|
231
|
+
class DeleteMatchingWorkflowOutput < Struct.new(
|
232
|
+
:message)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# @!attribute [rw] schema_name
|
238
|
+
# The name of the schema to delete.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteSchemaMappingInput AWS API Documentation
|
242
|
+
#
|
243
|
+
class DeleteSchemaMappingInput < Struct.new(
|
244
|
+
:schema_name)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
249
|
+
# @!attribute [rw] message
|
250
|
+
# A successful operation message.
|
251
|
+
# @return [String]
|
252
|
+
#
|
253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/DeleteSchemaMappingOutput AWS API Documentation
|
254
|
+
#
|
255
|
+
class DeleteSchemaMappingOutput < Struct.new(
|
256
|
+
:message)
|
257
|
+
SENSITIVE = []
|
258
|
+
include Aws::Structure
|
259
|
+
end
|
260
|
+
|
261
|
+
# An object containing an error message, if there was an error.
|
262
|
+
#
|
263
|
+
# @!attribute [rw] error_message
|
264
|
+
# The error message from the job, if there is one.
|
265
|
+
# @return [String]
|
266
|
+
#
|
267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ErrorDetails AWS API Documentation
|
268
|
+
#
|
269
|
+
class ErrorDetails < Struct.new(
|
270
|
+
:error_message)
|
271
|
+
SENSITIVE = []
|
272
|
+
include Aws::Structure
|
273
|
+
end
|
274
|
+
|
275
|
+
# The request was rejected because it attempted to create resources
|
276
|
+
# beyond the current AWS Entity Resolution account limits. The error
|
277
|
+
# message describes the limit exceeded. `HTTP Status Code: 402`
|
278
|
+
#
|
279
|
+
# @!attribute [rw] message
|
280
|
+
# @return [String]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ExceedsLimitException AWS API Documentation
|
283
|
+
#
|
284
|
+
class ExceedsLimitException < Struct.new(
|
285
|
+
:message)
|
286
|
+
SENSITIVE = []
|
287
|
+
include Aws::Structure
|
288
|
+
end
|
289
|
+
|
290
|
+
# @!attribute [rw] record
|
291
|
+
# The record to fetch the Match ID for.
|
292
|
+
# @return [Hash<String,String>]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] workflow_name
|
295
|
+
# The name of the workflow.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchIdInput AWS API Documentation
|
299
|
+
#
|
300
|
+
class GetMatchIdInput < Struct.new(
|
301
|
+
:record,
|
302
|
+
:workflow_name)
|
303
|
+
SENSITIVE = [:record]
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# @!attribute [rw] match_id
|
308
|
+
# The unique identifiers for this group of match records.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchIdOutput AWS API Documentation
|
312
|
+
#
|
313
|
+
class GetMatchIdOutput < Struct.new(
|
314
|
+
:match_id)
|
315
|
+
SENSITIVE = []
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# @!attribute [rw] job_id
|
320
|
+
# The ID of the job.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] workflow_name
|
324
|
+
# The name of the workflow.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingJobInput AWS API Documentation
|
328
|
+
#
|
329
|
+
class GetMatchingJobInput < Struct.new(
|
330
|
+
:job_id,
|
331
|
+
:workflow_name)
|
332
|
+
SENSITIVE = []
|
333
|
+
include Aws::Structure
|
334
|
+
end
|
335
|
+
|
336
|
+
# @!attribute [rw] end_time
|
337
|
+
# The time at which the job has finished.
|
338
|
+
# @return [Time]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] error_details
|
341
|
+
# An object containing an error message, if there was an error.
|
342
|
+
# @return [Types::ErrorDetails]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] job_id
|
345
|
+
# The ID of the job.
|
346
|
+
# @return [String]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] metrics
|
349
|
+
# Metrics associated with the execution, specifically total records
|
350
|
+
# processed, unique IDs generated, and records the execution skipped.
|
351
|
+
# @return [Types::JobMetrics]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] start_time
|
354
|
+
# The time at which the job was started.
|
355
|
+
# @return [Time]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] status
|
358
|
+
# The current status of the job. Either `running`, `succeeded`,
|
359
|
+
# `queued`, or `failed`.
|
360
|
+
# @return [String]
|
361
|
+
#
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingJobOutput AWS API Documentation
|
363
|
+
#
|
364
|
+
class GetMatchingJobOutput < Struct.new(
|
365
|
+
:end_time,
|
366
|
+
:error_details,
|
367
|
+
:job_id,
|
368
|
+
:metrics,
|
369
|
+
:start_time,
|
370
|
+
:status)
|
371
|
+
SENSITIVE = []
|
372
|
+
include Aws::Structure
|
373
|
+
end
|
374
|
+
|
375
|
+
# @!attribute [rw] workflow_name
|
376
|
+
# The name of the workflow.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingWorkflowInput AWS API Documentation
|
380
|
+
#
|
381
|
+
class GetMatchingWorkflowInput < Struct.new(
|
382
|
+
:workflow_name)
|
383
|
+
SENSITIVE = []
|
384
|
+
include Aws::Structure
|
385
|
+
end
|
386
|
+
|
387
|
+
# @!attribute [rw] created_at
|
388
|
+
# The timestamp of when the workflow was created.
|
389
|
+
# @return [Time]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] description
|
392
|
+
# A description of the workflow.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] incremental_run_config
|
396
|
+
# An object which defines an incremental run type and has only
|
397
|
+
# `incrementalRunType` as a field.
|
398
|
+
# @return [Types::IncrementalRunConfig]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] input_source_config
|
401
|
+
# A list of `InputSource` objects, which have the fields
|
402
|
+
# `InputSourceARN` and `SchemaName`.
|
403
|
+
# @return [Array<Types::InputSource>]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] output_source_config
|
406
|
+
# A list of `OutputSource` objects, each of which contains fields
|
407
|
+
# `OutputS3Path`, `ApplyNormalization`, and `Output`.
|
408
|
+
# @return [Array<Types::OutputSource>]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] resolution_techniques
|
411
|
+
# An object which defines the `resolutionType` and the
|
412
|
+
# `ruleBasedProperties`
|
413
|
+
# @return [Types::ResolutionTechniques]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] role_arn
|
416
|
+
# The Amazon Resource Name (ARN) of the IAM role. AWS Entity
|
417
|
+
# Resolution assumes this role to access resources on your behalf.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] tags
|
421
|
+
# The tags used to organize, track, or control access for this
|
422
|
+
# resource.
|
423
|
+
# @return [Hash<String,String>]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] updated_at
|
426
|
+
# The timestamp of when the workflow was last updated.
|
427
|
+
# @return [Time]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] workflow_arn
|
430
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
431
|
+
# the `MatchingWorkflow`.
|
432
|
+
# @return [String]
|
433
|
+
#
|
434
|
+
# @!attribute [rw] workflow_name
|
435
|
+
# The name of the workflow.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchingWorkflowOutput AWS API Documentation
|
439
|
+
#
|
440
|
+
class GetMatchingWorkflowOutput < Struct.new(
|
441
|
+
:created_at,
|
442
|
+
:description,
|
443
|
+
:incremental_run_config,
|
444
|
+
:input_source_config,
|
445
|
+
:output_source_config,
|
446
|
+
:resolution_techniques,
|
447
|
+
:role_arn,
|
448
|
+
:tags,
|
449
|
+
:updated_at,
|
450
|
+
:workflow_arn,
|
451
|
+
:workflow_name)
|
452
|
+
SENSITIVE = []
|
453
|
+
include Aws::Structure
|
454
|
+
end
|
455
|
+
|
456
|
+
# @!attribute [rw] schema_name
|
457
|
+
# The name of the schema to be retrieved.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetSchemaMappingInput AWS API Documentation
|
461
|
+
#
|
462
|
+
class GetSchemaMappingInput < Struct.new(
|
463
|
+
:schema_name)
|
464
|
+
SENSITIVE = []
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# @!attribute [rw] created_at
|
469
|
+
# The timestamp of when the `SchemaMapping` was created.
|
470
|
+
# @return [Time]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] description
|
473
|
+
# A description of the schema.
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @!attribute [rw] mapped_input_fields
|
477
|
+
# A list of `MappedInputFields`. Each `MappedInputField` corresponds
|
478
|
+
# to a column the source data table, and contains column name plus
|
479
|
+
# additional information Venice uses for matching.
|
480
|
+
# @return [Array<Types::SchemaInputAttribute>]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] schema_arn
|
483
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
484
|
+
# the SchemaMapping.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] schema_name
|
488
|
+
# The name of the schema.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] tags
|
492
|
+
# The tags used to organize, track, or control access for this
|
493
|
+
# resource.
|
494
|
+
# @return [Hash<String,String>]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] updated_at
|
497
|
+
# The timestamp of when the `SchemaMapping` was last updated.
|
498
|
+
# @return [Time]
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetSchemaMappingOutput AWS API Documentation
|
501
|
+
#
|
502
|
+
class GetSchemaMappingOutput < Struct.new(
|
503
|
+
:created_at,
|
504
|
+
:description,
|
505
|
+
:mapped_input_fields,
|
506
|
+
:schema_arn,
|
507
|
+
:schema_name,
|
508
|
+
:tags,
|
509
|
+
:updated_at)
|
510
|
+
SENSITIVE = []
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
514
|
+
# An object which defines an incremental run type and has only
|
515
|
+
# `incrementalRunType` as a field.
|
516
|
+
#
|
517
|
+
# @!attribute [rw] incremental_run_type
|
518
|
+
# The type of incremental run. It takes only one value: `IMMEDIATE`.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/IncrementalRunConfig AWS API Documentation
|
522
|
+
#
|
523
|
+
class IncrementalRunConfig < Struct.new(
|
524
|
+
:incremental_run_type)
|
525
|
+
SENSITIVE = []
|
526
|
+
include Aws::Structure
|
527
|
+
end
|
528
|
+
|
529
|
+
# An object containing `InputSourceARN`, `SchemaName`, and
|
530
|
+
# `ApplyNormalization`.
|
531
|
+
#
|
532
|
+
# @!attribute [rw] apply_normalization
|
533
|
+
# Normalizes the attributes defined in the schema in the input data.
|
534
|
+
# For example, if an attribute has an `AttributeType` of
|
535
|
+
# `PHONE_NUMBER`, and the data in the input table is in a format of
|
536
|
+
# 1234567890, Entity Resolution will normalize this field in the
|
537
|
+
# output to (123)-456-7890.
|
538
|
+
# @return [Boolean]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] input_source_arn
|
541
|
+
# An Glue table ARN for the input source table.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] schema_name
|
545
|
+
# The name of the schema to be retrieved.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/InputSource AWS API Documentation
|
549
|
+
#
|
550
|
+
class InputSource < Struct.new(
|
551
|
+
:apply_normalization,
|
552
|
+
:input_source_arn,
|
553
|
+
:schema_name)
|
554
|
+
SENSITIVE = []
|
555
|
+
include Aws::Structure
|
556
|
+
end
|
557
|
+
|
558
|
+
# This exception occurs when there is an internal failure in the AWS
|
559
|
+
# Entity Resolution service. `HTTP Status Code: 500`
|
560
|
+
#
|
561
|
+
# @!attribute [rw] message
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/InternalServerException AWS API Documentation
|
565
|
+
#
|
566
|
+
class InternalServerException < Struct.new(
|
567
|
+
:message)
|
568
|
+
SENSITIVE = []
|
569
|
+
include Aws::Structure
|
570
|
+
end
|
571
|
+
|
572
|
+
# An object containing `InputRecords`, `TotalRecordsProcessed`,
|
573
|
+
# `MatchIDs`, and `RecordsNotProcessed`.
|
574
|
+
#
|
575
|
+
# @!attribute [rw] input_records
|
576
|
+
# The total number of input records.
|
577
|
+
# @return [Integer]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] match_i_ds
|
580
|
+
# The total number of `matchID`s generated.
|
581
|
+
# @return [Integer]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] records_not_processed
|
584
|
+
# The total number of records that did not get processed,
|
585
|
+
# @return [Integer]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] total_records_processed
|
588
|
+
# The total number of records processed.
|
589
|
+
# @return [Integer]
|
590
|
+
#
|
591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/JobMetrics AWS API Documentation
|
592
|
+
#
|
593
|
+
class JobMetrics < Struct.new(
|
594
|
+
:input_records,
|
595
|
+
:match_i_ds,
|
596
|
+
:records_not_processed,
|
597
|
+
:total_records_processed)
|
598
|
+
SENSITIVE = []
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# An object containing the `JobId`, `Status`, `StartTime`, and `EndTime`
|
603
|
+
# of a job.
|
604
|
+
#
|
605
|
+
# @!attribute [rw] end_time
|
606
|
+
# The time at which the job has finished.
|
607
|
+
# @return [Time]
|
608
|
+
#
|
609
|
+
# @!attribute [rw] job_id
|
610
|
+
# The ID of the job.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] start_time
|
614
|
+
# The time at which the job was started.
|
615
|
+
# @return [Time]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] status
|
618
|
+
# The current status of the job. Either `running`, `succeeded`,
|
619
|
+
# `queued`, or `failed`.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/JobSummary AWS API Documentation
|
623
|
+
#
|
624
|
+
class JobSummary < Struct.new(
|
625
|
+
:end_time,
|
626
|
+
:job_id,
|
627
|
+
:start_time,
|
628
|
+
:status)
|
629
|
+
SENSITIVE = []
|
630
|
+
include Aws::Structure
|
631
|
+
end
|
632
|
+
|
633
|
+
# @!attribute [rw] max_results
|
634
|
+
# The maximum number of objects returned per page.
|
635
|
+
# @return [Integer]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] next_token
|
638
|
+
# The pagination token from the previous `ListSchemaMappings` API
|
639
|
+
# call.
|
640
|
+
# @return [String]
|
641
|
+
#
|
642
|
+
# @!attribute [rw] workflow_name
|
643
|
+
# The name of the workflow to be retrieved.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingJobsInput AWS API Documentation
|
647
|
+
#
|
648
|
+
class ListMatchingJobsInput < Struct.new(
|
649
|
+
:max_results,
|
650
|
+
:next_token,
|
651
|
+
:workflow_name)
|
652
|
+
SENSITIVE = []
|
653
|
+
include Aws::Structure
|
654
|
+
end
|
655
|
+
|
656
|
+
# @!attribute [rw] jobs
|
657
|
+
# A list of JobSummary objects, each of which contain the ID, status,
|
658
|
+
# start time, and end time of a job.
|
659
|
+
# @return [Array<Types::JobSummary>]
|
660
|
+
#
|
661
|
+
# @!attribute [rw] next_token
|
662
|
+
# The pagination token from the previous `ListSchemaMappings` API
|
663
|
+
# call.
|
664
|
+
# @return [String]
|
665
|
+
#
|
666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingJobsOutput AWS API Documentation
|
667
|
+
#
|
668
|
+
class ListMatchingJobsOutput < Struct.new(
|
669
|
+
:jobs,
|
670
|
+
:next_token)
|
671
|
+
SENSITIVE = []
|
672
|
+
include Aws::Structure
|
673
|
+
end
|
674
|
+
|
675
|
+
# @!attribute [rw] max_results
|
676
|
+
# The maximum number of objects returned per page.
|
677
|
+
# @return [Integer]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] next_token
|
680
|
+
# The pagination token from the previous `ListSchemaMappings` API
|
681
|
+
# call.
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingWorkflowsInput AWS API Documentation
|
685
|
+
#
|
686
|
+
class ListMatchingWorkflowsInput < Struct.new(
|
687
|
+
:max_results,
|
688
|
+
:next_token)
|
689
|
+
SENSITIVE = []
|
690
|
+
include Aws::Structure
|
691
|
+
end
|
692
|
+
|
693
|
+
# @!attribute [rw] next_token
|
694
|
+
# The pagination token from the previous `ListSchemaMappings` API
|
695
|
+
# call.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] workflow_summaries
|
699
|
+
# A list of `MatchingWorkflowSummary` objects, each of which contain
|
700
|
+
# the fields `WorkflowName`, `WorkflowArn`, `CreatedAt`, and
|
701
|
+
# `UpdatedAt`.
|
702
|
+
# @return [Array<Types::MatchingWorkflowSummary>]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingWorkflowsOutput AWS API Documentation
|
705
|
+
#
|
706
|
+
class ListMatchingWorkflowsOutput < Struct.new(
|
707
|
+
:next_token,
|
708
|
+
:workflow_summaries)
|
709
|
+
SENSITIVE = []
|
710
|
+
include Aws::Structure
|
711
|
+
end
|
712
|
+
|
713
|
+
# @!attribute [rw] max_results
|
714
|
+
# The maximum number of objects returned per page.
|
715
|
+
# @return [Integer]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] next_token
|
718
|
+
# The pagination token from the previous `ListSchemaMappings` API
|
719
|
+
# call.
|
720
|
+
# @return [String]
|
721
|
+
#
|
722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListSchemaMappingsInput AWS API Documentation
|
723
|
+
#
|
724
|
+
class ListSchemaMappingsInput < Struct.new(
|
725
|
+
:max_results,
|
726
|
+
:next_token)
|
727
|
+
SENSITIVE = []
|
728
|
+
include Aws::Structure
|
729
|
+
end
|
730
|
+
|
731
|
+
# @!attribute [rw] next_token
|
732
|
+
# The pagination token from the previous `ListDomains` API call.
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @!attribute [rw] schema_list
|
736
|
+
# A list of `SchemaMappingSummary` objects, each of which contain the
|
737
|
+
# fields `SchemaName`, `SchemaArn`, `CreatedAt`, `UpdatedAt`.
|
738
|
+
# @return [Array<Types::SchemaMappingSummary>]
|
739
|
+
#
|
740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListSchemaMappingsOutput AWS API Documentation
|
741
|
+
#
|
742
|
+
class ListSchemaMappingsOutput < Struct.new(
|
743
|
+
:next_token,
|
744
|
+
:schema_list)
|
745
|
+
SENSITIVE = []
|
746
|
+
include Aws::Structure
|
747
|
+
end
|
748
|
+
|
749
|
+
# @!attribute [rw] resource_arn
|
750
|
+
# The ARN of the resource for which you want to view tags.
|
751
|
+
# @return [String]
|
752
|
+
#
|
753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListTagsForResourceInput AWS API Documentation
|
754
|
+
#
|
755
|
+
class ListTagsForResourceInput < Struct.new(
|
756
|
+
:resource_arn)
|
757
|
+
SENSITIVE = []
|
758
|
+
include Aws::Structure
|
759
|
+
end
|
760
|
+
|
761
|
+
# @!attribute [rw] tags
|
762
|
+
# The tags used to organize, track, or control access for this
|
763
|
+
# resource.
|
764
|
+
# @return [Hash<String,String>]
|
765
|
+
#
|
766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListTagsForResourceOutput AWS API Documentation
|
767
|
+
#
|
768
|
+
class ListTagsForResourceOutput < Struct.new(
|
769
|
+
:tags)
|
770
|
+
SENSITIVE = []
|
771
|
+
include Aws::Structure
|
772
|
+
end
|
773
|
+
|
774
|
+
# A list of `MatchingWorkflowSummary` objects, each of which contain the
|
775
|
+
# fields `WorkflowName`, `WorkflowArn`, `CreatedAt`, `UpdatedAt`.
|
776
|
+
#
|
777
|
+
# @!attribute [rw] created_at
|
778
|
+
# The timestamp of when the workflow was created.
|
779
|
+
# @return [Time]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] updated_at
|
782
|
+
# The timestamp of when the workflow was last updated.
|
783
|
+
# @return [Time]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] workflow_arn
|
786
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
787
|
+
# the `MatchingWorkflow`.
|
788
|
+
# @return [String]
|
789
|
+
#
|
790
|
+
# @!attribute [rw] workflow_name
|
791
|
+
# The name of the workflow.
|
792
|
+
# @return [String]
|
793
|
+
#
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/MatchingWorkflowSummary AWS API Documentation
|
795
|
+
#
|
796
|
+
class MatchingWorkflowSummary < Struct.new(
|
797
|
+
:created_at,
|
798
|
+
:updated_at,
|
799
|
+
:workflow_arn,
|
800
|
+
:workflow_name)
|
801
|
+
SENSITIVE = []
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
805
|
+
# A list of `OutputAttribute` objects, each of which have the fields
|
806
|
+
# Name and Hashed. Each of these objects selects a column to be included
|
807
|
+
# in the output table, and whether the values of the column should be
|
808
|
+
# hashed.
|
809
|
+
#
|
810
|
+
# @!attribute [rw] hashed
|
811
|
+
# Enables the ability to hash the column values in the output.
|
812
|
+
# @return [Boolean]
|
813
|
+
#
|
814
|
+
# @!attribute [rw] name
|
815
|
+
# A name of a column to be written to the output. This must be an
|
816
|
+
# `InputField` name in the schema mapping.
|
817
|
+
# @return [String]
|
818
|
+
#
|
819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/OutputAttribute AWS API Documentation
|
820
|
+
#
|
821
|
+
class OutputAttribute < Struct.new(
|
822
|
+
:hashed,
|
823
|
+
:name)
|
824
|
+
SENSITIVE = []
|
825
|
+
include Aws::Structure
|
826
|
+
end
|
827
|
+
|
828
|
+
# A list of `OutputAttribute` objects, each of which have the fields
|
829
|
+
# Name and Hashed. Each of these objects selects a column to be included
|
830
|
+
# in the output table, and whether the values of the column should be
|
831
|
+
# hashed.
|
832
|
+
#
|
833
|
+
# @!attribute [rw] kms_arn
|
834
|
+
# Customer KMS ARN for encryption at rest. If not provided, system
|
835
|
+
# will use an Entity Resolution managed KMS key.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] apply_normalization
|
839
|
+
# Normalizes the attributes defined in the schema in the input data.
|
840
|
+
# For example, if an attribute has an `AttributeType` of
|
841
|
+
# `PHONE_NUMBER`, and the data in the input table is in a format of
|
842
|
+
# 1234567890, Entity Resolution will normalize this field in the
|
843
|
+
# output to (123)-456-7890.
|
844
|
+
# @return [Boolean]
|
845
|
+
#
|
846
|
+
# @!attribute [rw] output
|
847
|
+
# A list of `OutputAttribute` objects, each of which have the fields
|
848
|
+
# Name and Hashed. Each of these objects selects a column to be
|
849
|
+
# included in the output table, and whether the values of the column
|
850
|
+
# should be hashed.
|
851
|
+
# @return [Array<Types::OutputAttribute>]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] output_s3_path
|
854
|
+
# The S3 path to which Entity Resolution will write the output table.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/OutputSource AWS API Documentation
|
858
|
+
#
|
859
|
+
class OutputSource < Struct.new(
|
860
|
+
:kms_arn,
|
861
|
+
:apply_normalization,
|
862
|
+
:output,
|
863
|
+
:output_s3_path)
|
864
|
+
SENSITIVE = []
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# An object which defines the `resolutionType` and the
|
869
|
+
# `ruleBasedProperties`
|
870
|
+
#
|
871
|
+
# @!attribute [rw] resolution_type
|
872
|
+
# There are two types of matching, `RULE_MATCHING` and `ML_MATCHING`
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] rule_based_properties
|
876
|
+
# An object which defines the list of matching rules to run and has a
|
877
|
+
# field `Rules`, which is a list of rule objects.
|
878
|
+
# @return [Types::RuleBasedProperties]
|
879
|
+
#
|
880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ResolutionTechniques AWS API Documentation
|
881
|
+
#
|
882
|
+
class ResolutionTechniques < Struct.new(
|
883
|
+
:resolution_type,
|
884
|
+
:rule_based_properties)
|
885
|
+
SENSITIVE = []
|
886
|
+
include Aws::Structure
|
887
|
+
end
|
888
|
+
|
889
|
+
# The resource could not be found. `HTTP Status Code: 404`
|
890
|
+
#
|
891
|
+
# @!attribute [rw] message
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ResourceNotFoundException AWS API Documentation
|
895
|
+
#
|
896
|
+
class ResourceNotFoundException < Struct.new(
|
897
|
+
:message)
|
898
|
+
SENSITIVE = []
|
899
|
+
include Aws::Structure
|
900
|
+
end
|
901
|
+
|
902
|
+
# An object containing `RuleName`, and `MatchingKeys`.
|
903
|
+
#
|
904
|
+
# @!attribute [rw] matching_keys
|
905
|
+
# A list of `MatchingKeys`. The `MatchingKeys` must have been defined
|
906
|
+
# in the `SchemaMapping`. Two records are considered to match
|
907
|
+
# according to this rule if all of the `MatchingKeys` match.
|
908
|
+
# @return [Array<String>]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] rule_name
|
911
|
+
# A name for the matching rule.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/Rule AWS API Documentation
|
915
|
+
#
|
916
|
+
class Rule < Struct.new(
|
917
|
+
:matching_keys,
|
918
|
+
:rule_name)
|
919
|
+
SENSITIVE = []
|
920
|
+
include Aws::Structure
|
921
|
+
end
|
922
|
+
|
923
|
+
# An object which defines the list of matching rules to run and has a
|
924
|
+
# field `Rules`, which is a list of rule objects.
|
925
|
+
#
|
926
|
+
# @!attribute [rw] attribute_matching_model
|
927
|
+
# You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the
|
928
|
+
# AttributeMatchingModel. When choosing `MANY_TO_MANY`, the system can
|
929
|
+
# match attribute across the sub-types of an attribute type. For
|
930
|
+
# example, if the value of the Email field of Profile A and the value
|
931
|
+
# of BusinessEmail field of Profile B matches, the two profiles are
|
932
|
+
# matched on the Email type. When choosing `ONE_TO_ONE` the system can
|
933
|
+
# only match if the sub-types are exact matches. For example, only
|
934
|
+
# when the value of the Email field of Profile A and the value of the
|
935
|
+
# Email field of Profile B matches, the two profiles are matched on
|
936
|
+
# the Email type.
|
937
|
+
# @return [String]
|
938
|
+
#
|
939
|
+
# @!attribute [rw] rules
|
940
|
+
# A list of Rule objects, each of which have fields `RuleName` and
|
941
|
+
# `MatchingKeys`.
|
942
|
+
# @return [Array<Types::Rule>]
|
943
|
+
#
|
944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/RuleBasedProperties AWS API Documentation
|
945
|
+
#
|
946
|
+
class RuleBasedProperties < Struct.new(
|
947
|
+
:attribute_matching_model,
|
948
|
+
:rules)
|
949
|
+
SENSITIVE = []
|
950
|
+
include Aws::Structure
|
951
|
+
end
|
952
|
+
|
953
|
+
# An object containing `FieldField`, `Type`, `GroupName`, and
|
954
|
+
# `MatchKey`.
|
955
|
+
#
|
956
|
+
# @!attribute [rw] field_name
|
957
|
+
# A string containing the field name.
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] group_name
|
961
|
+
# Instruct Entity Resolution to combine several columns into a unified
|
962
|
+
# column with the identical attribute type. For example, when working
|
963
|
+
# with columns such as first\_name, middle\_name, and last\_name,
|
964
|
+
# assigning them a common `GroupName` will prompt Entity Resolution to
|
965
|
+
# concatenate them into a single value.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] match_key
|
969
|
+
# A key that allows grouping of multiple input attributes into a
|
970
|
+
# unified matching group. For example, let's consider a scenario
|
971
|
+
# where the source table contains various addresses, such as
|
972
|
+
# business\_address and shipping\_address. By assigning the `MatchKey`
|
973
|
+
# *Address*' to both attributes, Entity Resolution will match records
|
974
|
+
# across these fields to create a consolidated matching group. If no
|
975
|
+
# `MatchKey` is specified for a column, it won't be utilized for
|
976
|
+
# matching purposes but will still be included in the output table.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] type
|
980
|
+
# The type of the attribute, selected from a list of values.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/SchemaInputAttribute AWS API Documentation
|
984
|
+
#
|
985
|
+
class SchemaInputAttribute < Struct.new(
|
986
|
+
:field_name,
|
987
|
+
:group_name,
|
988
|
+
:match_key,
|
989
|
+
:type)
|
990
|
+
SENSITIVE = []
|
991
|
+
include Aws::Structure
|
992
|
+
end
|
993
|
+
|
994
|
+
# An object containing `SchemaName`, `SchemaArn`, `CreatedAt`,
|
995
|
+
# and`UpdatedAt`.
|
996
|
+
#
|
997
|
+
# @!attribute [rw] created_at
|
998
|
+
# The timestamp of when the `SchemaMapping` was created.
|
999
|
+
# @return [Time]
|
1000
|
+
#
|
1001
|
+
# @!attribute [rw] schema_arn
|
1002
|
+
# The ARN (Amazon Resource Name) that Entity Resolution generated for
|
1003
|
+
# the `SchemaMapping`.
|
1004
|
+
# @return [String]
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] schema_name
|
1007
|
+
# The name of the schema.
|
1008
|
+
# @return [String]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] updated_at
|
1011
|
+
# The timestamp of when the `SchemaMapping` was last updated.
|
1012
|
+
# @return [Time]
|
1013
|
+
#
|
1014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/SchemaMappingSummary AWS API Documentation
|
1015
|
+
#
|
1016
|
+
class SchemaMappingSummary < Struct.new(
|
1017
|
+
:created_at,
|
1018
|
+
:schema_arn,
|
1019
|
+
:schema_name,
|
1020
|
+
:updated_at)
|
1021
|
+
SENSITIVE = []
|
1022
|
+
include Aws::Structure
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# @!attribute [rw] workflow_name
|
1026
|
+
# The name of the matching job to be retrieved.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartMatchingJobInput AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class StartMatchingJobInput < Struct.new(
|
1032
|
+
:workflow_name)
|
1033
|
+
SENSITIVE = []
|
1034
|
+
include Aws::Structure
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# @!attribute [rw] job_id
|
1038
|
+
# The ID of the job.
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/StartMatchingJobOutput AWS API Documentation
|
1042
|
+
#
|
1043
|
+
class StartMatchingJobOutput < Struct.new(
|
1044
|
+
:job_id)
|
1045
|
+
SENSITIVE = []
|
1046
|
+
include Aws::Structure
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
# @!attribute [rw] resource_arn
|
1050
|
+
# The ARN of the resource for which you want to view tags.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] tags
|
1054
|
+
# The tags used to organize, track, or control access for this
|
1055
|
+
# resource.
|
1056
|
+
# @return [Hash<String,String>]
|
1057
|
+
#
|
1058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/TagResourceInput AWS API Documentation
|
1059
|
+
#
|
1060
|
+
class TagResourceInput < Struct.new(
|
1061
|
+
:resource_arn,
|
1062
|
+
:tags)
|
1063
|
+
SENSITIVE = []
|
1064
|
+
include Aws::Structure
|
1065
|
+
end
|
1066
|
+
|
1067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/TagResourceOutput AWS API Documentation
|
1068
|
+
#
|
1069
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
1070
|
+
|
1071
|
+
# The request was denied due to request throttling. `HTTP Status Code:
|
1072
|
+
# 429`
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] message
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ThrottlingException AWS API Documentation
|
1078
|
+
#
|
1079
|
+
class ThrottlingException < Struct.new(
|
1080
|
+
:message)
|
1081
|
+
SENSITIVE = []
|
1082
|
+
include Aws::Structure
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# @!attribute [rw] resource_arn
|
1086
|
+
# The ARN of the resource for which you want to untag.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] tag_keys
|
1090
|
+
# The list of tag keys to remove from the resource.
|
1091
|
+
# @return [Array<String>]
|
1092
|
+
#
|
1093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UntagResourceInput AWS API Documentation
|
1094
|
+
#
|
1095
|
+
class UntagResourceInput < Struct.new(
|
1096
|
+
:resource_arn,
|
1097
|
+
:tag_keys)
|
1098
|
+
SENSITIVE = []
|
1099
|
+
include Aws::Structure
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UntagResourceOutput AWS API Documentation
|
1103
|
+
#
|
1104
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
1105
|
+
|
1106
|
+
# @!attribute [rw] description
|
1107
|
+
# A description of the workflow.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] incremental_run_config
|
1111
|
+
# An object which defines an incremental run type and has only
|
1112
|
+
# `incrementalRunType` as a field.
|
1113
|
+
# @return [Types::IncrementalRunConfig]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] input_source_config
|
1116
|
+
# A list of `InputSource` objects, which have the fields
|
1117
|
+
# `InputSourceARN` and `SchemaName`.
|
1118
|
+
# @return [Array<Types::InputSource>]
|
1119
|
+
#
|
1120
|
+
# @!attribute [rw] output_source_config
|
1121
|
+
# A list of `OutputSource` objects, each of which contains fields
|
1122
|
+
# `OutputS3Path`, `ApplyNormalization`, and `Output`.
|
1123
|
+
# @return [Array<Types::OutputSource>]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] resolution_techniques
|
1126
|
+
# An object which defines the `resolutionType` and the
|
1127
|
+
# `ruleBasedProperties`
|
1128
|
+
# @return [Types::ResolutionTechniques]
|
1129
|
+
#
|
1130
|
+
# @!attribute [rw] role_arn
|
1131
|
+
# The Amazon Resource Name (ARN) of the IAM role. AWS Entity
|
1132
|
+
# Resolution assumes this role to create resources on your behalf as
|
1133
|
+
# part of workflow execution.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] workflow_name
|
1137
|
+
# The name of the workflow to be retrieved.
|
1138
|
+
# @return [String]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateMatchingWorkflowInput AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class UpdateMatchingWorkflowInput < Struct.new(
|
1143
|
+
:description,
|
1144
|
+
:incremental_run_config,
|
1145
|
+
:input_source_config,
|
1146
|
+
:output_source_config,
|
1147
|
+
:resolution_techniques,
|
1148
|
+
:role_arn,
|
1149
|
+
:workflow_name)
|
1150
|
+
SENSITIVE = []
|
1151
|
+
include Aws::Structure
|
1152
|
+
end
|
1153
|
+
|
1154
|
+
# @!attribute [rw] description
|
1155
|
+
# A description of the workflow.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] incremental_run_config
|
1159
|
+
# An object which defines an incremental run type and has only
|
1160
|
+
# `incrementalRunType` as a field.
|
1161
|
+
# @return [Types::IncrementalRunConfig]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] input_source_config
|
1164
|
+
# A list of `InputSource` objects, which have the fields
|
1165
|
+
# `InputSourceARN` and `SchemaName`.
|
1166
|
+
# @return [Array<Types::InputSource>]
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] output_source_config
|
1169
|
+
# A list of `OutputSource` objects, each of which contains fields
|
1170
|
+
# `OutputS3Path`, `ApplyNormalization`, and `Output`.
|
1171
|
+
# @return [Array<Types::OutputSource>]
|
1172
|
+
#
|
1173
|
+
# @!attribute [rw] resolution_techniques
|
1174
|
+
# An object which defines the `resolutionType` and the
|
1175
|
+
# `ruleBasedProperties`
|
1176
|
+
# @return [Types::ResolutionTechniques]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] role_arn
|
1179
|
+
# The Amazon Resource Name (ARN) of the IAM role. AWS Entity
|
1180
|
+
# Resolution assumes this role to create resources on your behalf as
|
1181
|
+
# part of workflow execution.
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] workflow_name
|
1185
|
+
# The name of the workflow.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/UpdateMatchingWorkflowOutput AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class UpdateMatchingWorkflowOutput < Struct.new(
|
1191
|
+
:description,
|
1192
|
+
:incremental_run_config,
|
1193
|
+
:input_source_config,
|
1194
|
+
:output_source_config,
|
1195
|
+
:resolution_techniques,
|
1196
|
+
:role_arn,
|
1197
|
+
:workflow_name)
|
1198
|
+
SENSITIVE = []
|
1199
|
+
include Aws::Structure
|
1200
|
+
end
|
1201
|
+
|
1202
|
+
# The input fails to satisfy the constraints specified by AWS Entity
|
1203
|
+
# Resolution. `HTTP Status Code: 400`
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] message
|
1206
|
+
# @return [String]
|
1207
|
+
#
|
1208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ValidationException AWS API Documentation
|
1209
|
+
#
|
1210
|
+
class ValidationException < Struct.new(
|
1211
|
+
:message)
|
1212
|
+
SENSITIVE = []
|
1213
|
+
include Aws::Structure
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
end
|
1217
|
+
end
|