1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2018-05-10", 5 "endpointPrefix":"entityresolution", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"AWSEntityResolution", 9 "serviceFullName":"AWS EntityResolution", 10 "serviceId":"EntityResolution", 11 "signatureVersion":"v4", 12 "signingName":"entityresolution", 13 "uid":"entityresolution-2018-05-10" 14 }, 15 "operations":{ 16 "CreateIdMappingWorkflow":{ 17 "name":"CreateIdMappingWorkflow", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/idmappingworkflows", 21 "responseCode":200 22 }, 23 "input":{"shape":"CreateIdMappingWorkflowInput"}, 24 "output":{"shape":"CreateIdMappingWorkflowOutput"}, 25 "errors":[ 26 {"shape":"ThrottlingException"}, 27 {"shape":"InternalServerException"}, 28 {"shape":"AccessDeniedException"}, 29 {"shape":"ExceedsLimitException"}, 30 {"shape":"ConflictException"}, 31 {"shape":"ValidationException"} 32 ], 33 "documentation":"<p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the <code>UpdateIdMappingWorkflow</code> API.</p>" 34 }, 35 "CreateMatchingWorkflow":{ 36 "name":"CreateMatchingWorkflow", 37 "http":{ 38 "method":"POST", 39 "requestUri":"/matchingworkflows", 40 "responseCode":200 41 }, 42 "input":{"shape":"CreateMatchingWorkflowInput"}, 43 "output":{"shape":"CreateMatchingWorkflowOutput"}, 44 "errors":[ 45 {"shape":"ThrottlingException"}, 46 {"shape":"InternalServerException"}, 47 {"shape":"AccessDeniedException"}, 48 {"shape":"ExceedsLimitException"}, 49 {"shape":"ConflictException"}, 50 {"shape":"ValidationException"} 51 ], 52 "documentation":"<p>Creates a <code>MatchingWorkflow</code> 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 <code>MatchingWorkflow</code> with the same name. To modify an existing workflow, utilize the <code>UpdateMatchingWorkflow</code> API.</p>" 53 }, 54 "CreateSchemaMapping":{ 55 "name":"CreateSchemaMapping", 56 "http":{ 57 "method":"POST", 58 "requestUri":"/schemas", 59 "responseCode":200 60 }, 61 "input":{"shape":"CreateSchemaMappingInput"}, 62 "output":{"shape":"CreateSchemaMappingOutput"}, 63 "errors":[ 64 {"shape":"ThrottlingException"}, 65 {"shape":"InternalServerException"}, 66 {"shape":"AccessDeniedException"}, 67 {"shape":"ExceedsLimitException"}, 68 {"shape":"ConflictException"}, 69 {"shape":"ValidationException"} 70 ], 71 "documentation":"<p>Creates a schema mapping, which defines the schema of the input customer records table. The <code>SchemaMapping</code> also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.</p>" 72 }, 73 "DeleteIdMappingWorkflow":{ 74 "name":"DeleteIdMappingWorkflow", 75 "http":{ 76 "method":"DELETE", 77 "requestUri":"/idmappingworkflows/{workflowName}", 78 "responseCode":200 79 }, 80 "input":{"shape":"DeleteIdMappingWorkflowInput"}, 81 "output":{"shape":"DeleteIdMappingWorkflowOutput"}, 82 "errors":[ 83 {"shape":"ThrottlingException"}, 84 {"shape":"InternalServerException"}, 85 {"shape":"AccessDeniedException"}, 86 {"shape":"ValidationException"} 87 ], 88 "documentation":"<p>Deletes the <code>IdMappingWorkflow</code> with a given name. This operation will succeed even if a workflow with the given name does not exist.</p>", 89 "idempotent":true 90 }, 91 "DeleteMatchingWorkflow":{ 92 "name":"DeleteMatchingWorkflow", 93 "http":{ 94 "method":"DELETE", 95 "requestUri":"/matchingworkflows/{workflowName}", 96 "responseCode":200 97 }, 98 "input":{"shape":"DeleteMatchingWorkflowInput"}, 99 "output":{"shape":"DeleteMatchingWorkflowOutput"}, 100 "errors":[ 101 {"shape":"ThrottlingException"}, 102 {"shape":"InternalServerException"}, 103 {"shape":"AccessDeniedException"}, 104 {"shape":"ValidationException"} 105 ], 106 "documentation":"<p>Deletes the <code>MatchingWorkflow</code> with a given name. This operation will succeed even if a workflow with the given name does not exist.</p>", 107 "idempotent":true 108 }, 109 "DeleteSchemaMapping":{ 110 "name":"DeleteSchemaMapping", 111 "http":{ 112 "method":"DELETE", 113 "requestUri":"/schemas/{schemaName}", 114 "responseCode":200 115 }, 116 "input":{"shape":"DeleteSchemaMappingInput"}, 117 "output":{"shape":"DeleteSchemaMappingOutput"}, 118 "errors":[ 119 {"shape":"ThrottlingException"}, 120 {"shape":"InternalServerException"}, 121 {"shape":"AccessDeniedException"}, 122 {"shape":"ConflictException"}, 123 {"shape":"ValidationException"} 124 ], 125 "documentation":"<p>Deletes the <code>SchemaMapping</code> 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 <code>MatchingWorkflow</code> object that references the <code>SchemaMapping</code> in the workflow's <code>InputSourceConfig</code>.</p>", 126 "idempotent":true 127 }, 128 "GetIdMappingJob":{ 129 "name":"GetIdMappingJob", 130 "http":{ 131 "method":"GET", 132 "requestUri":"/idmappingworkflows/{workflowName}/jobs/{jobId}", 133 "responseCode":200 134 }, 135 "input":{"shape":"GetIdMappingJobInput"}, 136 "output":{"shape":"GetIdMappingJobOutput"}, 137 "errors":[ 138 {"shape":"ThrottlingException"}, 139 {"shape":"InternalServerException"}, 140 {"shape":"ResourceNotFoundException"}, 141 {"shape":"AccessDeniedException"}, 142 {"shape":"ValidationException"} 143 ], 144 "documentation":"<p>Gets the status, metrics, and errors (if there are any) that are associated with a job.</p>" 145 }, 146 "GetIdMappingWorkflow":{ 147 "name":"GetIdMappingWorkflow", 148 "http":{ 149 "method":"GET", 150 "requestUri":"/idmappingworkflows/{workflowName}", 151 "responseCode":200 152 }, 153 "input":{"shape":"GetIdMappingWorkflowInput"}, 154 "output":{"shape":"GetIdMappingWorkflowOutput"}, 155 "errors":[ 156 {"shape":"ThrottlingException"}, 157 {"shape":"InternalServerException"}, 158 {"shape":"ResourceNotFoundException"}, 159 {"shape":"AccessDeniedException"}, 160 {"shape":"ValidationException"} 161 ], 162 "documentation":"<p>Returns the <code>IdMappingWorkflow</code> with a given name, if it exists.</p>" 163 }, 164 "GetMatchId":{ 165 "name":"GetMatchId", 166 "http":{ 167 "method":"POST", 168 "requestUri":"/matchingworkflows/{workflowName}/matches", 169 "responseCode":200 170 }, 171 "input":{"shape":"GetMatchIdInput"}, 172 "output":{"shape":"GetMatchIdOutput"}, 173 "errors":[ 174 {"shape":"ThrottlingException"}, 175 {"shape":"InternalServerException"}, 176 {"shape":"ResourceNotFoundException"}, 177 {"shape":"AccessDeniedException"}, 178 {"shape":"ValidationException"} 179 ], 180 "documentation":"<p>Returns the corresponding Match ID of a customer record if the record has been processed.</p>" 181 }, 182 "GetMatchingJob":{ 183 "name":"GetMatchingJob", 184 "http":{ 185 "method":"GET", 186 "requestUri":"/matchingworkflows/{workflowName}/jobs/{jobId}", 187 "responseCode":200 188 }, 189 "input":{"shape":"GetMatchingJobInput"}, 190 "output":{"shape":"GetMatchingJobOutput"}, 191 "errors":[ 192 {"shape":"ThrottlingException"}, 193 {"shape":"InternalServerException"}, 194 {"shape":"ResourceNotFoundException"}, 195 {"shape":"AccessDeniedException"}, 196 {"shape":"ValidationException"} 197 ], 198 "documentation":"<p>Gets the status, metrics, and errors (if there are any) that are associated with a job.</p>" 199 }, 200 "GetMatchingWorkflow":{ 201 "name":"GetMatchingWorkflow", 202 "http":{ 203 "method":"GET", 204 "requestUri":"/matchingworkflows/{workflowName}", 205 "responseCode":200 206 }, 207 "input":{"shape":"GetMatchingWorkflowInput"}, 208 "output":{"shape":"GetMatchingWorkflowOutput"}, 209 "errors":[ 210 {"shape":"ThrottlingException"}, 211 {"shape":"InternalServerException"}, 212 {"shape":"ResourceNotFoundException"}, 213 {"shape":"AccessDeniedException"}, 214 {"shape":"ValidationException"} 215 ], 216 "documentation":"<p>Returns the <code>MatchingWorkflow</code> with a given name, if it exists.</p>" 217 }, 218 "GetProviderService":{ 219 "name":"GetProviderService", 220 "http":{ 221 "method":"GET", 222 "requestUri":"/providerservices/{providerName}/{providerServiceName}", 223 "responseCode":200 224 }, 225 "input":{"shape":"GetProviderServiceInput"}, 226 "output":{"shape":"GetProviderServiceOutput"}, 227 "errors":[ 228 {"shape":"ThrottlingException"}, 229 {"shape":"InternalServerException"}, 230 {"shape":"ResourceNotFoundException"}, 231 {"shape":"AccessDeniedException"}, 232 {"shape":"ValidationException"} 233 ], 234 "documentation":"<p>Returns the <code>ProviderService</code> of a given name.</p>" 235 }, 236 "GetSchemaMapping":{ 237 "name":"GetSchemaMapping", 238 "http":{ 239 "method":"GET", 240 "requestUri":"/schemas/{schemaName}", 241 "responseCode":200 242 }, 243 "input":{"shape":"GetSchemaMappingInput"}, 244 "output":{"shape":"GetSchemaMappingOutput"}, 245 "errors":[ 246 {"shape":"ThrottlingException"}, 247 {"shape":"InternalServerException"}, 248 {"shape":"ResourceNotFoundException"}, 249 {"shape":"AccessDeniedException"}, 250 {"shape":"ValidationException"} 251 ], 252 "documentation":"<p>Returns the SchemaMapping of a given name.</p>" 253 }, 254 "ListIdMappingJobs":{ 255 "name":"ListIdMappingJobs", 256 "http":{ 257 "method":"GET", 258 "requestUri":"/idmappingworkflows/{workflowName}/jobs", 259 "responseCode":200 260 }, 261 "input":{"shape":"ListIdMappingJobsInput"}, 262 "output":{"shape":"ListIdMappingJobsOutput"}, 263 "errors":[ 264 {"shape":"ThrottlingException"}, 265 {"shape":"InternalServerException"}, 266 {"shape":"ResourceNotFoundException"}, 267 {"shape":"AccessDeniedException"}, 268 {"shape":"ValidationException"} 269 ], 270 "documentation":"<p>Lists all ID mapping jobs for a given workflow.</p>" 271 }, 272 "ListIdMappingWorkflows":{ 273 "name":"ListIdMappingWorkflows", 274 "http":{ 275 "method":"GET", 276 "requestUri":"/idmappingworkflows", 277 "responseCode":200 278 }, 279 "input":{"shape":"ListIdMappingWorkflowsInput"}, 280 "output":{"shape":"ListIdMappingWorkflowsOutput"}, 281 "errors":[ 282 {"shape":"ThrottlingException"}, 283 {"shape":"InternalServerException"}, 284 {"shape":"AccessDeniedException"}, 285 {"shape":"ValidationException"} 286 ], 287 "documentation":"<p>Returns a list of all the <code>IdMappingWorkflows</code> that have been created for an Amazon Web Services account.</p>" 288 }, 289 "ListMatchingJobs":{ 290 "name":"ListMatchingJobs", 291 "http":{ 292 "method":"GET", 293 "requestUri":"/matchingworkflows/{workflowName}/jobs", 294 "responseCode":200 295 }, 296 "input":{"shape":"ListMatchingJobsInput"}, 297 "output":{"shape":"ListMatchingJobsOutput"}, 298 "errors":[ 299 {"shape":"ThrottlingException"}, 300 {"shape":"InternalServerException"}, 301 {"shape":"ResourceNotFoundException"}, 302 {"shape":"AccessDeniedException"}, 303 {"shape":"ValidationException"} 304 ], 305 "documentation":"<p>Lists all jobs for a given workflow.</p>" 306 }, 307 "ListMatchingWorkflows":{ 308 "name":"ListMatchingWorkflows", 309 "http":{ 310 "method":"GET", 311 "requestUri":"/matchingworkflows", 312 "responseCode":200 313 }, 314 "input":{"shape":"ListMatchingWorkflowsInput"}, 315 "output":{"shape":"ListMatchingWorkflowsOutput"}, 316 "errors":[ 317 {"shape":"ThrottlingException"}, 318 {"shape":"InternalServerException"}, 319 {"shape":"AccessDeniedException"}, 320 {"shape":"ValidationException"} 321 ], 322 "documentation":"<p>Returns a list of all the <code>MatchingWorkflows</code> that have been created for an Amazon Web Services account.</p>" 323 }, 324 "ListProviderServices":{ 325 "name":"ListProviderServices", 326 "http":{ 327 "method":"GET", 328 "requestUri":"/providerservices", 329 "responseCode":200 330 }, 331 "input":{"shape":"ListProviderServicesInput"}, 332 "output":{"shape":"ListProviderServicesOutput"}, 333 "errors":[ 334 {"shape":"ThrottlingException"}, 335 {"shape":"InternalServerException"}, 336 {"shape":"AccessDeniedException"}, 337 {"shape":"ValidationException"} 338 ], 339 "documentation":"<p>Returns a list of all the <code>ProviderServices</code> that are available in this Amazon Web Services Region.</p>" 340 }, 341 "ListSchemaMappings":{ 342 "name":"ListSchemaMappings", 343 "http":{ 344 "method":"GET", 345 "requestUri":"/schemas", 346 "responseCode":200 347 }, 348 "input":{"shape":"ListSchemaMappingsInput"}, 349 "output":{"shape":"ListSchemaMappingsOutput"}, 350 "errors":[ 351 {"shape":"ThrottlingException"}, 352 {"shape":"InternalServerException"}, 353 {"shape":"AccessDeniedException"}, 354 {"shape":"ValidationException"} 355 ], 356 "documentation":"<p>Returns a list of all the <code>SchemaMappings</code> that have been created for an Amazon Web Services account.</p>" 357 }, 358 "ListTagsForResource":{ 359 "name":"ListTagsForResource", 360 "http":{ 361 "method":"GET", 362 "requestUri":"/tags/{resourceArn}", 363 "responseCode":200 364 }, 365 "input":{"shape":"ListTagsForResourceInput"}, 366 "output":{"shape":"ListTagsForResourceOutput"}, 367 "errors":[ 368 {"shape":"InternalServerException"}, 369 {"shape":"ResourceNotFoundException"}, 370 {"shape":"ValidationException"} 371 ], 372 "documentation":"<p>Displays the tags associated with an Entity Resolution resource. In Entity Resolution, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be tagged.</p>" 373 }, 374 "StartIdMappingJob":{ 375 "name":"StartIdMappingJob", 376 "http":{ 377 "method":"POST", 378 "requestUri":"/idmappingworkflows/{workflowName}/jobs", 379 "responseCode":200 380 }, 381 "input":{"shape":"StartIdMappingJobInput"}, 382 "output":{"shape":"StartIdMappingJobOutput"}, 383 "errors":[ 384 {"shape":"ThrottlingException"}, 385 {"shape":"InternalServerException"}, 386 {"shape":"ResourceNotFoundException"}, 387 {"shape":"AccessDeniedException"}, 388 {"shape":"ExceedsLimitException"}, 389 {"shape":"ConflictException"}, 390 {"shape":"ValidationException"} 391 ], 392 "documentation":"<p>Starts the <code>IdMappingJob</code> of a workflow. The workflow must have previously been created using the <code>CreateIdMappingWorkflow</code> endpoint.</p>" 393 }, 394 "StartMatchingJob":{ 395 "name":"StartMatchingJob", 396 "http":{ 397 "method":"POST", 398 "requestUri":"/matchingworkflows/{workflowName}/jobs", 399 "responseCode":200 400 }, 401 "input":{"shape":"StartMatchingJobInput"}, 402 "output":{"shape":"StartMatchingJobOutput"}, 403 "errors":[ 404 {"shape":"ThrottlingException"}, 405 {"shape":"InternalServerException"}, 406 {"shape":"ResourceNotFoundException"}, 407 {"shape":"AccessDeniedException"}, 408 {"shape":"ExceedsLimitException"}, 409 {"shape":"ConflictException"}, 410 {"shape":"ValidationException"} 411 ], 412 "documentation":"<p>Starts the <code>MatchingJob</code> of a workflow. The workflow must have previously been created using the <code>CreateMatchingWorkflow</code> endpoint.</p>" 413 }, 414 "TagResource":{ 415 "name":"TagResource", 416 "http":{ 417 "method":"POST", 418 "requestUri":"/tags/{resourceArn}", 419 "responseCode":200 420 }, 421 "input":{"shape":"TagResourceInput"}, 422 "output":{"shape":"TagResourceOutput"}, 423 "errors":[ 424 {"shape":"InternalServerException"}, 425 {"shape":"ResourceNotFoundException"}, 426 {"shape":"ValidationException"} 427 ], 428 "documentation":"<p>Assigns one or more tags (key-value pairs) to the specified 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, <code>SchemaMapping</code> and <code>MatchingWorkflow</code> can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the <code>TagResource</code> 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.</p>" 429 }, 430 "UntagResource":{ 431 "name":"UntagResource", 432 "http":{ 433 "method":"DELETE", 434 "requestUri":"/tags/{resourceArn}", 435 "responseCode":200 436 }, 437 "input":{"shape":"UntagResourceInput"}, 438 "output":{"shape":"UntagResourceOutput"}, 439 "errors":[ 440 {"shape":"InternalServerException"}, 441 {"shape":"ResourceNotFoundException"} 442 ], 443 "documentation":"<p>Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be tagged.</p>", 444 "idempotent":true 445 }, 446 "UpdateIdMappingWorkflow":{ 447 "name":"UpdateIdMappingWorkflow", 448 "http":{ 449 "method":"PUT", 450 "requestUri":"/idmappingworkflows/{workflowName}", 451 "responseCode":200 452 }, 453 "input":{"shape":"UpdateIdMappingWorkflowInput"}, 454 "output":{"shape":"UpdateIdMappingWorkflowOutput"}, 455 "errors":[ 456 {"shape":"ThrottlingException"}, 457 {"shape":"InternalServerException"}, 458 {"shape":"ResourceNotFoundException"}, 459 {"shape":"AccessDeniedException"}, 460 {"shape":"ValidationException"} 461 ], 462 "documentation":"<p>Updates an existing <code>IdMappingWorkflow</code>. This method is identical to <code>CreateIdMappingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>IdMappingWorkflow</code> must already exist for the method to succeed.</p>", 463 "idempotent":true 464 }, 465 "UpdateMatchingWorkflow":{ 466 "name":"UpdateMatchingWorkflow", 467 "http":{ 468 "method":"PUT", 469 "requestUri":"/matchingworkflows/{workflowName}", 470 "responseCode":200 471 }, 472 "input":{"shape":"UpdateMatchingWorkflowInput"}, 473 "output":{"shape":"UpdateMatchingWorkflowOutput"}, 474 "errors":[ 475 {"shape":"ThrottlingException"}, 476 {"shape":"InternalServerException"}, 477 {"shape":"ResourceNotFoundException"}, 478 {"shape":"AccessDeniedException"}, 479 {"shape":"ValidationException"} 480 ], 481 "documentation":"<p>Updates an existing <code>MatchingWorkflow</code>. This method is identical to <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already exist for the method to succeed.</p>", 482 "idempotent":true 483 }, 484 "UpdateSchemaMapping":{ 485 "name":"UpdateSchemaMapping", 486 "http":{ 487 "method":"PUT", 488 "requestUri":"/schemas/{schemaName}", 489 "responseCode":200 490 }, 491 "input":{"shape":"UpdateSchemaMappingInput"}, 492 "output":{"shape":"UpdateSchemaMappingOutput"}, 493 "errors":[ 494 {"shape":"ThrottlingException"}, 495 {"shape":"InternalServerException"}, 496 {"shape":"ResourceNotFoundException"}, 497 {"shape":"AccessDeniedException"}, 498 {"shape":"ConflictException"}, 499 {"shape":"ValidationException"} 500 ], 501 "documentation":"<p>Updates a schema mapping.</p> <note> <p>A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow. </p> </note>", 502 "idempotent":true 503 } 504 }, 505 "shapes":{ 506 "AccessDeniedException":{ 507 "type":"structure", 508 "members":{ 509 "message":{"shape":"ErrorMessage"} 510 }, 511 "documentation":"<p>You do not have sufficient access to perform this action. <code>HTTP Status Code: 403</code> </p>", 512 "error":{ 513 "httpStatusCode":403, 514 "senderFault":true 515 }, 516 "exception":true 517 }, 518 "AttributeMatchingModel":{ 519 "type":"string", 520 "enum":[ 521 "ONE_TO_ONE", 522 "MANY_TO_MANY" 523 ] 524 }, 525 "AttributeName":{ 526 "type":"string", 527 "max":255, 528 "min":0, 529 "pattern":"^[a-zA-Z_0-9- \\t]*$" 530 }, 531 "AwsAccountId":{ 532 "type":"string", 533 "pattern":"\\d{12}" 534 }, 535 "AwsAccountIdList":{ 536 "type":"list", 537 "member":{"shape":"AwsAccountId"} 538 }, 539 "Boolean":{ 540 "type":"boolean", 541 "box":true 542 }, 543 "ConflictException":{ 544 "type":"structure", 545 "members":{ 546 "message":{"shape":"ErrorMessage"} 547 }, 548 "documentation":"<p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. <code>HTTP Status Code: 400</code> </p>", 549 "error":{ 550 "httpStatusCode":400, 551 "senderFault":true 552 }, 553 "exception":true 554 }, 555 "CreateIdMappingWorkflowInput":{ 556 "type":"structure", 557 "required":[ 558 "idMappingTechniques", 559 "inputSourceConfig", 560 "outputSourceConfig", 561 "roleArn", 562 "workflowName" 563 ], 564 "members":{ 565 "description":{ 566 "shape":"Description", 567 "documentation":"<p>A description of the workflow.</p>" 568 }, 569 "idMappingTechniques":{ 570 "shape":"IdMappingTechniques", 571 "documentation":"<p>An object which defines the <code>idMappingType</code> and the <code>providerProperties</code>.</p>" 572 }, 573 "inputSourceConfig":{ 574 "shape":"IdMappingWorkflowInputSourceConfig", 575 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 576 }, 577 "outputSourceConfig":{ 578 "shape":"IdMappingWorkflowOutputSourceConfig", 579 "documentation":"<p>A list of <code>IdMappingWorkflowOutputSource</code> objects, each of which contains fields <code>OutputS3Path</code> and <code>Output</code>.</p>" 580 }, 581 "roleArn":{ 582 "shape":"RoleArn", 583 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 584 }, 585 "tags":{ 586 "shape":"TagMap", 587 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 588 }, 589 "workflowName":{ 590 "shape":"EntityName", 591 "documentation":"<p>The name of the workflow. There can't be multiple <code>IdMappingWorkflows</code> with the same name.</p>" 592 } 593 } 594 }, 595 "CreateIdMappingWorkflowOutput":{ 596 "type":"structure", 597 "required":[ 598 "idMappingTechniques", 599 "inputSourceConfig", 600 "outputSourceConfig", 601 "roleArn", 602 "workflowArn", 603 "workflowName" 604 ], 605 "members":{ 606 "description":{ 607 "shape":"Description", 608 "documentation":"<p>A description of the workflow.</p>" 609 }, 610 "idMappingTechniques":{ 611 "shape":"IdMappingTechniques", 612 "documentation":"<p>An object which defines the <code>idMappingType</code> and the <code>providerProperties</code>.</p>" 613 }, 614 "inputSourceConfig":{ 615 "shape":"IdMappingWorkflowInputSourceConfig", 616 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 617 }, 618 "outputSourceConfig":{ 619 "shape":"IdMappingWorkflowOutputSourceConfig", 620 "documentation":"<p>A list of <code>IdMappingWorkflowOutputSource</code> objects, each of which contains fields <code>OutputS3Path</code> and <code>Output</code>.</p>" 621 }, 622 "roleArn":{ 623 "shape":"RoleArn", 624 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 625 }, 626 "workflowArn":{ 627 "shape":"IdMappingWorkflowArn", 628 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>IDMappingWorkflow</code>.</p>" 629 }, 630 "workflowName":{ 631 "shape":"EntityName", 632 "documentation":"<p>The name of the workflow.</p>" 633 } 634 } 635 }, 636 "CreateMatchingWorkflowInput":{ 637 "type":"structure", 638 "required":[ 639 "inputSourceConfig", 640 "outputSourceConfig", 641 "resolutionTechniques", 642 "roleArn", 643 "workflowName" 644 ], 645 "members":{ 646 "description":{ 647 "shape":"Description", 648 "documentation":"<p>A description of the workflow.</p>" 649 }, 650 "incrementalRunConfig":{ 651 "shape":"IncrementalRunConfig", 652 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 653 }, 654 "inputSourceConfig":{ 655 "shape":"InputSourceConfig", 656 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 657 }, 658 "outputSourceConfig":{ 659 "shape":"OutputSourceConfig", 660 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>, <code>ApplyNormalization</code>, and <code>Output</code>.</p>" 661 }, 662 "resolutionTechniques":{ 663 "shape":"ResolutionTechniques", 664 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>.</p>" 665 }, 666 "roleArn":{ 667 "shape":"String", 668 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 669 }, 670 "tags":{ 671 "shape":"TagMap", 672 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 673 }, 674 "workflowName":{ 675 "shape":"EntityName", 676 "documentation":"<p>The name of the workflow. There can't be multiple <code>MatchingWorkflows</code> with the same name.</p>" 677 } 678 } 679 }, 680 "CreateMatchingWorkflowOutput":{ 681 "type":"structure", 682 "required":[ 683 "inputSourceConfig", 684 "outputSourceConfig", 685 "resolutionTechniques", 686 "roleArn", 687 "workflowArn", 688 "workflowName" 689 ], 690 "members":{ 691 "description":{ 692 "shape":"Description", 693 "documentation":"<p>A description of the workflow.</p>" 694 }, 695 "incrementalRunConfig":{ 696 "shape":"IncrementalRunConfig", 697 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 698 }, 699 "inputSourceConfig":{ 700 "shape":"InputSourceConfig", 701 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 702 }, 703 "outputSourceConfig":{ 704 "shape":"OutputSourceConfig", 705 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>, <code>ApplyNormalization</code>, and <code>Output</code>.</p>" 706 }, 707 "resolutionTechniques":{ 708 "shape":"ResolutionTechniques", 709 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>.</p>" 710 }, 711 "roleArn":{ 712 "shape":"String", 713 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 714 }, 715 "workflowArn":{ 716 "shape":"MatchingWorkflowArn", 717 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>" 718 }, 719 "workflowName":{ 720 "shape":"EntityName", 721 "documentation":"<p>The name of the workflow.</p>" 722 } 723 } 724 }, 725 "CreateSchemaMappingInput":{ 726 "type":"structure", 727 "required":[ 728 "mappedInputFields", 729 "schemaName" 730 ], 731 "members":{ 732 "description":{ 733 "shape":"Description", 734 "documentation":"<p>A description of the schema.</p>" 735 }, 736 "mappedInputFields":{ 737 "shape":"SchemaInputAttributes", 738 "documentation":"<p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.</p>" 739 }, 740 "schemaName":{ 741 "shape":"EntityName", 742 "documentation":"<p>The name of the schema. There can't be multiple <code>SchemaMappings</code> with the same name.</p>" 743 }, 744 "tags":{ 745 "shape":"TagMap", 746 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 747 } 748 } 749 }, 750 "CreateSchemaMappingOutput":{ 751 "type":"structure", 752 "required":[ 753 "description", 754 "mappedInputFields", 755 "schemaArn", 756 "schemaName" 757 ], 758 "members":{ 759 "description":{ 760 "shape":"Description", 761 "documentation":"<p>A description of the schema.</p>" 762 }, 763 "mappedInputFields":{ 764 "shape":"SchemaInputAttributes", 765 "documentation":"<p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.</p>" 766 }, 767 "schemaArn":{ 768 "shape":"SchemaMappingArn", 769 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>SchemaMapping</code>.</p>" 770 }, 771 "schemaName":{ 772 "shape":"EntityName", 773 "documentation":"<p>The name of the schema.</p>" 774 } 775 } 776 }, 777 "DeleteIdMappingWorkflowInput":{ 778 "type":"structure", 779 "required":["workflowName"], 780 "members":{ 781 "workflowName":{ 782 "shape":"EntityName", 783 "documentation":"<p>The name of the workflow to be deleted.</p>", 784 "location":"uri", 785 "locationName":"workflowName" 786 } 787 } 788 }, 789 "DeleteIdMappingWorkflowOutput":{ 790 "type":"structure", 791 "required":["message"], 792 "members":{ 793 "message":{ 794 "shape":"String", 795 "documentation":"<p>A successful operation message.</p>" 796 } 797 } 798 }, 799 "DeleteMatchingWorkflowInput":{ 800 "type":"structure", 801 "required":["workflowName"], 802 "members":{ 803 "workflowName":{ 804 "shape":"EntityName", 805 "documentation":"<p>The name of the workflow to be retrieved.</p>", 806 "location":"uri", 807 "locationName":"workflowName" 808 } 809 } 810 }, 811 "DeleteMatchingWorkflowOutput":{ 812 "type":"structure", 813 "required":["message"], 814 "members":{ 815 "message":{ 816 "shape":"String", 817 "documentation":"<p>A successful operation message.</p>" 818 } 819 } 820 }, 821 "DeleteSchemaMappingInput":{ 822 "type":"structure", 823 "required":["schemaName"], 824 "members":{ 825 "schemaName":{ 826 "shape":"EntityName", 827 "documentation":"<p>The name of the schema to delete.</p>", 828 "location":"uri", 829 "locationName":"schemaName" 830 } 831 } 832 }, 833 "DeleteSchemaMappingOutput":{ 834 "type":"structure", 835 "required":["message"], 836 "members":{ 837 "message":{ 838 "shape":"String", 839 "documentation":"<p>A successful operation message.</p>" 840 } 841 } 842 }, 843 "Description":{ 844 "type":"string", 845 "max":255, 846 "min":0 847 }, 848 "Document":{ 849 "type":"structure", 850 "members":{ 851 }, 852 "document":true 853 }, 854 "EntityName":{ 855 "type":"string", 856 "max":255, 857 "min":1, 858 "pattern":"^[a-zA-Z_0-9-]*$" 859 }, 860 "ErrorDetails":{ 861 "type":"structure", 862 "members":{ 863 "errorMessage":{ 864 "shape":"ErrorMessage", 865 "documentation":"<p>The error message from the job, if there is one.</p>" 866 } 867 }, 868 "documentation":"<p>An object containing an error message, if there was an error.</p>" 869 }, 870 "ErrorMessage":{ 871 "type":"string", 872 "max":2048, 873 "min":1 874 }, 875 "ExceedsLimitException":{ 876 "type":"structure", 877 "members":{ 878 "message":{"shape":"ErrorMessage"}, 879 "quotaName":{ 880 "shape":"String", 881 "documentation":"<p>The name of the quota that has been breached.</p>" 882 }, 883 "quotaValue":{ 884 "shape":"Integer", 885 "documentation":"<p>The current quota value for the customers.</p>" 886 } 887 }, 888 "documentation":"<p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. <code>HTTP Status Code: 402</code> </p>", 889 "error":{ 890 "httpStatusCode":402, 891 "senderFault":true 892 }, 893 "exception":true 894 }, 895 "GetIdMappingJobInput":{ 896 "type":"structure", 897 "required":[ 898 "jobId", 899 "workflowName" 900 ], 901 "members":{ 902 "jobId":{ 903 "shape":"JobId", 904 "documentation":"<p>The ID of the job.</p>", 905 "location":"uri", 906 "locationName":"jobId" 907 }, 908 "workflowName":{ 909 "shape":"EntityName", 910 "documentation":"<p>The name of the workflow.</p>", 911 "location":"uri", 912 "locationName":"workflowName" 913 } 914 } 915 }, 916 "GetIdMappingJobOutput":{ 917 "type":"structure", 918 "required":[ 919 "jobId", 920 "startTime", 921 "status" 922 ], 923 "members":{ 924 "endTime":{ 925 "shape":"Timestamp", 926 "documentation":"<p>The time at which the job has finished.</p>" 927 }, 928 "errorDetails":{"shape":"ErrorDetails"}, 929 "jobId":{ 930 "shape":"JobId", 931 "documentation":"<p>The ID of the job.</p>" 932 }, 933 "metrics":{ 934 "shape":"IdMappingJobMetrics", 935 "documentation":"<p>Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.</p>" 936 }, 937 "startTime":{ 938 "shape":"Timestamp", 939 "documentation":"<p>The time at which the job was started.</p>" 940 }, 941 "status":{ 942 "shape":"JobStatus", 943 "documentation":"<p>The current status of the job.</p>" 944 } 945 } 946 }, 947 "GetIdMappingWorkflowInput":{ 948 "type":"structure", 949 "required":["workflowName"], 950 "members":{ 951 "workflowName":{ 952 "shape":"EntityName", 953 "documentation":"<p>The name of the workflow.</p>", 954 "location":"uri", 955 "locationName":"workflowName" 956 } 957 } 958 }, 959 "GetIdMappingWorkflowOutput":{ 960 "type":"structure", 961 "required":[ 962 "createdAt", 963 "idMappingTechniques", 964 "inputSourceConfig", 965 "outputSourceConfig", 966 "roleArn", 967 "updatedAt", 968 "workflowArn", 969 "workflowName" 970 ], 971 "members":{ 972 "createdAt":{ 973 "shape":"Timestamp", 974 "documentation":"<p>The timestamp of when the workflow was created.</p>" 975 }, 976 "description":{ 977 "shape":"Description", 978 "documentation":"<p>A description of the workflow.</p>" 979 }, 980 "idMappingTechniques":{ 981 "shape":"IdMappingTechniques", 982 "documentation":"<p>An object which defines the <code>idMappingType</code> and the <code>providerProperties</code>.</p>" 983 }, 984 "inputSourceConfig":{ 985 "shape":"IdMappingWorkflowInputSourceConfig", 986 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 987 }, 988 "outputSourceConfig":{ 989 "shape":"IdMappingWorkflowOutputSourceConfig", 990 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code> and <code>KMSArn</code>.</p>" 991 }, 992 "roleArn":{ 993 "shape":"RoleArn", 994 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.</p>" 995 }, 996 "tags":{ 997 "shape":"TagMap", 998 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 999 }, 1000 "updatedAt":{ 1001 "shape":"Timestamp", 1002 "documentation":"<p>The timestamp of when the workflow was last updated.</p>" 1003 }, 1004 "workflowArn":{ 1005 "shape":"IdMappingWorkflowArn", 1006 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>IdMappingWorkflow</code> .</p>" 1007 }, 1008 "workflowName":{ 1009 "shape":"EntityName", 1010 "documentation":"<p>The name of the workflow.</p>" 1011 } 1012 } 1013 }, 1014 "GetMatchIdInput":{ 1015 "type":"structure", 1016 "required":[ 1017 "record", 1018 "workflowName" 1019 ], 1020 "members":{ 1021 "record":{ 1022 "shape":"RecordAttributeMap", 1023 "documentation":"<p>The record to fetch the Match ID for.</p>" 1024 }, 1025 "workflowName":{ 1026 "shape":"EntityName", 1027 "documentation":"<p>The name of the workflow.</p>", 1028 "location":"uri", 1029 "locationName":"workflowName" 1030 } 1031 } 1032 }, 1033 "GetMatchIdOutput":{ 1034 "type":"structure", 1035 "members":{ 1036 "matchId":{ 1037 "shape":"String", 1038 "documentation":"<p>The unique identifiers for this group of match records.</p>" 1039 } 1040 } 1041 }, 1042 "GetMatchingJobInput":{ 1043 "type":"structure", 1044 "required":[ 1045 "jobId", 1046 "workflowName" 1047 ], 1048 "members":{ 1049 "jobId":{ 1050 "shape":"JobId", 1051 "documentation":"<p>The ID of the job.</p>", 1052 "location":"uri", 1053 "locationName":"jobId" 1054 }, 1055 "workflowName":{ 1056 "shape":"EntityName", 1057 "documentation":"<p>The name of the workflow.</p>", 1058 "location":"uri", 1059 "locationName":"workflowName" 1060 } 1061 } 1062 }, 1063 "GetMatchingJobOutput":{ 1064 "type":"structure", 1065 "required":[ 1066 "jobId", 1067 "startTime", 1068 "status" 1069 ], 1070 "members":{ 1071 "endTime":{ 1072 "shape":"Timestamp", 1073 "documentation":"<p>The time at which the job has finished.</p>" 1074 }, 1075 "errorDetails":{ 1076 "shape":"ErrorDetails", 1077 "documentation":"<p>An object containing an error message, if there was an error.</p>" 1078 }, 1079 "jobId":{ 1080 "shape":"JobId", 1081 "documentation":"<p>The ID of the job.</p>" 1082 }, 1083 "metrics":{ 1084 "shape":"JobMetrics", 1085 "documentation":"<p>Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.</p>" 1086 }, 1087 "startTime":{ 1088 "shape":"Timestamp", 1089 "documentation":"<p>The time at which the job was started.</p>" 1090 }, 1091 "status":{ 1092 "shape":"JobStatus", 1093 "documentation":"<p>The current status of the job.</p>" 1094 } 1095 } 1096 }, 1097 "GetMatchingWorkflowInput":{ 1098 "type":"structure", 1099 "required":["workflowName"], 1100 "members":{ 1101 "workflowName":{ 1102 "shape":"EntityName", 1103 "documentation":"<p>The name of the workflow.</p>", 1104 "location":"uri", 1105 "locationName":"workflowName" 1106 } 1107 } 1108 }, 1109 "GetMatchingWorkflowOutput":{ 1110 "type":"structure", 1111 "required":[ 1112 "createdAt", 1113 "inputSourceConfig", 1114 "outputSourceConfig", 1115 "resolutionTechniques", 1116 "roleArn", 1117 "updatedAt", 1118 "workflowArn", 1119 "workflowName" 1120 ], 1121 "members":{ 1122 "createdAt":{ 1123 "shape":"Timestamp", 1124 "documentation":"<p>The timestamp of when the workflow was created.</p>" 1125 }, 1126 "description":{ 1127 "shape":"Description", 1128 "documentation":"<p>A description of the workflow.</p>" 1129 }, 1130 "incrementalRunConfig":{ 1131 "shape":"IncrementalRunConfig", 1132 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 1133 }, 1134 "inputSourceConfig":{ 1135 "shape":"InputSourceConfig", 1136 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 1137 }, 1138 "outputSourceConfig":{ 1139 "shape":"OutputSourceConfig", 1140 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>, <code>ApplyNormalization</code>, and <code>Output</code>.</p>" 1141 }, 1142 "resolutionTechniques":{ 1143 "shape":"ResolutionTechniques", 1144 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>.</p>" 1145 }, 1146 "roleArn":{ 1147 "shape":"String", 1148 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.</p>" 1149 }, 1150 "tags":{ 1151 "shape":"TagMap", 1152 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 1153 }, 1154 "updatedAt":{ 1155 "shape":"Timestamp", 1156 "documentation":"<p>The timestamp of when the workflow was last updated.</p>" 1157 }, 1158 "workflowArn":{ 1159 "shape":"MatchingWorkflowArn", 1160 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>" 1161 }, 1162 "workflowName":{ 1163 "shape":"EntityName", 1164 "documentation":"<p>The name of the workflow.</p>" 1165 } 1166 } 1167 }, 1168 "GetProviderServiceInput":{ 1169 "type":"structure", 1170 "required":[ 1171 "providerName", 1172 "providerServiceName" 1173 ], 1174 "members":{ 1175 "providerName":{ 1176 "shape":"EntityName", 1177 "documentation":"<p>The name of the provider. This name is typically the company name.</p>", 1178 "location":"uri", 1179 "locationName":"providerName" 1180 }, 1181 "providerServiceName":{ 1182 "shape":"ProviderServiceArn", 1183 "documentation":"<p>The ARN (Amazon Resource Name) of the product that the provider service provides.</p>", 1184 "location":"uri", 1185 "locationName":"providerServiceName" 1186 } 1187 } 1188 }, 1189 "GetProviderServiceOutput":{ 1190 "type":"structure", 1191 "required":[ 1192 "anonymizedOutput", 1193 "providerEndpointConfiguration", 1194 "providerEntityOutputDefinition", 1195 "providerName", 1196 "providerServiceArn", 1197 "providerServiceDisplayName", 1198 "providerServiceName", 1199 "providerServiceType" 1200 ], 1201 "members":{ 1202 "anonymizedOutput":{ 1203 "shape":"Boolean", 1204 "documentation":"<p>Specifies whether output data from the provider is anonymized. A value of <code>TRUE</code> means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of <code>FALSE</code> means the output won't be anonymized and you can relate the data that comes back from the provider to your source data. </p>" 1205 }, 1206 "providerConfigurationDefinition":{ 1207 "shape":"Document", 1208 "documentation":"<p>The definition of the provider configuration.</p>" 1209 }, 1210 "providerEndpointConfiguration":{ 1211 "shape":"ProviderEndpointConfiguration", 1212 "documentation":"<p>The required configuration fields to use with the provider service.</p>" 1213 }, 1214 "providerEntityOutputDefinition":{ 1215 "shape":"Document", 1216 "documentation":"<p>The definition of the provider entity output.</p>" 1217 }, 1218 "providerIntermediateDataAccessConfiguration":{ 1219 "shape":"ProviderIntermediateDataAccessConfiguration", 1220 "documentation":"<p>The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.</p>" 1221 }, 1222 "providerName":{ 1223 "shape":"EntityName", 1224 "documentation":"<p>The name of the provider. This name is typically the company name.</p>" 1225 }, 1226 "providerServiceArn":{ 1227 "shape":"ProviderServiceArn", 1228 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.</p>" 1229 }, 1230 "providerServiceDisplayName":{ 1231 "shape":"ProviderServiceDisplayName", 1232 "documentation":"<p>The display name of the provider service.</p>" 1233 }, 1234 "providerServiceName":{ 1235 "shape":"EntityName", 1236 "documentation":"<p>The name of the product that the provider service provides. </p>" 1237 }, 1238 "providerServiceType":{ 1239 "shape":"ServiceType", 1240 "documentation":"<p>The type of provider service.</p>" 1241 } 1242 } 1243 }, 1244 "GetSchemaMappingInput":{ 1245 "type":"structure", 1246 "required":["schemaName"], 1247 "members":{ 1248 "schemaName":{ 1249 "shape":"EntityName", 1250 "documentation":"<p>The name of the schema to be retrieved.</p>", 1251 "location":"uri", 1252 "locationName":"schemaName" 1253 } 1254 } 1255 }, 1256 "GetSchemaMappingOutput":{ 1257 "type":"structure", 1258 "required":[ 1259 "createdAt", 1260 "hasWorkflows", 1261 "mappedInputFields", 1262 "schemaArn", 1263 "schemaName", 1264 "updatedAt" 1265 ], 1266 "members":{ 1267 "createdAt":{ 1268 "shape":"Timestamp", 1269 "documentation":"<p>The timestamp of when the <code>SchemaMapping</code> was created.</p>" 1270 }, 1271 "description":{ 1272 "shape":"Description", 1273 "documentation":"<p>A description of the schema.</p>" 1274 }, 1275 "hasWorkflows":{ 1276 "shape":"Boolean", 1277 "documentation":"<p>Specifies whether the schema mapping has been applied to a workflow.</p>" 1278 }, 1279 "mappedInputFields":{ 1280 "shape":"SchemaInputAttributes", 1281 "documentation":"<p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.</p>" 1282 }, 1283 "schemaArn":{ 1284 "shape":"SchemaMappingArn", 1285 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.</p>" 1286 }, 1287 "schemaName":{ 1288 "shape":"EntityName", 1289 "documentation":"<p>The name of the schema.</p>" 1290 }, 1291 "tags":{ 1292 "shape":"TagMap", 1293 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 1294 }, 1295 "updatedAt":{ 1296 "shape":"Timestamp", 1297 "documentation":"<p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>" 1298 } 1299 } 1300 }, 1301 "IdMappingJobMetrics":{ 1302 "type":"structure", 1303 "members":{ 1304 "inputRecords":{ 1305 "shape":"Integer", 1306 "documentation":"<p>The total number of input records.</p>" 1307 }, 1308 "recordsNotProcessed":{ 1309 "shape":"Integer", 1310 "documentation":"<p>The total number of records that did not get processed.</p>" 1311 }, 1312 "totalRecordsProcessed":{ 1313 "shape":"Integer", 1314 "documentation":"<p>The total number of records processed.</p>" 1315 } 1316 }, 1317 "documentation":"<p>An object containing <code>InputRecords</code>, <code>TotalRecordsProcessed</code>, <code>MatchIDs</code>, and <code>RecordsNotProcessed</code>.</p>" 1318 }, 1319 "IdMappingTechniques":{ 1320 "type":"structure", 1321 "required":[ 1322 "idMappingType", 1323 "providerProperties" 1324 ], 1325 "members":{ 1326 "idMappingType":{ 1327 "shape":"IdMappingType", 1328 "documentation":"<p>The type of ID mapping.</p>" 1329 }, 1330 "providerProperties":{ 1331 "shape":"ProviderProperties", 1332 "documentation":"<p>An object which defines any additional configurations required by the provider service.</p>" 1333 } 1334 }, 1335 "documentation":"<p>An object which defines the ID mapping techniques and provider configurations.</p>" 1336 }, 1337 "IdMappingType":{ 1338 "type":"string", 1339 "enum":["PROVIDER"] 1340 }, 1341 "IdMappingWorkflowArn":{ 1342 "type":"string", 1343 "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$" 1344 }, 1345 "IdMappingWorkflowInputSource":{ 1346 "type":"structure", 1347 "required":[ 1348 "inputSourceARN", 1349 "schemaName" 1350 ], 1351 "members":{ 1352 "inputSourceARN":{ 1353 "shape":"IdMappingWorkflowInputSourceInputSourceARNString", 1354 "documentation":"<p>An Gluetable ARN for the input source table.</p>" 1355 }, 1356 "schemaName":{ 1357 "shape":"EntityName", 1358 "documentation":"<p>The name of the schema to be retrieved.</p>" 1359 } 1360 }, 1361 "documentation":"<p>An object containing <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 1362 }, 1363 "IdMappingWorkflowInputSourceConfig":{ 1364 "type":"list", 1365 "member":{"shape":"IdMappingWorkflowInputSource"}, 1366 "max":20, 1367 "min":1 1368 }, 1369 "IdMappingWorkflowInputSourceInputSourceARNString":{ 1370 "type":"string", 1371 "pattern":"^arn:aws:.*:.*:[0-9]+:.*$" 1372 }, 1373 "IdMappingWorkflowList":{ 1374 "type":"list", 1375 "member":{"shape":"IdMappingWorkflowSummary"} 1376 }, 1377 "IdMappingWorkflowOutputSource":{ 1378 "type":"structure", 1379 "required":["outputS3Path"], 1380 "members":{ 1381 "KMSArn":{ 1382 "shape":"KMSArn", 1383 "documentation":"<p>Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.</p>" 1384 }, 1385 "outputS3Path":{ 1386 "shape":"S3Path", 1387 "documentation":"<p>The S3 path to which Entity Resolution will write the output table.</p>" 1388 } 1389 }, 1390 "documentation":"<p>The output source for the ID mapping workflow.</p>" 1391 }, 1392 "IdMappingWorkflowOutputSourceConfig":{ 1393 "type":"list", 1394 "member":{"shape":"IdMappingWorkflowOutputSource"}, 1395 "max":1, 1396 "min":1 1397 }, 1398 "IdMappingWorkflowSummary":{ 1399 "type":"structure", 1400 "required":[ 1401 "createdAt", 1402 "updatedAt", 1403 "workflowArn", 1404 "workflowName" 1405 ], 1406 "members":{ 1407 "createdAt":{ 1408 "shape":"Timestamp", 1409 "documentation":"<p>The timestamp of when the workflow was created.</p>" 1410 }, 1411 "updatedAt":{ 1412 "shape":"Timestamp", 1413 "documentation":"<p>The timestamp of when the workflow was last updated.</p>" 1414 }, 1415 "workflowArn":{ 1416 "shape":"IdMappingWorkflowArn", 1417 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>IdMappingWorkflow</code>.</p>" 1418 }, 1419 "workflowName":{ 1420 "shape":"EntityName", 1421 "documentation":"<p>The name of the workflow.</p>" 1422 } 1423 }, 1424 "documentation":"<p>A list of <code>IdMappingWorkflowSummary</code> objects, each of which contain the fields <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, and <code>UpdatedAt</code>.</p>" 1425 }, 1426 "IncrementalRunConfig":{ 1427 "type":"structure", 1428 "members":{ 1429 "incrementalRunType":{ 1430 "shape":"IncrementalRunType", 1431 "documentation":"<p>The type of incremental run. It takes only one value: <code>IMMEDIATE</code>.</p>" 1432 } 1433 }, 1434 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 1435 }, 1436 "IncrementalRunType":{ 1437 "type":"string", 1438 "enum":["IMMEDIATE"] 1439 }, 1440 "InputSource":{ 1441 "type":"structure", 1442 "required":[ 1443 "inputSourceARN", 1444 "schemaName" 1445 ], 1446 "members":{ 1447 "applyNormalization":{ 1448 "shape":"Boolean", 1449 "documentation":"<p>Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.</p>" 1450 }, 1451 "inputSourceARN":{ 1452 "shape":"InputSourceInputSourceARNString", 1453 "documentation":"<p>An Glue table ARN for the input source table.</p>" 1454 }, 1455 "schemaName":{ 1456 "shape":"EntityName", 1457 "documentation":"<p>The name of the schema to be retrieved.</p>" 1458 } 1459 }, 1460 "documentation":"<p>An object containing <code>InputSourceARN</code>, <code>SchemaName</code>, and <code>ApplyNormalization</code>.</p>" 1461 }, 1462 "InputSourceConfig":{ 1463 "type":"list", 1464 "member":{"shape":"InputSource"}, 1465 "max":20, 1466 "min":1 1467 }, 1468 "InputSourceInputSourceARNString":{ 1469 "type":"string", 1470 "pattern":"^arn:aws:.*:.*:[0-9]+:.*$" 1471 }, 1472 "Integer":{ 1473 "type":"integer", 1474 "box":true 1475 }, 1476 "IntermediateSourceConfiguration":{ 1477 "type":"structure", 1478 "required":["intermediateS3Path"], 1479 "members":{ 1480 "intermediateS3Path":{ 1481 "shape":"S3Path", 1482 "documentation":"<p>The Amazon S3 location (bucket and prefix). For example: <code>s3://provider_bucket/DOC-EXAMPLE-BUCKET</code> </p>" 1483 } 1484 }, 1485 "documentation":"<p>The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.</p>" 1486 }, 1487 "InternalServerException":{ 1488 "type":"structure", 1489 "members":{ 1490 "message":{"shape":"ErrorMessage"} 1491 }, 1492 "documentation":"<p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code> </p>", 1493 "error":{"httpStatusCode":500}, 1494 "exception":true, 1495 "fault":true, 1496 "retryable":{"throttling":false} 1497 }, 1498 "JobId":{ 1499 "type":"string", 1500 "pattern":"^[a-f0-9]{32}$" 1501 }, 1502 "JobList":{ 1503 "type":"list", 1504 "member":{"shape":"JobSummary"} 1505 }, 1506 "JobMetrics":{ 1507 "type":"structure", 1508 "members":{ 1509 "inputRecords":{ 1510 "shape":"Integer", 1511 "documentation":"<p>The total number of input records.</p>" 1512 }, 1513 "matchIDs":{ 1514 "shape":"Integer", 1515 "documentation":"<p>The total number of <code>matchID</code>s generated.</p>" 1516 }, 1517 "recordsNotProcessed":{ 1518 "shape":"Integer", 1519 "documentation":"<p>The total number of records that did not get processed.</p>" 1520 }, 1521 "totalRecordsProcessed":{ 1522 "shape":"Integer", 1523 "documentation":"<p>The total number of records processed.</p>" 1524 } 1525 }, 1526 "documentation":"<p>An object containing <code>InputRecords</code>, <code>TotalRecordsProcessed</code>, <code>MatchIDs</code>, and <code>RecordsNotProcessed</code>.</p>" 1527 }, 1528 "JobStatus":{ 1529 "type":"string", 1530 "enum":[ 1531 "RUNNING", 1532 "SUCCEEDED", 1533 "FAILED", 1534 "QUEUED" 1535 ] 1536 }, 1537 "JobSummary":{ 1538 "type":"structure", 1539 "required":[ 1540 "jobId", 1541 "startTime", 1542 "status" 1543 ], 1544 "members":{ 1545 "endTime":{ 1546 "shape":"Timestamp", 1547 "documentation":"<p>The time at which the job has finished.</p>" 1548 }, 1549 "jobId":{ 1550 "shape":"JobId", 1551 "documentation":"<p>The ID of the job.</p>" 1552 }, 1553 "startTime":{ 1554 "shape":"Timestamp", 1555 "documentation":"<p>The time at which the job was started.</p>" 1556 }, 1557 "status":{ 1558 "shape":"JobStatus", 1559 "documentation":"<p>The current status of the job.</p>" 1560 } 1561 }, 1562 "documentation":"<p>An object containing the <code>JobId</code>, <code>Status</code>, <code>StartTime</code>, and <code>EndTime</code> of a job.</p>" 1563 }, 1564 "KMSArn":{ 1565 "type":"string", 1566 "pattern":"^arn:aws:kms:.*:[0-9]+:.*$" 1567 }, 1568 "ListIdMappingJobsInput":{ 1569 "type":"structure", 1570 "required":["workflowName"], 1571 "members":{ 1572 "maxResults":{ 1573 "shape":"ListIdMappingJobsInputMaxResultsInteger", 1574 "documentation":"<p>The maximum number of objects returned per page.</p>", 1575 "location":"querystring", 1576 "locationName":"maxResults" 1577 }, 1578 "nextToken":{ 1579 "shape":"NextToken", 1580 "documentation":"<p>The pagination token from the previous API call.</p>", 1581 "location":"querystring", 1582 "locationName":"nextToken" 1583 }, 1584 "workflowName":{ 1585 "shape":"EntityName", 1586 "documentation":"<p>The name of the workflow to be retrieved.</p>", 1587 "location":"uri", 1588 "locationName":"workflowName" 1589 } 1590 } 1591 }, 1592 "ListIdMappingJobsInputMaxResultsInteger":{ 1593 "type":"integer", 1594 "box":true, 1595 "max":25, 1596 "min":1 1597 }, 1598 "ListIdMappingJobsOutput":{ 1599 "type":"structure", 1600 "members":{ 1601 "jobs":{ 1602 "shape":"JobList", 1603 "documentation":"<p>A list of <code>JobSummary</code> objects.</p>" 1604 }, 1605 "nextToken":{ 1606 "shape":"NextToken", 1607 "documentation":"<p>The pagination token from the previous API call.</p>" 1608 } 1609 } 1610 }, 1611 "ListIdMappingWorkflowsInput":{ 1612 "type":"structure", 1613 "members":{ 1614 "maxResults":{ 1615 "shape":"ListIdMappingWorkflowsInputMaxResultsInteger", 1616 "documentation":"<p>The maximum number of objects returned per page.</p>", 1617 "location":"querystring", 1618 "locationName":"maxResults" 1619 }, 1620 "nextToken":{ 1621 "shape":"NextToken", 1622 "documentation":"<p>The pagination token from the previous API call.</p>", 1623 "location":"querystring", 1624 "locationName":"nextToken" 1625 } 1626 } 1627 }, 1628 "ListIdMappingWorkflowsInputMaxResultsInteger":{ 1629 "type":"integer", 1630 "box":true, 1631 "max":25 1632 }, 1633 "ListIdMappingWorkflowsOutput":{ 1634 "type":"structure", 1635 "members":{ 1636 "nextToken":{ 1637 "shape":"NextToken", 1638 "documentation":"<p>The pagination token from the previous API call.</p>" 1639 }, 1640 "workflowSummaries":{ 1641 "shape":"IdMappingWorkflowList", 1642 "documentation":"<p>A list of <code>IdMappingWorkflowSummary</code> objects.</p>" 1643 } 1644 } 1645 }, 1646 "ListMatchingJobsInput":{ 1647 "type":"structure", 1648 "required":["workflowName"], 1649 "members":{ 1650 "maxResults":{ 1651 "shape":"ListMatchingJobsInputMaxResultsInteger", 1652 "documentation":"<p>The maximum number of objects returned per page.</p>", 1653 "location":"querystring", 1654 "locationName":"maxResults" 1655 }, 1656 "nextToken":{ 1657 "shape":"NextToken", 1658 "documentation":"<p>The pagination token from the previous API call.</p>", 1659 "location":"querystring", 1660 "locationName":"nextToken" 1661 }, 1662 "workflowName":{ 1663 "shape":"EntityName", 1664 "documentation":"<p>The name of the workflow to be retrieved.</p>", 1665 "location":"uri", 1666 "locationName":"workflowName" 1667 } 1668 } 1669 }, 1670 "ListMatchingJobsInputMaxResultsInteger":{ 1671 "type":"integer", 1672 "box":true, 1673 "max":25, 1674 "min":1 1675 }, 1676 "ListMatchingJobsOutput":{ 1677 "type":"structure", 1678 "members":{ 1679 "jobs":{ 1680 "shape":"JobList", 1681 "documentation":"<p>A list of <code>JobSummary</code> objects, each of which contain the ID, status, start time, and end time of a job.</p>" 1682 }, 1683 "nextToken":{ 1684 "shape":"NextToken", 1685 "documentation":"<p>The pagination token from the previous API call.</p>" 1686 } 1687 } 1688 }, 1689 "ListMatchingWorkflowsInput":{ 1690 "type":"structure", 1691 "members":{ 1692 "maxResults":{ 1693 "shape":"ListMatchingWorkflowsInputMaxResultsInteger", 1694 "documentation":"<p>The maximum number of objects returned per page.</p>", 1695 "location":"querystring", 1696 "locationName":"maxResults" 1697 }, 1698 "nextToken":{ 1699 "shape":"NextToken", 1700 "documentation":"<p>The pagination token from the previous API call.</p>", 1701 "location":"querystring", 1702 "locationName":"nextToken" 1703 } 1704 } 1705 }, 1706 "ListMatchingWorkflowsInputMaxResultsInteger":{ 1707 "type":"integer", 1708 "box":true, 1709 "max":25 1710 }, 1711 "ListMatchingWorkflowsOutput":{ 1712 "type":"structure", 1713 "members":{ 1714 "nextToken":{ 1715 "shape":"NextToken", 1716 "documentation":"<p>The pagination token from the previous API call.</p>" 1717 }, 1718 "workflowSummaries":{ 1719 "shape":"MatchingWorkflowList", 1720 "documentation":"<p>A list of <code>MatchingWorkflowSummary</code> objects, each of which contain the fields <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, and <code>UpdatedAt</code>.</p>" 1721 } 1722 } 1723 }, 1724 "ListProviderServicesInput":{ 1725 "type":"structure", 1726 "members":{ 1727 "maxResults":{ 1728 "shape":"ListProviderServicesInputMaxResultsInteger", 1729 "documentation":"<p>The maximum number of objects returned per page.</p>", 1730 "location":"querystring", 1731 "locationName":"maxResults" 1732 }, 1733 "nextToken":{ 1734 "shape":"NextToken", 1735 "documentation":"<p>The pagination token from the previous API call.</p>", 1736 "location":"querystring", 1737 "locationName":"nextToken" 1738 }, 1739 "providerName":{ 1740 "shape":"EntityName", 1741 "documentation":"<p>The name of the provider. This name is typically the company name.</p>", 1742 "location":"querystring", 1743 "locationName":"providerName" 1744 } 1745 } 1746 }, 1747 "ListProviderServicesInputMaxResultsInteger":{ 1748 "type":"integer", 1749 "box":true, 1750 "max":25, 1751 "min":15 1752 }, 1753 "ListProviderServicesOutput":{ 1754 "type":"structure", 1755 "members":{ 1756 "nextToken":{ 1757 "shape":"NextToken", 1758 "documentation":"<p>The pagination token from the previous API call.</p>" 1759 }, 1760 "providerServiceSummaries":{ 1761 "shape":"ProviderServiceList", 1762 "documentation":"<p>A list of <code>ProviderServices</code> objects.</p>" 1763 } 1764 } 1765 }, 1766 "ListSchemaMappingsInput":{ 1767 "type":"structure", 1768 "members":{ 1769 "maxResults":{ 1770 "shape":"ListSchemaMappingsInputMaxResultsInteger", 1771 "documentation":"<p>The maximum number of objects returned per page.</p>", 1772 "location":"querystring", 1773 "locationName":"maxResults" 1774 }, 1775 "nextToken":{ 1776 "shape":"NextToken", 1777 "documentation":"<p>The pagination token from the previous API call.</p>", 1778 "location":"querystring", 1779 "locationName":"nextToken" 1780 } 1781 } 1782 }, 1783 "ListSchemaMappingsInputMaxResultsInteger":{ 1784 "type":"integer", 1785 "box":true, 1786 "max":25 1787 }, 1788 "ListSchemaMappingsOutput":{ 1789 "type":"structure", 1790 "members":{ 1791 "nextToken":{ 1792 "shape":"NextToken", 1793 "documentation":"<p>The pagination token from the previous API call.</p>" 1794 }, 1795 "schemaList":{ 1796 "shape":"SchemaMappingList", 1797 "documentation":"<p>A list of <code>SchemaMappingSummary</code> objects, each of which contain the fields <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.</p>" 1798 } 1799 } 1800 }, 1801 "ListTagsForResourceInput":{ 1802 "type":"structure", 1803 "required":["resourceArn"], 1804 "members":{ 1805 "resourceArn":{ 1806 "shape":"VeniceGlobalArn", 1807 "documentation":"<p>The ARN of the resource for which you want to view tags.</p>", 1808 "location":"uri", 1809 "locationName":"resourceArn" 1810 } 1811 } 1812 }, 1813 "ListTagsForResourceOutput":{ 1814 "type":"structure", 1815 "required":["tags"], 1816 "members":{ 1817 "tags":{ 1818 "shape":"TagMap", 1819 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 1820 } 1821 } 1822 }, 1823 "MatchingWorkflowArn":{ 1824 "type":"string", 1825 "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$" 1826 }, 1827 "MatchingWorkflowList":{ 1828 "type":"list", 1829 "member":{"shape":"MatchingWorkflowSummary"} 1830 }, 1831 "MatchingWorkflowSummary":{ 1832 "type":"structure", 1833 "required":[ 1834 "createdAt", 1835 "resolutionType", 1836 "updatedAt", 1837 "workflowArn", 1838 "workflowName" 1839 ], 1840 "members":{ 1841 "createdAt":{ 1842 "shape":"Timestamp", 1843 "documentation":"<p>The timestamp of when the workflow was created.</p>" 1844 }, 1845 "resolutionType":{ 1846 "shape":"ResolutionType", 1847 "documentation":"<p>The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service.</p>" 1848 }, 1849 "updatedAt":{ 1850 "shape":"Timestamp", 1851 "documentation":"<p>The timestamp of when the workflow was last updated.</p>" 1852 }, 1853 "workflowArn":{ 1854 "shape":"MatchingWorkflowArn", 1855 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>" 1856 }, 1857 "workflowName":{ 1858 "shape":"EntityName", 1859 "documentation":"<p>The name of the workflow.</p>" 1860 } 1861 }, 1862 "documentation":"<p>A list of <code>MatchingWorkflowSummary</code> objects, each of which contain the fields <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.</p>" 1863 }, 1864 "NextToken":{ 1865 "type":"string", 1866 "max":1024, 1867 "min":1, 1868 "pattern":"^[a-zA-Z_0-9-=+/]*$" 1869 }, 1870 "OutputAttribute":{ 1871 "type":"structure", 1872 "required":["name"], 1873 "members":{ 1874 "hashed":{ 1875 "shape":"Boolean", 1876 "documentation":"<p>Enables the ability to hash the column values in the output.</p>" 1877 }, 1878 "name":{ 1879 "shape":"AttributeName", 1880 "documentation":"<p>A name of a column to be written to the output. This must be an <code>InputField</code> name in the schema mapping.</p>" 1881 } 1882 }, 1883 "documentation":"<p>A list of <code>OutputAttribute</code> objects, each of which have the fields <code>Name</code> and <code>Hashed</code>. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.</p>" 1884 }, 1885 "OutputSource":{ 1886 "type":"structure", 1887 "required":[ 1888 "output", 1889 "outputS3Path" 1890 ], 1891 "members":{ 1892 "KMSArn":{ 1893 "shape":"KMSArn", 1894 "documentation":"<p>Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.</p>" 1895 }, 1896 "applyNormalization":{ 1897 "shape":"Boolean", 1898 "documentation":"<p>Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.</p>" 1899 }, 1900 "output":{ 1901 "shape":"OutputSourceOutputList", 1902 "documentation":"<p>A list of <code>OutputAttribute</code> objects, each of which have the fields <code>Name</code> and <code>Hashed</code>. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.</p>" 1903 }, 1904 "outputS3Path":{ 1905 "shape":"S3Path", 1906 "documentation":"<p>The S3 path to which Entity Resolution will write the output table.</p>" 1907 } 1908 }, 1909 "documentation":"<p>A list of <code>OutputAttribute</code> objects, each of which have the fields <code>Name</code> and <code>Hashed</code>. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.</p>" 1910 }, 1911 "OutputSourceConfig":{ 1912 "type":"list", 1913 "member":{"shape":"OutputSource"}, 1914 "max":1, 1915 "min":1 1916 }, 1917 "OutputSourceOutputList":{ 1918 "type":"list", 1919 "member":{"shape":"OutputAttribute"}, 1920 "max":750, 1921 "min":0 1922 }, 1923 "ProviderEndpointConfiguration":{ 1924 "type":"structure", 1925 "members":{ 1926 "marketplaceConfiguration":{ 1927 "shape":"ProviderMarketplaceConfiguration", 1928 "documentation":"<p>The identifiers of the provider service, from Data Exchange.</p>" 1929 } 1930 }, 1931 "documentation":"<p>The required configuration fields to use with the provider service.</p>", 1932 "union":true 1933 }, 1934 "ProviderIntermediateDataAccessConfiguration":{ 1935 "type":"structure", 1936 "members":{ 1937 "awsAccountIds":{ 1938 "shape":"AwsAccountIdList", 1939 "documentation":"<p>The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.</p>" 1940 }, 1941 "requiredBucketActions":{ 1942 "shape":"RequiredBucketActionsList", 1943 "documentation":"<p>The S3 bucket actions that the provider requires permission for.</p>" 1944 } 1945 }, 1946 "documentation":"<p>The required configuration fields to give intermediate access to a provider service.</p>" 1947 }, 1948 "ProviderMarketplaceConfiguration":{ 1949 "type":"structure", 1950 "required":[ 1951 "assetId", 1952 "dataSetId", 1953 "listingId", 1954 "revisionId" 1955 ], 1956 "members":{ 1957 "assetId":{ 1958 "shape":"String", 1959 "documentation":"<p>The asset ID on Data Exchange.</p>" 1960 }, 1961 "dataSetId":{ 1962 "shape":"String", 1963 "documentation":"<p>The dataset ID on Data Exchange.</p>" 1964 }, 1965 "listingId":{ 1966 "shape":"String", 1967 "documentation":"<p>The listing ID on Data Exchange.</p>" 1968 }, 1969 "revisionId":{ 1970 "shape":"String", 1971 "documentation":"<p>The revision ID on Data Exchange.</p>" 1972 } 1973 }, 1974 "documentation":"<p>The identifiers of the provider service, from Data Exchange.</p>" 1975 }, 1976 "ProviderProperties":{ 1977 "type":"structure", 1978 "required":["providerServiceArn"], 1979 "members":{ 1980 "intermediateSourceConfiguration":{ 1981 "shape":"IntermediateSourceConfiguration", 1982 "documentation":"<p>The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.</p>" 1983 }, 1984 "providerConfiguration":{ 1985 "shape":"Document", 1986 "documentation":"<p>The required configuration fields to use with the provider service.</p>" 1987 }, 1988 "providerServiceArn":{ 1989 "shape":"ProviderServiceArn", 1990 "documentation":"<p>The ARN of the provider service.</p>" 1991 } 1992 }, 1993 "documentation":"<p>An object containing the <code>providerServiceARN</code>, <code>intermediateSourceConfiguration</code>, and <code>providerConfiguration</code>.</p>" 1994 }, 1995 "ProviderServiceArn":{ 1996 "type":"string", 1997 "max":255, 1998 "min":20, 1999 "pattern":"^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z-]+?-[0-9])::providerservice/([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)$" 2000 }, 2001 "ProviderServiceDisplayName":{ 2002 "type":"string", 2003 "max":255, 2004 "min":0 2005 }, 2006 "ProviderServiceList":{ 2007 "type":"list", 2008 "member":{"shape":"ProviderServiceSummary"} 2009 }, 2010 "ProviderServiceSummary":{ 2011 "type":"structure", 2012 "required":[ 2013 "providerName", 2014 "providerServiceArn", 2015 "providerServiceDisplayName", 2016 "providerServiceName", 2017 "providerServiceType" 2018 ], 2019 "members":{ 2020 "providerName":{ 2021 "shape":"EntityName", 2022 "documentation":"<p>The name of the provider. This name is typically the company name.</p>" 2023 }, 2024 "providerServiceArn":{ 2025 "shape":"ProviderServiceArn", 2026 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>providerService</code>.</p>" 2027 }, 2028 "providerServiceDisplayName":{ 2029 "shape":"ProviderServiceDisplayName", 2030 "documentation":"<p>The display name of the provider service.</p>" 2031 }, 2032 "providerServiceName":{ 2033 "shape":"EntityName", 2034 "documentation":"<p>The name of the product that the provider service provides.</p>" 2035 }, 2036 "providerServiceType":{ 2037 "shape":"ServiceType", 2038 "documentation":"<p>The type of provider service.</p>" 2039 } 2040 }, 2041 "documentation":"<p>A list of <code>ProviderService</code> objects, each of which contain the fields <code>providerName</code>, <code>providerServiceArn</code>, <code>providerServiceName</code>, and <code>providerServiceType</code>.</p>" 2042 }, 2043 "RecordAttributeMap":{ 2044 "type":"map", 2045 "key":{"shape":"RecordAttributeMapKeyString"}, 2046 "value":{"shape":"RecordAttributeMapValueString"}, 2047 "sensitive":true 2048 }, 2049 "RecordAttributeMapKeyString":{ 2050 "type":"string", 2051 "max":255, 2052 "min":0, 2053 "pattern":"^[a-zA-Z_0-9- \\t]*$" 2054 }, 2055 "RecordAttributeMapValueString":{ 2056 "type":"string", 2057 "max":255, 2058 "min":0, 2059 "pattern":"^[a-zA-Z_0-9-.@ ()+\\t]*$" 2060 }, 2061 "RequiredBucketActionsList":{ 2062 "type":"list", 2063 "member":{"shape":"String"} 2064 }, 2065 "ResolutionTechniques":{ 2066 "type":"structure", 2067 "required":["resolutionType"], 2068 "members":{ 2069 "providerProperties":{ 2070 "shape":"ProviderProperties", 2071 "documentation":"<p>The properties of the provider service.</p>" 2072 }, 2073 "resolutionType":{ 2074 "shape":"ResolutionType", 2075 "documentation":"<p>The type of matching. There are two types of matching: <code>RULE_MATCHING</code> and <code>ML_MATCHING</code>.</p>" 2076 }, 2077 "ruleBasedProperties":{ 2078 "shape":"RuleBasedProperties", 2079 "documentation":"<p>An object which defines the list of matching rules to run and has a field <code>Rules</code>, which is a list of rule objects.</p>" 2080 } 2081 }, 2082 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>.</p>" 2083 }, 2084 "ResolutionType":{ 2085 "type":"string", 2086 "enum":[ 2087 "RULE_MATCHING", 2088 "ML_MATCHING", 2089 "PROVIDER" 2090 ] 2091 }, 2092 "ResourceNotFoundException":{ 2093 "type":"structure", 2094 "members":{ 2095 "message":{"shape":"ErrorMessage"} 2096 }, 2097 "documentation":"<p>The resource could not be found. <code>HTTP Status Code: 404</code> </p>", 2098 "error":{ 2099 "httpStatusCode":404, 2100 "senderFault":true 2101 }, 2102 "exception":true 2103 }, 2104 "RoleArn":{ 2105 "type":"string", 2106 "pattern":"^arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" 2107 }, 2108 "Rule":{ 2109 "type":"structure", 2110 "required":[ 2111 "matchingKeys", 2112 "ruleName" 2113 ], 2114 "members":{ 2115 "matchingKeys":{ 2116 "shape":"RuleMatchingKeysList", 2117 "documentation":"<p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been defined in the <code>SchemaMapping</code>. Two records are considered to match according to this rule if all of the <code>MatchingKeys</code> match.</p>" 2118 }, 2119 "ruleName":{ 2120 "shape":"RuleRuleNameString", 2121 "documentation":"<p>A name for the matching rule.</p>" 2122 } 2123 }, 2124 "documentation":"<p>An object containing <code>RuleName</code>, and <code>MatchingKeys</code>.</p>" 2125 }, 2126 "RuleBasedProperties":{ 2127 "type":"structure", 2128 "required":[ 2129 "attributeMatchingModel", 2130 "rules" 2131 ], 2132 "members":{ 2133 "attributeMatchingModel":{ 2134 "shape":"AttributeMatchingModel", 2135 "documentation":"<p>The comparison type. You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When choosing <code>MANY_TO_MANY</code>, the system can match attributes across the sub-types of an attribute type. For example, if the value of the <code>Email</code> field of Profile A and the value of <code>BusinessEmail</code> field of Profile B matches, the two profiles are matched on the <code>Email</code> type. When choosing <code>ONE_TO_ONE</code> ,the system can only match if the sub-types are exact matches. For example, only when the value of the <code>Email</code> field of Profile A and the value of the <code>Email</code> field of Profile B matches, the two profiles are matched on the <code>Email</code> type.</p>" 2136 }, 2137 "rules":{ 2138 "shape":"RuleBasedPropertiesRulesList", 2139 "documentation":"<p>A list of <code>Rule</code> objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.</p>" 2140 } 2141 }, 2142 "documentation":"<p>An object which defines the list of matching rules to run and has a field <code>Rules</code>, which is a list of rule objects.</p>" 2143 }, 2144 "RuleBasedPropertiesRulesList":{ 2145 "type":"list", 2146 "member":{"shape":"Rule"}, 2147 "max":15, 2148 "min":1 2149 }, 2150 "RuleMatchingKeysList":{ 2151 "type":"list", 2152 "member":{"shape":"AttributeName"}, 2153 "max":15, 2154 "min":1 2155 }, 2156 "RuleRuleNameString":{ 2157 "type":"string", 2158 "max":255, 2159 "min":0, 2160 "pattern":"^[a-zA-Z_0-9- \\t]*$" 2161 }, 2162 "S3Path":{ 2163 "type":"string", 2164 "max":1024, 2165 "min":1, 2166 "pattern":"^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" 2167 }, 2168 "SchemaAttributeType":{ 2169 "type":"string", 2170 "enum":[ 2171 "NAME", 2172 "NAME_FIRST", 2173 "NAME_MIDDLE", 2174 "NAME_LAST", 2175 "ADDRESS", 2176 "ADDRESS_STREET1", 2177 "ADDRESS_STREET2", 2178 "ADDRESS_STREET3", 2179 "ADDRESS_CITY", 2180 "ADDRESS_STATE", 2181 "ADDRESS_COUNTRY", 2182 "ADDRESS_POSTALCODE", 2183 "PHONE", 2184 "PHONE_NUMBER", 2185 "PHONE_COUNTRYCODE", 2186 "EMAIL_ADDRESS", 2187 "UNIQUE_ID", 2188 "DATE", 2189 "STRING", 2190 "PROVIDER_ID" 2191 ] 2192 }, 2193 "SchemaInputAttribute":{ 2194 "type":"structure", 2195 "required":[ 2196 "fieldName", 2197 "type" 2198 ], 2199 "members":{ 2200 "fieldName":{ 2201 "shape":"AttributeName", 2202 "documentation":"<p>A string containing the field name.</p>" 2203 }, 2204 "groupName":{ 2205 "shape":"AttributeName", 2206 "documentation":"<p>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 <code>GroupName</code> will prompt Entity Resolution to concatenate them into a single value.</p>" 2207 }, 2208 "matchKey":{ 2209 "shape":"AttributeName", 2210 "documentation":"<p>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 <code>business_address</code> and <code>shipping_address</code>. By assigning the <code>MatchKey</code> <i>Address</i> to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group. If no <code>MatchKey</code> is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.</p>" 2211 }, 2212 "subType":{ 2213 "shape":"AttributeName", 2214 "documentation":"<p>The subtype of the attribute, selected from a list of values.</p>" 2215 }, 2216 "type":{ 2217 "shape":"SchemaAttributeType", 2218 "documentation":"<p>The type of the attribute, selected from a list of values.</p>" 2219 } 2220 }, 2221 "documentation":"<p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>, and <code>MatchKey</code>.</p>" 2222 }, 2223 "SchemaInputAttributes":{ 2224 "type":"list", 2225 "member":{"shape":"SchemaInputAttribute"}, 2226 "max":25, 2227 "min":2 2228 }, 2229 "SchemaMappingArn":{ 2230 "type":"string", 2231 "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$" 2232 }, 2233 "SchemaMappingList":{ 2234 "type":"list", 2235 "member":{"shape":"SchemaMappingSummary"} 2236 }, 2237 "SchemaMappingSummary":{ 2238 "type":"structure", 2239 "required":[ 2240 "createdAt", 2241 "hasWorkflows", 2242 "schemaArn", 2243 "schemaName", 2244 "updatedAt" 2245 ], 2246 "members":{ 2247 "createdAt":{ 2248 "shape":"Timestamp", 2249 "documentation":"<p>The timestamp of when the <code>SchemaMapping</code> was created.</p>" 2250 }, 2251 "hasWorkflows":{ 2252 "shape":"Boolean", 2253 "documentation":"<p>Specifies whether the schema mapping has been applied to a workflow.</p>" 2254 }, 2255 "schemaArn":{ 2256 "shape":"SchemaMappingArn", 2257 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>SchemaMapping</code>.</p>" 2258 }, 2259 "schemaName":{ 2260 "shape":"EntityName", 2261 "documentation":"<p>The name of the schema.</p>" 2262 }, 2263 "updatedAt":{ 2264 "shape":"Timestamp", 2265 "documentation":"<p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>" 2266 } 2267 }, 2268 "documentation":"<p>An object containing <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, and<code>UpdatedAt</code>.</p>" 2269 }, 2270 "ServiceType":{ 2271 "type":"string", 2272 "enum":[ 2273 "ASSIGNMENT", 2274 "ID_MAPPING" 2275 ] 2276 }, 2277 "StartIdMappingJobInput":{ 2278 "type":"structure", 2279 "required":["workflowName"], 2280 "members":{ 2281 "workflowName":{ 2282 "shape":"EntityName", 2283 "documentation":"<p>The name of the ID mapping job to be retrieved.</p>", 2284 "location":"uri", 2285 "locationName":"workflowName" 2286 } 2287 } 2288 }, 2289 "StartIdMappingJobOutput":{ 2290 "type":"structure", 2291 "required":["jobId"], 2292 "members":{ 2293 "jobId":{ 2294 "shape":"JobId", 2295 "documentation":"<p>The ID of the job.</p>" 2296 } 2297 } 2298 }, 2299 "StartMatchingJobInput":{ 2300 "type":"structure", 2301 "required":["workflowName"], 2302 "members":{ 2303 "workflowName":{ 2304 "shape":"EntityName", 2305 "documentation":"<p>The name of the matching job to be retrieved.</p>", 2306 "location":"uri", 2307 "locationName":"workflowName" 2308 } 2309 } 2310 }, 2311 "StartMatchingJobOutput":{ 2312 "type":"structure", 2313 "required":["jobId"], 2314 "members":{ 2315 "jobId":{ 2316 "shape":"JobId", 2317 "documentation":"<p>The ID of the job.</p>" 2318 } 2319 } 2320 }, 2321 "String":{"type":"string"}, 2322 "TagKey":{ 2323 "type":"string", 2324 "max":128, 2325 "min":1 2326 }, 2327 "TagKeyList":{ 2328 "type":"list", 2329 "member":{"shape":"TagKey"}, 2330 "max":200, 2331 "min":0 2332 }, 2333 "TagMap":{ 2334 "type":"map", 2335 "key":{"shape":"TagKey"}, 2336 "value":{"shape":"TagValue"}, 2337 "max":200, 2338 "min":0 2339 }, 2340 "TagResourceInput":{ 2341 "type":"structure", 2342 "required":[ 2343 "resourceArn", 2344 "tags" 2345 ], 2346 "members":{ 2347 "resourceArn":{ 2348 "shape":"VeniceGlobalArn", 2349 "documentation":"<p>The ARN of the resource for which you want to view tags.</p>", 2350 "location":"uri", 2351 "locationName":"resourceArn" 2352 }, 2353 "tags":{ 2354 "shape":"TagMap", 2355 "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" 2356 } 2357 } 2358 }, 2359 "TagResourceOutput":{ 2360 "type":"structure", 2361 "members":{ 2362 } 2363 }, 2364 "TagValue":{ 2365 "type":"string", 2366 "max":256, 2367 "min":0 2368 }, 2369 "ThrottlingException":{ 2370 "type":"structure", 2371 "members":{ 2372 "message":{"shape":"ErrorMessage"} 2373 }, 2374 "documentation":"<p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code> </p>", 2375 "error":{ 2376 "httpStatusCode":429, 2377 "senderFault":true 2378 }, 2379 "exception":true, 2380 "retryable":{"throttling":true} 2381 }, 2382 "Timestamp":{"type":"timestamp"}, 2383 "UntagResourceInput":{ 2384 "type":"structure", 2385 "required":[ 2386 "resourceArn", 2387 "tagKeys" 2388 ], 2389 "members":{ 2390 "resourceArn":{ 2391 "shape":"VeniceGlobalArn", 2392 "documentation":"<p>The ARN of the resource for which you want to untag.</p>", 2393 "location":"uri", 2394 "locationName":"resourceArn" 2395 }, 2396 "tagKeys":{ 2397 "shape":"TagKeyList", 2398 "documentation":"<p>The list of tag keys to remove from the resource.</p>", 2399 "location":"querystring", 2400 "locationName":"tagKeys" 2401 } 2402 } 2403 }, 2404 "UntagResourceOutput":{ 2405 "type":"structure", 2406 "members":{ 2407 } 2408 }, 2409 "UpdateIdMappingWorkflowInput":{ 2410 "type":"structure", 2411 "required":[ 2412 "idMappingTechniques", 2413 "inputSourceConfig", 2414 "outputSourceConfig", 2415 "roleArn", 2416 "workflowName" 2417 ], 2418 "members":{ 2419 "description":{ 2420 "shape":"Description", 2421 "documentation":"<p>A description of the workflow.</p>" 2422 }, 2423 "idMappingTechniques":{ 2424 "shape":"IdMappingTechniques", 2425 "documentation":"<p>An object which defines the <code>idMappingType</code> and the <code>providerProperties</code>.</p>" 2426 }, 2427 "inputSourceConfig":{ 2428 "shape":"IdMappingWorkflowInputSourceConfig", 2429 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 2430 }, 2431 "outputSourceConfig":{ 2432 "shape":"IdMappingWorkflowOutputSourceConfig", 2433 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code> and <code>KMSArn</code>.</p>" 2434 }, 2435 "roleArn":{ 2436 "shape":"RoleArn", 2437 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.</p>" 2438 }, 2439 "workflowName":{ 2440 "shape":"EntityName", 2441 "documentation":"<p>The name of the workflow.</p>", 2442 "location":"uri", 2443 "locationName":"workflowName" 2444 } 2445 } 2446 }, 2447 "UpdateIdMappingWorkflowOutput":{ 2448 "type":"structure", 2449 "required":[ 2450 "idMappingTechniques", 2451 "inputSourceConfig", 2452 "outputSourceConfig", 2453 "roleArn", 2454 "workflowArn", 2455 "workflowName" 2456 ], 2457 "members":{ 2458 "description":{ 2459 "shape":"Description", 2460 "documentation":"<p>A description of the workflow.</p>" 2461 }, 2462 "idMappingTechniques":{ 2463 "shape":"IdMappingTechniques", 2464 "documentation":"<p>An object which defines the <code>idMappingType</code> and the <code>providerProperties</code>.</p>" 2465 }, 2466 "inputSourceConfig":{ 2467 "shape":"IdMappingWorkflowInputSourceConfig", 2468 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 2469 }, 2470 "outputSourceConfig":{ 2471 "shape":"IdMappingWorkflowOutputSourceConfig", 2472 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code> and <code>KMSArn</code>.</p>" 2473 }, 2474 "roleArn":{ 2475 "shape":"RoleArn", 2476 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.</p>" 2477 }, 2478 "workflowArn":{ 2479 "shape":"IdMappingWorkflowArn", 2480 "documentation":"<p>The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access resources on your behalf.</p>" 2481 }, 2482 "workflowName":{ 2483 "shape":"EntityName", 2484 "documentation":"<p>The name of the workflow.</p>" 2485 } 2486 } 2487 }, 2488 "UpdateMatchingWorkflowInput":{ 2489 "type":"structure", 2490 "required":[ 2491 "inputSourceConfig", 2492 "outputSourceConfig", 2493 "resolutionTechniques", 2494 "roleArn", 2495 "workflowName" 2496 ], 2497 "members":{ 2498 "description":{ 2499 "shape":"Description", 2500 "documentation":"<p>A description of the workflow.</p>" 2501 }, 2502 "incrementalRunConfig":{ 2503 "shape":"IncrementalRunConfig", 2504 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 2505 }, 2506 "inputSourceConfig":{ 2507 "shape":"InputSourceConfig", 2508 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 2509 }, 2510 "outputSourceConfig":{ 2511 "shape":"OutputSourceConfig", 2512 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>, <code>ApplyNormalization</code>, and <code>Output</code>.</p>" 2513 }, 2514 "resolutionTechniques":{ 2515 "shape":"ResolutionTechniques", 2516 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>.</p>" 2517 }, 2518 "roleArn":{ 2519 "shape":"String", 2520 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 2521 }, 2522 "workflowName":{ 2523 "shape":"EntityName", 2524 "documentation":"<p>The name of the workflow to be retrieved.</p>", 2525 "location":"uri", 2526 "locationName":"workflowName" 2527 } 2528 } 2529 }, 2530 "UpdateMatchingWorkflowOutput":{ 2531 "type":"structure", 2532 "required":[ 2533 "inputSourceConfig", 2534 "outputSourceConfig", 2535 "resolutionTechniques", 2536 "roleArn", 2537 "workflowName" 2538 ], 2539 "members":{ 2540 "description":{ 2541 "shape":"Description", 2542 "documentation":"<p>A description of the workflow.</p>" 2543 }, 2544 "incrementalRunConfig":{ 2545 "shape":"IncrementalRunConfig", 2546 "documentation":"<p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>" 2547 }, 2548 "inputSourceConfig":{ 2549 "shape":"InputSourceConfig", 2550 "documentation":"<p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>" 2551 }, 2552 "outputSourceConfig":{ 2553 "shape":"OutputSourceConfig", 2554 "documentation":"<p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>, <code>ApplyNormalization</code>, and <code>Output</code>.</p>" 2555 }, 2556 "resolutionTechniques":{ 2557 "shape":"ResolutionTechniques", 2558 "documentation":"<p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code> </p>" 2559 }, 2560 "roleArn":{ 2561 "shape":"String", 2562 "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>" 2563 }, 2564 "workflowName":{ 2565 "shape":"EntityName", 2566 "documentation":"<p>The name of the workflow.</p>" 2567 } 2568 } 2569 }, 2570 "UpdateSchemaMappingInput":{ 2571 "type":"structure", 2572 "required":[ 2573 "mappedInputFields", 2574 "schemaName" 2575 ], 2576 "members":{ 2577 "description":{ 2578 "shape":"Description", 2579 "documentation":"<p>A description of the schema.</p>" 2580 }, 2581 "mappedInputFields":{ 2582 "shape":"SchemaInputAttributes", 2583 "documentation":"<p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.</p>" 2584 }, 2585 "schemaName":{ 2586 "shape":"EntityName", 2587 "documentation":"<p>The name of the schema. There can't be multiple <code>SchemaMappings</code> with the same name.</p>", 2588 "location":"uri", 2589 "locationName":"schemaName" 2590 } 2591 } 2592 }, 2593 "UpdateSchemaMappingOutput":{ 2594 "type":"structure", 2595 "required":[ 2596 "mappedInputFields", 2597 "schemaArn", 2598 "schemaName" 2599 ], 2600 "members":{ 2601 "description":{ 2602 "shape":"Description", 2603 "documentation":"<p>A description of the schema.</p>" 2604 }, 2605 "mappedInputFields":{ 2606 "shape":"SchemaInputAttributes", 2607 "documentation":"<p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.</p>" 2608 }, 2609 "schemaArn":{ 2610 "shape":"SchemaMappingArn", 2611 "documentation":"<p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>SchemaMapping</code>.</p>" 2612 }, 2613 "schemaName":{ 2614 "shape":"EntityName", 2615 "documentation":"<p>The name of the schema.</p>" 2616 } 2617 } 2618 }, 2619 "ValidationException":{ 2620 "type":"structure", 2621 "members":{ 2622 "message":{"shape":"ErrorMessage"} 2623 }, 2624 "documentation":"<p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code> </p>", 2625 "error":{ 2626 "httpStatusCode":400, 2627 "senderFault":true 2628 }, 2629 "exception":true 2630 }, 2631 "VeniceGlobalArn":{ 2632 "type":"string", 2633 "pattern":"^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow|idmappingworkflow)/[a-zA-Z0-9_-]+)$" 2634 } 2635 }, 2636 "documentation":"<p>Welcome to the <i>Entity Resolution API Reference</i>.</p> <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.</p> <p> With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, Entity Resolution can effectively match a source record from a customer relationship management (CRM) system with a source record from a marketing system containing campaign information.</p> <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the <a href=\"https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html\">Entity Resolution User Guide</a>.</p>" 2637} 2638