aws-sdk 2.1421.0 → 2.1423.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.
Files changed (56) hide show
  1. package/CHANGELOG.md +22 -1
  2. package/README.md +1 -1
  3. package/apis/billingconductor-2021-07-30.min.json +96 -68
  4. package/apis/customer-profiles-2020-08-15.min.json +253 -57
  5. package/apis/datasync-2018-11-09.min.json +198 -102
  6. package/apis/ec2-2016-11-15.min.json +300 -278
  7. package/apis/emr-serverless-2021-07-13.min.json +25 -3
  8. package/apis/entityresolution-2018-05-10.examples.json +5 -0
  9. package/apis/entityresolution-2018-05-10.min.json +823 -0
  10. package/apis/entityresolution-2018-05-10.paginators.json +22 -0
  11. package/apis/glue-2017-03-31.min.json +390 -318
  12. package/apis/managedblockchain-query-2023-05-04.examples.json +5 -0
  13. package/apis/managedblockchain-query-2023-05-04.min.json +438 -0
  14. package/apis/managedblockchain-query-2023-05-04.paginators.json +22 -0
  15. package/apis/managedblockchain-query-2023-05-04.waiters2.json +5 -0
  16. package/apis/metadata.json +7 -0
  17. package/apis/rds-2014-10-31.min.json +2 -1
  18. package/apis/sagemaker-2017-07-24.min.json +4 -0
  19. package/apis/securityhub-2018-10-26.min.json +145 -108
  20. package/apis/sts-2011-06-15.min.json +21 -11
  21. package/apis/transfer-2018-11-05.min.json +117 -73
  22. package/apis/wisdom-2020-10-19.min.json +77 -59
  23. package/clients/all.d.ts +2 -0
  24. package/clients/all.js +3 -1
  25. package/clients/billingconductor.d.ts +102 -69
  26. package/clients/cloudcontrol.d.ts +1 -1
  27. package/clients/customerprofiles.d.ts +204 -4
  28. package/clients/datasync.d.ts +171 -27
  29. package/clients/dynamodb.d.ts +4 -4
  30. package/clients/ec2.d.ts +26 -0
  31. package/clients/emrserverless.d.ts +33 -2
  32. package/clients/entityresolution.d.ts +815 -0
  33. package/clients/entityresolution.js +18 -0
  34. package/clients/glue.d.ts +123 -1
  35. package/clients/healthlake.d.ts +70 -70
  36. package/clients/lambda.d.ts +1 -1
  37. package/clients/managedblockchainquery.d.ts +494 -0
  38. package/clients/managedblockchainquery.js +19 -0
  39. package/clients/mediaconvert.d.ts +421 -414
  40. package/clients/opensearchserverless.d.ts +1 -1
  41. package/clients/polly.d.ts +2 -2
  42. package/clients/rds.d.ts +14 -10
  43. package/clients/route53.d.ts +13 -13
  44. package/clients/sagemaker.d.ts +4 -4
  45. package/clients/securityhub.d.ts +69 -10
  46. package/clients/sts.d.ts +17 -1
  47. package/clients/transfer.d.ts +85 -19
  48. package/clients/wisdom.d.ts +24 -0
  49. package/dist/aws-sdk-core-react-native.js +2 -2
  50. package/dist/aws-sdk-react-native.js +97 -16
  51. package/dist/aws-sdk.js +333 -293
  52. package/dist/aws-sdk.min.js +67 -67
  53. package/lib/config_service_placeholders.d.ts +4 -0
  54. package/lib/core.js +1 -1
  55. package/lib/dynamodb/document_client.d.ts +2 -2
  56. package/package.json +1 -1
@@ -0,0 +1,815 @@
1
+ import {Request} from '../lib/request';
2
+ import {Response} from '../lib/response';
3
+ import {AWSError} from '../lib/error';
4
+ import {Service} from '../lib/service';
5
+ import {ServiceConfigurationOptions} from '../lib/service';
6
+ import {ConfigBase as Config} from '../lib/config-base';
7
+ interface Blob {}
8
+ declare class EntityResolution extends Service {
9
+ /**
10
+ * Constructs a service object. This object has one method for each API operation.
11
+ */
12
+ constructor(options?: EntityResolution.Types.ClientConfiguration)
13
+ config: Config & EntityResolution.Types.ClientConfiguration;
14
+ /**
15
+ * Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
16
+ */
17
+ createMatchingWorkflow(params: EntityResolution.Types.CreateMatchingWorkflowInput, callback?: (err: AWSError, data: EntityResolution.Types.CreateMatchingWorkflowOutput) => void): Request<EntityResolution.Types.CreateMatchingWorkflowOutput, AWSError>;
18
+ /**
19
+ * Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
20
+ */
21
+ createMatchingWorkflow(callback?: (err: AWSError, data: EntityResolution.Types.CreateMatchingWorkflowOutput) => void): Request<EntityResolution.Types.CreateMatchingWorkflowOutput, AWSError>;
22
+ /**
23
+ * Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
24
+ */
25
+ createSchemaMapping(params: EntityResolution.Types.CreateSchemaMappingInput, callback?: (err: AWSError, data: EntityResolution.Types.CreateSchemaMappingOutput) => void): Request<EntityResolution.Types.CreateSchemaMappingOutput, AWSError>;
26
+ /**
27
+ * Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
28
+ */
29
+ createSchemaMapping(callback?: (err: AWSError, data: EntityResolution.Types.CreateSchemaMappingOutput) => void): Request<EntityResolution.Types.CreateSchemaMappingOutput, AWSError>;
30
+ /**
31
+ * Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
32
+ */
33
+ deleteMatchingWorkflow(params: EntityResolution.Types.DeleteMatchingWorkflowInput, callback?: (err: AWSError, data: EntityResolution.Types.DeleteMatchingWorkflowOutput) => void): Request<EntityResolution.Types.DeleteMatchingWorkflowOutput, AWSError>;
34
+ /**
35
+ * Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
36
+ */
37
+ deleteMatchingWorkflow(callback?: (err: AWSError, data: EntityResolution.Types.DeleteMatchingWorkflowOutput) => void): Request<EntityResolution.Types.DeleteMatchingWorkflowOutput, AWSError>;
38
+ /**
39
+ * Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.
40
+ */
41
+ deleteSchemaMapping(params: EntityResolution.Types.DeleteSchemaMappingInput, callback?: (err: AWSError, data: EntityResolution.Types.DeleteSchemaMappingOutput) => void): Request<EntityResolution.Types.DeleteSchemaMappingOutput, AWSError>;
42
+ /**
43
+ * Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.
44
+ */
45
+ deleteSchemaMapping(callback?: (err: AWSError, data: EntityResolution.Types.DeleteSchemaMappingOutput) => void): Request<EntityResolution.Types.DeleteSchemaMappingOutput, AWSError>;
46
+ /**
47
+ * Returns the corresponding Match ID of a customer record if the record has been processed.
48
+ */
49
+ getMatchId(params: EntityResolution.Types.GetMatchIdInput, callback?: (err: AWSError, data: EntityResolution.Types.GetMatchIdOutput) => void): Request<EntityResolution.Types.GetMatchIdOutput, AWSError>;
50
+ /**
51
+ * Returns the corresponding Match ID of a customer record if the record has been processed.
52
+ */
53
+ getMatchId(callback?: (err: AWSError, data: EntityResolution.Types.GetMatchIdOutput) => void): Request<EntityResolution.Types.GetMatchIdOutput, AWSError>;
54
+ /**
55
+ * Gets the status, metrics, and errors (if there are any) that are associated with a job.
56
+ */
57
+ getMatchingJob(params: EntityResolution.Types.GetMatchingJobInput, callback?: (err: AWSError, data: EntityResolution.Types.GetMatchingJobOutput) => void): Request<EntityResolution.Types.GetMatchingJobOutput, AWSError>;
58
+ /**
59
+ * Gets the status, metrics, and errors (if there are any) that are associated with a job.
60
+ */
61
+ getMatchingJob(callback?: (err: AWSError, data: EntityResolution.Types.GetMatchingJobOutput) => void): Request<EntityResolution.Types.GetMatchingJobOutput, AWSError>;
62
+ /**
63
+ * Returns the MatchingWorkflow with a given name, if it exists.
64
+ */
65
+ getMatchingWorkflow(params: EntityResolution.Types.GetMatchingWorkflowInput, callback?: (err: AWSError, data: EntityResolution.Types.GetMatchingWorkflowOutput) => void): Request<EntityResolution.Types.GetMatchingWorkflowOutput, AWSError>;
66
+ /**
67
+ * Returns the MatchingWorkflow with a given name, if it exists.
68
+ */
69
+ getMatchingWorkflow(callback?: (err: AWSError, data: EntityResolution.Types.GetMatchingWorkflowOutput) => void): Request<EntityResolution.Types.GetMatchingWorkflowOutput, AWSError>;
70
+ /**
71
+ * Returns the SchemaMapping of a given name.
72
+ */
73
+ getSchemaMapping(params: EntityResolution.Types.GetSchemaMappingInput, callback?: (err: AWSError, data: EntityResolution.Types.GetSchemaMappingOutput) => void): Request<EntityResolution.Types.GetSchemaMappingOutput, AWSError>;
74
+ /**
75
+ * Returns the SchemaMapping of a given name.
76
+ */
77
+ getSchemaMapping(callback?: (err: AWSError, data: EntityResolution.Types.GetSchemaMappingOutput) => void): Request<EntityResolution.Types.GetSchemaMappingOutput, AWSError>;
78
+ /**
79
+ * Lists all jobs for a given workflow.
80
+ */
81
+ listMatchingJobs(params: EntityResolution.Types.ListMatchingJobsInput, callback?: (err: AWSError, data: EntityResolution.Types.ListMatchingJobsOutput) => void): Request<EntityResolution.Types.ListMatchingJobsOutput, AWSError>;
82
+ /**
83
+ * Lists all jobs for a given workflow.
84
+ */
85
+ listMatchingJobs(callback?: (err: AWSError, data: EntityResolution.Types.ListMatchingJobsOutput) => void): Request<EntityResolution.Types.ListMatchingJobsOutput, AWSError>;
86
+ /**
87
+ * Returns a list of all the MatchingWorkflows that have been created for an AWS account.
88
+ */
89
+ listMatchingWorkflows(params: EntityResolution.Types.ListMatchingWorkflowsInput, callback?: (err: AWSError, data: EntityResolution.Types.ListMatchingWorkflowsOutput) => void): Request<EntityResolution.Types.ListMatchingWorkflowsOutput, AWSError>;
90
+ /**
91
+ * Returns a list of all the MatchingWorkflows that have been created for an AWS account.
92
+ */
93
+ listMatchingWorkflows(callback?: (err: AWSError, data: EntityResolution.Types.ListMatchingWorkflowsOutput) => void): Request<EntityResolution.Types.ListMatchingWorkflowsOutput, AWSError>;
94
+ /**
95
+ * Returns a list of all the SchemaMappings that have been created for an AWS account.
96
+ */
97
+ listSchemaMappings(params: EntityResolution.Types.ListSchemaMappingsInput, callback?: (err: AWSError, data: EntityResolution.Types.ListSchemaMappingsOutput) => void): Request<EntityResolution.Types.ListSchemaMappingsOutput, AWSError>;
98
+ /**
99
+ * Returns a list of all the SchemaMappings that have been created for an AWS account.
100
+ */
101
+ listSchemaMappings(callback?: (err: AWSError, data: EntityResolution.Types.ListSchemaMappingsOutput) => void): Request<EntityResolution.Types.ListSchemaMappingsOutput, AWSError>;
102
+ /**
103
+ * Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
104
+ */
105
+ listTagsForResource(params: EntityResolution.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: EntityResolution.Types.ListTagsForResourceOutput) => void): Request<EntityResolution.Types.ListTagsForResourceOutput, AWSError>;
106
+ /**
107
+ * Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
108
+ */
109
+ listTagsForResource(callback?: (err: AWSError, data: EntityResolution.Types.ListTagsForResourceOutput) => void): Request<EntityResolution.Types.ListTagsForResourceOutput, AWSError>;
110
+ /**
111
+ * Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
112
+ */
113
+ startMatchingJob(params: EntityResolution.Types.StartMatchingJobInput, callback?: (err: AWSError, data: EntityResolution.Types.StartMatchingJobOutput) => void): Request<EntityResolution.Types.StartMatchingJobOutput, AWSError>;
114
+ /**
115
+ * Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
116
+ */
117
+ startMatchingJob(callback?: (err: AWSError, data: EntityResolution.Types.StartMatchingJobOutput) => void): Request<EntityResolution.Types.StartMatchingJobOutput, AWSError>;
118
+ /**
119
+ * Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
120
+ */
121
+ tagResource(params: EntityResolution.Types.TagResourceInput, callback?: (err: AWSError, data: EntityResolution.Types.TagResourceOutput) => void): Request<EntityResolution.Types.TagResourceOutput, AWSError>;
122
+ /**
123
+ * Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
124
+ */
125
+ tagResource(callback?: (err: AWSError, data: EntityResolution.Types.TagResourceOutput) => void): Request<EntityResolution.Types.TagResourceOutput, AWSError>;
126
+ /**
127
+ * Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
128
+ */
129
+ untagResource(params: EntityResolution.Types.UntagResourceInput, callback?: (err: AWSError, data: EntityResolution.Types.UntagResourceOutput) => void): Request<EntityResolution.Types.UntagResourceOutput, AWSError>;
130
+ /**
131
+ * Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
132
+ */
133
+ untagResource(callback?: (err: AWSError, data: EntityResolution.Types.UntagResourceOutput) => void): Request<EntityResolution.Types.UntagResourceOutput, AWSError>;
134
+ /**
135
+ * Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.
136
+ */
137
+ updateMatchingWorkflow(params: EntityResolution.Types.UpdateMatchingWorkflowInput, callback?: (err: AWSError, data: EntityResolution.Types.UpdateMatchingWorkflowOutput) => void): Request<EntityResolution.Types.UpdateMatchingWorkflowOutput, AWSError>;
138
+ /**
139
+ * Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.
140
+ */
141
+ updateMatchingWorkflow(callback?: (err: AWSError, data: EntityResolution.Types.UpdateMatchingWorkflowOutput) => void): Request<EntityResolution.Types.UpdateMatchingWorkflowOutput, AWSError>;
142
+ }
143
+ declare namespace EntityResolution {
144
+ export type AttributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY"|string;
145
+ export type AttributeName = string;
146
+ export type Boolean = boolean;
147
+ export interface CreateMatchingWorkflowInput {
148
+ /**
149
+ * A description of the workflow.
150
+ */
151
+ description?: Description;
152
+ /**
153
+ * An object which defines an incremental run type and has only incrementalRunType as a field.
154
+ */
155
+ incrementalRunConfig?: IncrementalRunConfig;
156
+ /**
157
+ * A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
158
+ */
159
+ inputSourceConfig: InputSourceConfig;
160
+ /**
161
+ * A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
162
+ */
163
+ outputSourceConfig: OutputSourceConfig;
164
+ /**
165
+ * An object which defines the resolutionType and the ruleBasedProperties
166
+ */
167
+ resolutionTechniques: ResolutionTechniques;
168
+ /**
169
+ * The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
170
+ */
171
+ roleArn: String;
172
+ /**
173
+ * The tags used to organize, track, or control access for this resource.
174
+ */
175
+ tags?: TagMap;
176
+ /**
177
+ * The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name.
178
+ */
179
+ workflowName: EntityName;
180
+ }
181
+ export interface CreateMatchingWorkflowOutput {
182
+ /**
183
+ * A description of the workflow.
184
+ */
185
+ description?: Description;
186
+ /**
187
+ * An object which defines an incremental run type and has only incrementalRunType as a field.
188
+ */
189
+ incrementalRunConfig?: IncrementalRunConfig;
190
+ /**
191
+ * A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
192
+ */
193
+ inputSourceConfig: InputSourceConfig;
194
+ /**
195
+ * A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
196
+ */
197
+ outputSourceConfig: OutputSourceConfig;
198
+ /**
199
+ * An object which defines the resolutionType and the ruleBasedProperties
200
+ */
201
+ resolutionTechniques: ResolutionTechniques;
202
+ /**
203
+ * The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
204
+ */
205
+ roleArn: String;
206
+ /**
207
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
208
+ */
209
+ workflowArn: MatchingWorkflowArn;
210
+ /**
211
+ * The name of the workflow.
212
+ */
213
+ workflowName: EntityName;
214
+ }
215
+ export interface CreateSchemaMappingInput {
216
+ /**
217
+ * A description of the schema.
218
+ */
219
+ description?: Description;
220
+ /**
221
+ * A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
222
+ */
223
+ mappedInputFields?: SchemaInputAttributes;
224
+ /**
225
+ * The name of the schema. There cannot be multiple SchemaMappings with the same name.
226
+ */
227
+ schemaName: EntityName;
228
+ /**
229
+ * The tags used to organize, track, or control access for this resource.
230
+ */
231
+ tags?: TagMap;
232
+ }
233
+ export interface CreateSchemaMappingOutput {
234
+ /**
235
+ * A description of the schema.
236
+ */
237
+ description: Description;
238
+ /**
239
+ * A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
240
+ */
241
+ mappedInputFields: SchemaInputAttributes;
242
+ /**
243
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
244
+ */
245
+ schemaArn: SchemaMappingArn;
246
+ /**
247
+ * The name of the schema.
248
+ */
249
+ schemaName: EntityName;
250
+ }
251
+ export interface DeleteMatchingWorkflowInput {
252
+ /**
253
+ * The name of the workflow to be retrieved.
254
+ */
255
+ workflowName: EntityName;
256
+ }
257
+ export interface DeleteMatchingWorkflowOutput {
258
+ /**
259
+ * A successful operation message.
260
+ */
261
+ message: String;
262
+ }
263
+ export interface DeleteSchemaMappingInput {
264
+ /**
265
+ * The name of the schema to delete.
266
+ */
267
+ schemaName: EntityName;
268
+ }
269
+ export interface DeleteSchemaMappingOutput {
270
+ /**
271
+ * A successful operation message.
272
+ */
273
+ message: String;
274
+ }
275
+ export type Description = string;
276
+ export type EntityName = string;
277
+ export interface ErrorDetails {
278
+ /**
279
+ * The error message from the job, if there is one.
280
+ */
281
+ errorMessage?: ErrorMessage;
282
+ }
283
+ export type ErrorMessage = string;
284
+ export interface GetMatchIdInput {
285
+ /**
286
+ * The record to fetch the Match ID for.
287
+ */
288
+ record: RecordAttributeMap;
289
+ /**
290
+ * The name of the workflow.
291
+ */
292
+ workflowName: EntityName;
293
+ }
294
+ export interface GetMatchIdOutput {
295
+ /**
296
+ * The unique identifiers for this group of match records.
297
+ */
298
+ matchId?: String;
299
+ }
300
+ export interface GetMatchingJobInput {
301
+ /**
302
+ * The ID of the job.
303
+ */
304
+ jobId: JobId;
305
+ /**
306
+ * The name of the workflow.
307
+ */
308
+ workflowName: EntityName;
309
+ }
310
+ export interface GetMatchingJobOutput {
311
+ /**
312
+ * The time at which the job has finished.
313
+ */
314
+ endTime?: Timestamp;
315
+ /**
316
+ * An object containing an error message, if there was an error.
317
+ */
318
+ errorDetails?: ErrorDetails;
319
+ /**
320
+ * The ID of the job.
321
+ */
322
+ jobId: JobId;
323
+ /**
324
+ * Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
325
+ */
326
+ metrics?: JobMetrics;
327
+ /**
328
+ * The time at which the job was started.
329
+ */
330
+ startTime: Timestamp;
331
+ /**
332
+ * The current status of the job. Either running, succeeded, queued, or failed.
333
+ */
334
+ status: JobStatus;
335
+ }
336
+ export interface GetMatchingWorkflowInput {
337
+ /**
338
+ * The name of the workflow.
339
+ */
340
+ workflowName: EntityName;
341
+ }
342
+ export interface GetMatchingWorkflowOutput {
343
+ /**
344
+ * The timestamp of when the workflow was created.
345
+ */
346
+ createdAt: Timestamp;
347
+ /**
348
+ * A description of the workflow.
349
+ */
350
+ description?: Description;
351
+ /**
352
+ * An object which defines an incremental run type and has only incrementalRunType as a field.
353
+ */
354
+ incrementalRunConfig?: IncrementalRunConfig;
355
+ /**
356
+ * A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
357
+ */
358
+ inputSourceConfig: InputSourceConfig;
359
+ /**
360
+ * A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
361
+ */
362
+ outputSourceConfig: OutputSourceConfig;
363
+ /**
364
+ * An object which defines the resolutionType and the ruleBasedProperties
365
+ */
366
+ resolutionTechniques: ResolutionTechniques;
367
+ /**
368
+ * The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access resources on your behalf.
369
+ */
370
+ roleArn: String;
371
+ /**
372
+ * The tags used to organize, track, or control access for this resource.
373
+ */
374
+ tags?: TagMap;
375
+ /**
376
+ * The timestamp of when the workflow was last updated.
377
+ */
378
+ updatedAt: Timestamp;
379
+ /**
380
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
381
+ */
382
+ workflowArn: MatchingWorkflowArn;
383
+ /**
384
+ * The name of the workflow.
385
+ */
386
+ workflowName: EntityName;
387
+ }
388
+ export interface GetSchemaMappingInput {
389
+ /**
390
+ * The name of the schema to be retrieved.
391
+ */
392
+ schemaName: EntityName;
393
+ }
394
+ export interface GetSchemaMappingOutput {
395
+ /**
396
+ * The timestamp of when the SchemaMapping was created.
397
+ */
398
+ createdAt: Timestamp;
399
+ /**
400
+ * A description of the schema.
401
+ */
402
+ description?: Description;
403
+ /**
404
+ * A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.
405
+ */
406
+ mappedInputFields: SchemaInputAttributes;
407
+ /**
408
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
409
+ */
410
+ schemaArn: SchemaMappingArn;
411
+ /**
412
+ * The name of the schema.
413
+ */
414
+ schemaName: EntityName;
415
+ /**
416
+ * The tags used to organize, track, or control access for this resource.
417
+ */
418
+ tags?: TagMap;
419
+ /**
420
+ * The timestamp of when the SchemaMapping was last updated.
421
+ */
422
+ updatedAt: Timestamp;
423
+ }
424
+ export interface IncrementalRunConfig {
425
+ /**
426
+ * The type of incremental run. It takes only one value: IMMEDIATE.
427
+ */
428
+ incrementalRunType?: IncrementalRunType;
429
+ }
430
+ export type IncrementalRunType = "IMMEDIATE"|string;
431
+ export interface InputSource {
432
+ /**
433
+ * Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, 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.
434
+ */
435
+ applyNormalization?: Boolean;
436
+ /**
437
+ * An Glue table ARN for the input source table.
438
+ */
439
+ inputSourceARN: InputSourceInputSourceARNString;
440
+ /**
441
+ * The name of the schema to be retrieved.
442
+ */
443
+ schemaName: EntityName;
444
+ }
445
+ export type InputSourceConfig = InputSource[];
446
+ export type InputSourceInputSourceARNString = string;
447
+ export type Integer = number;
448
+ export type JobId = string;
449
+ export type JobList = JobSummary[];
450
+ export interface JobMetrics {
451
+ /**
452
+ * The total number of input records.
453
+ */
454
+ inputRecords?: Integer;
455
+ /**
456
+ * The total number of matchIDs generated.
457
+ */
458
+ matchIDs?: Integer;
459
+ /**
460
+ * The total number of records that did not get processed,
461
+ */
462
+ recordsNotProcessed?: Integer;
463
+ /**
464
+ * The total number of records processed.
465
+ */
466
+ totalRecordsProcessed?: Integer;
467
+ }
468
+ export type JobStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"QUEUED"|string;
469
+ export interface JobSummary {
470
+ /**
471
+ * The time at which the job has finished.
472
+ */
473
+ endTime?: Timestamp;
474
+ /**
475
+ * The ID of the job.
476
+ */
477
+ jobId: JobId;
478
+ /**
479
+ * The time at which the job was started.
480
+ */
481
+ startTime: Timestamp;
482
+ /**
483
+ * The current status of the job. Either running, succeeded, queued, or failed.
484
+ */
485
+ status: JobStatus;
486
+ }
487
+ export type KMSArn = string;
488
+ export interface ListMatchingJobsInput {
489
+ /**
490
+ * The maximum number of objects returned per page.
491
+ */
492
+ maxResults?: ListMatchingJobsInputMaxResultsInteger;
493
+ /**
494
+ * The pagination token from the previous ListSchemaMappings API call.
495
+ */
496
+ nextToken?: NextToken;
497
+ /**
498
+ * The name of the workflow to be retrieved.
499
+ */
500
+ workflowName: EntityName;
501
+ }
502
+ export type ListMatchingJobsInputMaxResultsInteger = number;
503
+ export interface ListMatchingJobsOutput {
504
+ /**
505
+ * A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
506
+ */
507
+ jobs?: JobList;
508
+ /**
509
+ * The pagination token from the previous ListSchemaMappings API call.
510
+ */
511
+ nextToken?: NextToken;
512
+ }
513
+ export interface ListMatchingWorkflowsInput {
514
+ /**
515
+ * The maximum number of objects returned per page.
516
+ */
517
+ maxResults?: ListMatchingWorkflowsInputMaxResultsInteger;
518
+ /**
519
+ * The pagination token from the previous ListSchemaMappings API call.
520
+ */
521
+ nextToken?: NextToken;
522
+ }
523
+ export type ListMatchingWorkflowsInputMaxResultsInteger = number;
524
+ export interface ListMatchingWorkflowsOutput {
525
+ /**
526
+ * The pagination token from the previous ListSchemaMappings API call.
527
+ */
528
+ nextToken?: NextToken;
529
+ /**
530
+ * A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
531
+ */
532
+ workflowSummaries?: MatchingWorkflowList;
533
+ }
534
+ export interface ListSchemaMappingsInput {
535
+ /**
536
+ * The maximum number of objects returned per page.
537
+ */
538
+ maxResults?: ListSchemaMappingsInputMaxResultsInteger;
539
+ /**
540
+ * The pagination token from the previous ListSchemaMappings API call.
541
+ */
542
+ nextToken?: NextToken;
543
+ }
544
+ export type ListSchemaMappingsInputMaxResultsInteger = number;
545
+ export interface ListSchemaMappingsOutput {
546
+ /**
547
+ * The pagination token from the previous ListDomains API call.
548
+ */
549
+ nextToken?: NextToken;
550
+ /**
551
+ * A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.
552
+ */
553
+ schemaList?: SchemaMappingList;
554
+ }
555
+ export interface ListTagsForResourceInput {
556
+ /**
557
+ * The ARN of the resource for which you want to view tags.
558
+ */
559
+ resourceArn: VeniceGlobalArn;
560
+ }
561
+ export interface ListTagsForResourceOutput {
562
+ /**
563
+ * The tags used to organize, track, or control access for this resource.
564
+ */
565
+ tags: TagMap;
566
+ }
567
+ export type MatchingWorkflowArn = string;
568
+ export type MatchingWorkflowList = MatchingWorkflowSummary[];
569
+ export interface MatchingWorkflowSummary {
570
+ /**
571
+ * The timestamp of when the workflow was created.
572
+ */
573
+ createdAt: Timestamp;
574
+ /**
575
+ * The timestamp of when the workflow was last updated.
576
+ */
577
+ updatedAt: Timestamp;
578
+ /**
579
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
580
+ */
581
+ workflowArn: MatchingWorkflowArn;
582
+ /**
583
+ * The name of the workflow.
584
+ */
585
+ workflowName: EntityName;
586
+ }
587
+ export type NextToken = string;
588
+ export interface OutputAttribute {
589
+ /**
590
+ * Enables the ability to hash the column values in the output.
591
+ */
592
+ hashed?: Boolean;
593
+ /**
594
+ * A name of a column to be written to the output. This must be an InputField name in the schema mapping.
595
+ */
596
+ name: AttributeName;
597
+ }
598
+ export interface OutputSource {
599
+ /**
600
+ * Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
601
+ */
602
+ KMSArn?: KMSArn;
603
+ /**
604
+ * Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, 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.
605
+ */
606
+ applyNormalization?: Boolean;
607
+ /**
608
+ * A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
609
+ */
610
+ output: OutputSourceOutputList;
611
+ /**
612
+ * The S3 path to which Entity Resolution will write the output table.
613
+ */
614
+ outputS3Path: OutputSourceOutputS3PathString;
615
+ }
616
+ export type OutputSourceConfig = OutputSource[];
617
+ export type OutputSourceOutputList = OutputAttribute[];
618
+ export type OutputSourceOutputS3PathString = string;
619
+ export type RecordAttributeMap = {[key: string]: RecordAttributeMapValueString};
620
+ export type RecordAttributeMapKeyString = string;
621
+ export type RecordAttributeMapValueString = string;
622
+ export interface ResolutionTechniques {
623
+ /**
624
+ * There are two types of matching, RULE_MATCHING and ML_MATCHING
625
+ */
626
+ resolutionType?: ResolutionType;
627
+ /**
628
+ * An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.
629
+ */
630
+ ruleBasedProperties?: RuleBasedProperties;
631
+ }
632
+ export type ResolutionType = "RULE_MATCHING"|"ML_MATCHING"|string;
633
+ export interface Rule {
634
+ /**
635
+ * A list of MatchingKeys. The MatchingKeys must have been defined in the SchemaMapping. Two records are considered to match according to this rule if all of the MatchingKeys match.
636
+ */
637
+ matchingKeys: RuleMatchingKeysList;
638
+ /**
639
+ * A name for the matching rule.
640
+ */
641
+ ruleName: RuleRuleNameString;
642
+ }
643
+ export interface RuleBasedProperties {
644
+ /**
645
+ * You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.
646
+ */
647
+ attributeMatchingModel: AttributeMatchingModel;
648
+ /**
649
+ * A list of Rule objects, each of which have fields RuleName and MatchingKeys.
650
+ */
651
+ rules: RuleBasedPropertiesRulesList;
652
+ }
653
+ export type RuleBasedPropertiesRulesList = Rule[];
654
+ export type RuleMatchingKeysList = AttributeName[];
655
+ export type RuleRuleNameString = string;
656
+ export type SchemaAttributeType = "NAME"|"NAME_FIRST"|"NAME_MIDDLE"|"NAME_LAST"|"ADDRESS"|"ADDRESS_STREET1"|"ADDRESS_STREET2"|"ADDRESS_STREET3"|"ADDRESS_CITY"|"ADDRESS_STATE"|"ADDRESS_COUNTRY"|"ADDRESS_POSTALCODE"|"PHONE"|"PHONE_NUMBER"|"PHONE_COUNTRYCODE"|"EMAIL_ADDRESS"|"UNIQUE_ID"|"DATE"|"STRING"|string;
657
+ export interface SchemaInputAttribute {
658
+ /**
659
+ * A string containing the field name.
660
+ */
661
+ fieldName: AttributeName;
662
+ /**
663
+ * Instruct Entity Resolution to combine several columns into a unified column with the identical attribute type. For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common GroupName will prompt Entity Resolution to concatenate them into a single value.
664
+ */
665
+ groupName?: AttributeName;
666
+ /**
667
+ * A key that allows grouping of multiple input attributes into a unified matching group. For example, let's consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning the MatchKey Address' to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group. If no MatchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.
668
+ */
669
+ matchKey?: AttributeName;
670
+ /**
671
+ * The type of the attribute, selected from a list of values.
672
+ */
673
+ type: SchemaAttributeType;
674
+ }
675
+ export type SchemaInputAttributes = SchemaInputAttribute[];
676
+ export type SchemaMappingArn = string;
677
+ export type SchemaMappingList = SchemaMappingSummary[];
678
+ export interface SchemaMappingSummary {
679
+ /**
680
+ * The timestamp of when the SchemaMapping was created.
681
+ */
682
+ createdAt: Timestamp;
683
+ /**
684
+ * The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
685
+ */
686
+ schemaArn: SchemaMappingArn;
687
+ /**
688
+ * The name of the schema.
689
+ */
690
+ schemaName: EntityName;
691
+ /**
692
+ * The timestamp of when the SchemaMapping was last updated.
693
+ */
694
+ updatedAt: Timestamp;
695
+ }
696
+ export interface StartMatchingJobInput {
697
+ /**
698
+ * The name of the matching job to be retrieved.
699
+ */
700
+ workflowName: EntityName;
701
+ }
702
+ export interface StartMatchingJobOutput {
703
+ /**
704
+ * The ID of the job.
705
+ */
706
+ jobId: JobId;
707
+ }
708
+ export type String = string;
709
+ export type TagKey = string;
710
+ export type TagKeyList = TagKey[];
711
+ export type TagMap = {[key: string]: TagValue};
712
+ export interface TagResourceInput {
713
+ /**
714
+ * The ARN of the resource for which you want to view tags.
715
+ */
716
+ resourceArn: VeniceGlobalArn;
717
+ /**
718
+ * The tags used to organize, track, or control access for this resource.
719
+ */
720
+ tags: TagMap;
721
+ }
722
+ export interface TagResourceOutput {
723
+ }
724
+ export type TagValue = string;
725
+ export type Timestamp = Date;
726
+ export interface UntagResourceInput {
727
+ /**
728
+ * The ARN of the resource for which you want to untag.
729
+ */
730
+ resourceArn: VeniceGlobalArn;
731
+ /**
732
+ * The list of tag keys to remove from the resource.
733
+ */
734
+ tagKeys: TagKeyList;
735
+ }
736
+ export interface UntagResourceOutput {
737
+ }
738
+ export interface UpdateMatchingWorkflowInput {
739
+ /**
740
+ * A description of the workflow.
741
+ */
742
+ description?: Description;
743
+ /**
744
+ * An object which defines an incremental run type and has only incrementalRunType as a field.
745
+ */
746
+ incrementalRunConfig?: IncrementalRunConfig;
747
+ /**
748
+ * A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
749
+ */
750
+ inputSourceConfig: InputSourceConfig;
751
+ /**
752
+ * A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
753
+ */
754
+ outputSourceConfig: OutputSourceConfig;
755
+ /**
756
+ * An object which defines the resolutionType and the ruleBasedProperties
757
+ */
758
+ resolutionTechniques: ResolutionTechniques;
759
+ /**
760
+ * The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
761
+ */
762
+ roleArn: String;
763
+ /**
764
+ * The name of the workflow to be retrieved.
765
+ */
766
+ workflowName: EntityName;
767
+ }
768
+ export interface UpdateMatchingWorkflowOutput {
769
+ /**
770
+ * A description of the workflow.
771
+ */
772
+ description?: Description;
773
+ /**
774
+ * An object which defines an incremental run type and has only incrementalRunType as a field.
775
+ */
776
+ incrementalRunConfig?: IncrementalRunConfig;
777
+ /**
778
+ * A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
779
+ */
780
+ inputSourceConfig: InputSourceConfig;
781
+ /**
782
+ * A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
783
+ */
784
+ outputSourceConfig: OutputSourceConfig;
785
+ /**
786
+ * An object which defines the resolutionType and the ruleBasedProperties
787
+ */
788
+ resolutionTechniques: ResolutionTechniques;
789
+ /**
790
+ * The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
791
+ */
792
+ roleArn: String;
793
+ /**
794
+ * The name of the workflow.
795
+ */
796
+ workflowName: EntityName;
797
+ }
798
+ export type VeniceGlobalArn = string;
799
+ /**
800
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
801
+ */
802
+ export type apiVersion = "2018-05-10"|"latest"|string;
803
+ export interface ClientApiVersions {
804
+ /**
805
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
806
+ */
807
+ apiVersion?: apiVersion;
808
+ }
809
+ export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
810
+ /**
811
+ * Contains interfaces for use with the EntityResolution client.
812
+ */
813
+ export import Types = EntityResolution;
814
+ }
815
+ export = EntityResolution;