Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.
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.
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.
Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
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 MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.
Gets the status, metrics, and errors (if there are any) that are associated with a job.
" }, "GetIdMappingWorkflow":{ "name":"GetIdMappingWorkflow", "http":{ "method":"GET", "requestUri":"/idmappingworkflows/{workflowName}", "responseCode":200 }, "input":{"shape":"GetIdMappingWorkflowInput"}, "output":{"shape":"GetIdMappingWorkflowOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Returns the IdMappingWorkflow with a given name, if it exists.
Returns the corresponding Match ID of a customer record if the record has been processed.
" }, "GetMatchingJob":{ "name":"GetMatchingJob", "http":{ "method":"GET", "requestUri":"/matchingworkflows/{workflowName}/jobs/{jobId}", "responseCode":200 }, "input":{"shape":"GetMatchingJobInput"}, "output":{"shape":"GetMatchingJobOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Gets the status, metrics, and errors (if there are any) that are associated with a job.
" }, "GetMatchingWorkflow":{ "name":"GetMatchingWorkflow", "http":{ "method":"GET", "requestUri":"/matchingworkflows/{workflowName}", "responseCode":200 }, "input":{"shape":"GetMatchingWorkflowInput"}, "output":{"shape":"GetMatchingWorkflowOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Returns the MatchingWorkflow with a given name, if it exists.
Returns the ProviderService of a given name.
Returns the SchemaMapping of a given name.
" }, "ListIdMappingJobs":{ "name":"ListIdMappingJobs", "http":{ "method":"GET", "requestUri":"/idmappingworkflows/{workflowName}/jobs", "responseCode":200 }, "input":{"shape":"ListIdMappingJobsInput"}, "output":{"shape":"ListIdMappingJobsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Lists all ID mapping jobs for a given workflow.
" }, "ListIdMappingWorkflows":{ "name":"ListIdMappingWorkflows", "http":{ "method":"GET", "requestUri":"/idmappingworkflows", "responseCode":200 }, "input":{"shape":"ListIdMappingWorkflowsInput"}, "output":{"shape":"ListIdMappingWorkflowsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
Lists all jobs for a given workflow.
" }, "ListMatchingWorkflows":{ "name":"ListMatchingWorkflows", "http":{ "method":"GET", "requestUri":"/matchingworkflows", "responseCode":200 }, "input":{"shape":"ListMatchingWorkflowsInput"}, "output":{"shape":"ListMatchingWorkflowsOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
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, SchemaMapping and MatchingWorkflow 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 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.
Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.
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.
Updates a schema mapping.
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.
You do not have sufficient access to perform this action. HTTP Status Code: 403
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. HTTP Status Code: 400
A description of the workflow.
" }, "idMappingTechniques":{ "shape":"IdMappingTechniques", "documentation":"An object which defines the idMappingType and the providerProperties.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
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.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.
A description of the workflow.
" }, "idMappingTechniques":{ "shape":"IdMappingTechniques", "documentation":"An object which defines the idMappingType and the providerProperties.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
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.
" }, "workflowArn":{ "shape":"IdMappingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.
The name of the workflow.
" } } }, "CreateMatchingWorkflowInput":{ "type":"structure", "required":[ "inputSourceConfig", "outputSourceConfig", "resolutionTechniques", "roleArn", "workflowName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
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.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow. There can't be multiple MatchingWorkflows with the same name.
A description of the workflow.
" }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
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.
" }, "workflowArn":{ "shape":"MatchingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" } } }, "CreateSchemaMappingInput":{ "type":"structure", "required":[ "mappedInputFields", "schemaName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the schema.
" }, "mappedInputFields":{ "shape":"SchemaInputAttributes", "documentation":"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.
The name of the schema. There can't be multiple SchemaMappings with the same name.
The tags used to organize, track, or control access for this resource.
" } } }, "CreateSchemaMappingOutput":{ "type":"structure", "required":[ "description", "mappedInputFields", "schemaArn", "schemaName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the schema.
" }, "mappedInputFields":{ "shape":"SchemaInputAttributes", "documentation":"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.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" } } }, "DeleteIdMappingWorkflowInput":{ "type":"structure", "required":["workflowName"], "members":{ "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow to be deleted.
", "location":"uri", "locationName":"workflowName" } } }, "DeleteIdMappingWorkflowOutput":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"A successful operation message.
" } } }, "DeleteMatchingWorkflowInput":{ "type":"structure", "required":["workflowName"], "members":{ "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "DeleteMatchingWorkflowOutput":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"A successful operation message.
" } } }, "DeleteSchemaMappingInput":{ "type":"structure", "required":["schemaName"], "members":{ "schemaName":{ "shape":"EntityName", "documentation":"The name of the schema to delete.
", "location":"uri", "locationName":"schemaName" } } }, "DeleteSchemaMappingOutput":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"A successful operation message.
" } } }, "Description":{ "type":"string", "max":255, "min":0 }, "Document":{ "type":"structure", "members":{ }, "document":true }, "EntityName":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z_0-9-]*$" }, "ErrorDetails":{ "type":"structure", "members":{ "errorMessage":{ "shape":"ErrorMessage", "documentation":"The error message from the job, if there is one.
" } }, "documentation":"An object containing an error message, if there was an error.
" }, "ErrorMessage":{ "type":"string", "max":2048, "min":1 }, "ExceedsLimitException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "quotaName":{ "shape":"String", "documentation":"The name of the quota that has been breached.
" }, "quotaValue":{ "shape":"Integer", "documentation":"The current quota value for the customers.
" } }, "documentation":"The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
The ID of the job.
", "location":"uri", "locationName":"jobId" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "GetIdMappingJobOutput":{ "type":"structure", "required":[ "jobId", "startTime", "status" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"The time at which the job has finished.
" }, "errorDetails":{"shape":"ErrorDetails"}, "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
" }, "metrics":{ "shape":"IdMappingJobMetrics", "documentation":"Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time at which the job was started.
" }, "status":{ "shape":"JobStatus", "documentation":"The current status of the job.
" } } }, "GetIdMappingWorkflowInput":{ "type":"structure", "required":["workflowName"], "members":{ "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "GetIdMappingWorkflowOutput":{ "type":"structure", "required":[ "createdAt", "idMappingTechniques", "inputSourceConfig", "outputSourceConfig", "roleArn", "updatedAt", "workflowArn", "workflowName" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was created.
" }, "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "idMappingTechniques":{ "shape":"IdMappingTechniques", "documentation":"An object which defines the idMappingType and the providerProperties.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was last updated.
" }, "workflowArn":{ "shape":"IdMappingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .
The name of the workflow.
" } } }, "GetMatchIdInput":{ "type":"structure", "required":[ "record", "workflowName" ], "members":{ "record":{ "shape":"RecordAttributeMap", "documentation":"The record to fetch the Match ID for.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "GetMatchIdOutput":{ "type":"structure", "members":{ "matchId":{ "shape":"String", "documentation":"The unique identifiers for this group of match records.
" } } }, "GetMatchingJobInput":{ "type":"structure", "required":[ "jobId", "workflowName" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
", "location":"uri", "locationName":"jobId" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "GetMatchingJobOutput":{ "type":"structure", "required":[ "jobId", "startTime", "status" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"The time at which the job has finished.
" }, "errorDetails":{ "shape":"ErrorDetails", "documentation":"An object containing an error message, if there was an error.
" }, "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
" }, "metrics":{ "shape":"JobMetrics", "documentation":"Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time at which the job was started.
" }, "status":{ "shape":"JobStatus", "documentation":"The current status of the job.
" } } }, "GetMatchingWorkflowInput":{ "type":"structure", "required":["workflowName"], "members":{ "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "GetMatchingWorkflowOutput":{ "type":"structure", "required":[ "createdAt", "inputSourceConfig", "outputSourceConfig", "resolutionTechniques", "roleArn", "updatedAt", "workflowArn", "workflowName" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was created.
" }, "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was last updated.
" }, "workflowArn":{ "shape":"MatchingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" } } }, "GetProviderServiceInput":{ "type":"structure", "required":[ "providerName", "providerServiceName" ], "members":{ "providerName":{ "shape":"EntityName", "documentation":"The name of the provider. This name is typically the company name.
", "location":"uri", "locationName":"providerName" }, "providerServiceName":{ "shape":"ProviderServiceArn", "documentation":"The ARN (Amazon Resource Name) of the product that the provider service provides.
", "location":"uri", "locationName":"providerServiceName" } } }, "GetProviderServiceOutput":{ "type":"structure", "required":[ "anonymizedOutput", "providerEndpointConfiguration", "providerEntityOutputDefinition", "providerName", "providerServiceArn", "providerServiceDisplayName", "providerServiceName", "providerServiceType" ], "members":{ "anonymizedOutput":{ "shape":"Boolean", "documentation":"Specifies whether output data from the provider is anonymized. A value of TRUE 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 FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.
The definition of the provider configuration.
" }, "providerEndpointConfiguration":{ "shape":"ProviderEndpointConfiguration", "documentation":"The required configuration fields to use with the provider service.
" }, "providerEntityOutputDefinition":{ "shape":"Document", "documentation":"The definition of the provider entity output.
" }, "providerIntermediateDataAccessConfiguration":{ "shape":"ProviderIntermediateDataAccessConfiguration", "documentation":"The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.
" }, "providerName":{ "shape":"EntityName", "documentation":"The name of the provider. This name is typically the company name.
" }, "providerServiceArn":{ "shape":"ProviderServiceArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.
" }, "providerServiceDisplayName":{ "shape":"ProviderServiceDisplayName", "documentation":"The display name of the provider service.
" }, "providerServiceName":{ "shape":"EntityName", "documentation":"The name of the product that the provider service provides.
" }, "providerServiceType":{ "shape":"ServiceType", "documentation":"The type of provider service.
" } } }, "GetSchemaMappingInput":{ "type":"structure", "required":["schemaName"], "members":{ "schemaName":{ "shape":"EntityName", "documentation":"The name of the schema to be retrieved.
", "location":"uri", "locationName":"schemaName" } } }, "GetSchemaMappingOutput":{ "type":"structure", "required":[ "createdAt", "hasWorkflows", "mappedInputFields", "schemaArn", "schemaName", "updatedAt" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the SchemaMapping was created.
A description of the schema.
" }, "hasWorkflows":{ "shape":"Boolean", "documentation":"Specifies whether the schema mapping has been applied to a workflow.
" }, "mappedInputFields":{ "shape":"SchemaInputAttributes", "documentation":"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.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
" }, "schemaName":{ "shape":"EntityName", "documentation":"The name of the schema.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the SchemaMapping was last updated.
The total number of input records.
" }, "recordsNotProcessed":{ "shape":"Integer", "documentation":"The total number of records that did not get processed.
" }, "totalRecordsProcessed":{ "shape":"Integer", "documentation":"The total number of records processed.
" } }, "documentation":"An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.
The type of ID mapping.
" }, "providerProperties":{ "shape":"ProviderProperties", "documentation":"An object which defines any additional configurations required by the provider service.
" } }, "documentation":"An object which defines the ID mapping techniques and provider configurations.
" }, "IdMappingType":{ "type":"string", "enum":["PROVIDER"] }, "IdMappingWorkflowArn":{ "type":"string", "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$" }, "IdMappingWorkflowInputSource":{ "type":"structure", "required":[ "inputSourceARN", "schemaName" ], "members":{ "inputSourceARN":{ "shape":"IdMappingWorkflowInputSourceInputSourceARNString", "documentation":"An Gluetable ARN for the input source table.
" }, "schemaName":{ "shape":"EntityName", "documentation":"The name of the schema to be retrieved.
" } }, "documentation":"An object containing InputSourceARN and SchemaName.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" }, "outputS3Path":{ "shape":"S3Path", "documentation":"The S3 path to which Entity Resolution will write the output table.
" } }, "documentation":"The output source for the ID mapping workflow.
" }, "IdMappingWorkflowOutputSourceConfig":{ "type":"list", "member":{"shape":"IdMappingWorkflowOutputSource"}, "max":1, "min":1 }, "IdMappingWorkflowSummary":{ "type":"structure", "required":[ "createdAt", "updatedAt", "workflowArn", "workflowName" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was last updated.
" }, "workflowArn":{ "shape":"IdMappingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow.
The name of the workflow.
" } }, "documentation":"A list of IdMappingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The type of incremental run. It takes only one value: IMMEDIATE.
An object which defines an incremental run type and has only incrementalRunType as a field.
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.
An Glue table ARN for the input source table.
" }, "schemaName":{ "shape":"EntityName", "documentation":"The name of the schema to be retrieved.
" } }, "documentation":"An object containing InputSourceARN, SchemaName, and ApplyNormalization.
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
" }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
The total number of input records.
" }, "matchIDs":{ "shape":"Integer", "documentation":"The total number of matchIDs generated.
The total number of records that did not get processed.
" }, "totalRecordsProcessed":{ "shape":"Integer", "documentation":"The total number of records processed.
" } }, "documentation":"An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.
The time at which the job has finished.
" }, "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The time at which the job was started.
" }, "status":{ "shape":"JobStatus", "documentation":"The current status of the job.
" } }, "documentation":"An object containing the JobId, Status, StartTime, and EndTime of a job.
The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "ListIdMappingJobsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25, "min":1 }, "ListIdMappingJobsOutput":{ "type":"structure", "members":{ "jobs":{ "shape":"JobList", "documentation":"A list of JobSummary objects.
The pagination token from the previous API call.
" } } }, "ListIdMappingWorkflowsInput":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListIdMappingWorkflowsInputMaxResultsInteger", "documentation":"The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" } } }, "ListIdMappingWorkflowsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25 }, "ListIdMappingWorkflowsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
" }, "workflowSummaries":{ "shape":"IdMappingWorkflowList", "documentation":"A list of IdMappingWorkflowSummary objects.
The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "ListMatchingJobsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25, "min":1 }, "ListMatchingJobsOutput":{ "type":"structure", "members":{ "jobs":{ "shape":"JobList", "documentation":"A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
The pagination token from the previous API call.
" } } }, "ListMatchingWorkflowsInput":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListMatchingWorkflowsInputMaxResultsInteger", "documentation":"The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" } } }, "ListMatchingWorkflowsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25 }, "ListMatchingWorkflowsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
" }, "workflowSummaries":{ "shape":"MatchingWorkflowList", "documentation":"A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" }, "providerName":{ "shape":"EntityName", "documentation":"The name of the provider. This name is typically the company name.
", "location":"querystring", "locationName":"providerName" } } }, "ListProviderServicesInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25, "min":15 }, "ListProviderServicesOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
" }, "providerServiceSummaries":{ "shape":"ProviderServiceList", "documentation":"A list of ProviderServices objects.
The maximum number of objects returned per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
", "location":"querystring", "locationName":"nextToken" } } }, "ListSchemaMappingsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":25 }, "ListSchemaMappingsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token from the previous API call.
" }, "schemaList":{ "shape":"SchemaMappingList", "documentation":"A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The ARN of the resource for which you want to view tags.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "required":["tags"], "members":{ "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "MatchingWorkflowArn":{ "type":"string", "pattern":"^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$" }, "MatchingWorkflowList":{ "type":"list", "member":{"shape":"MatchingWorkflowSummary"} }, "MatchingWorkflowSummary":{ "type":"structure", "required":[ "createdAt", "resolutionType", "updatedAt", "workflowArn", "workflowName" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was created.
" }, "resolutionType":{ "shape":"ResolutionType", "documentation":"The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the workflow was last updated.
" }, "workflowArn":{ "shape":"MatchingWorkflowArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The name of the workflow.
" } }, "documentation":"A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
Enables the ability to hash the column values in the output.
" }, "name":{ "shape":"AttributeName", "documentation":"A name of a column to be written to the output. This must be an InputField name in the schema mapping.
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.
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
" }, "applyNormalization":{ "shape":"Boolean", "documentation":"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.
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.
The S3 path to which Entity Resolution will write the output table.
" } }, "documentation":"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.
The identifiers of the provider service, from Data Exchange.
" } }, "documentation":"The required configuration fields to use with the provider service.
", "union":true }, "ProviderIntermediateDataAccessConfiguration":{ "type":"structure", "members":{ "awsAccountIds":{ "shape":"AwsAccountIdList", "documentation":"The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.
" }, "requiredBucketActions":{ "shape":"RequiredBucketActionsList", "documentation":"The S3 bucket actions that the provider requires permission for.
" } }, "documentation":"The required configuration fields to give intermediate access to a provider service.
" }, "ProviderMarketplaceConfiguration":{ "type":"structure", "required":[ "assetId", "dataSetId", "listingId", "revisionId" ], "members":{ "assetId":{ "shape":"String", "documentation":"The asset ID on Data Exchange.
" }, "dataSetId":{ "shape":"String", "documentation":"The dataset ID on Data Exchange.
" }, "listingId":{ "shape":"String", "documentation":"The listing ID on Data Exchange.
" }, "revisionId":{ "shape":"String", "documentation":"The revision ID on Data Exchange.
" } }, "documentation":"The identifiers of the provider service, from Data Exchange.
" }, "ProviderProperties":{ "type":"structure", "required":["providerServiceArn"], "members":{ "intermediateSourceConfiguration":{ "shape":"IntermediateSourceConfiguration", "documentation":"The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
" }, "providerConfiguration":{ "shape":"Document", "documentation":"The required configuration fields to use with the provider service.
" }, "providerServiceArn":{ "shape":"ProviderServiceArn", "documentation":"The ARN of the provider service.
" } }, "documentation":"An object containing the providerServiceARN, intermediateSourceConfiguration, and providerConfiguration.
The name of the provider. This name is typically the company name.
" }, "providerServiceArn":{ "shape":"ProviderServiceArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the providerService.
The display name of the provider service.
" }, "providerServiceName":{ "shape":"EntityName", "documentation":"The name of the product that the provider service provides.
" }, "providerServiceType":{ "shape":"ServiceType", "documentation":"The type of provider service.
" } }, "documentation":"A list of ProviderService objects, each of which contain the fields providerName, providerServiceArn, providerServiceName, and providerServiceType.
The properties of the provider service.
" }, "resolutionType":{ "shape":"ResolutionType", "documentation":"The type of matching. There are two types of matching: RULE_MATCHING and ML_MATCHING.
An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.
An object which defines the resolutionType and the ruleBasedProperties.
The resource could not be found. HTTP Status Code: 404
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.
A name for the matching rule.
" } }, "documentation":"An object containing RuleName, and MatchingKeys.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attributes 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.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.
A string containing the field name.
" }, "groupName":{ "shape":"AttributeName", "documentation":"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.
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.
The subtype of the attribute, selected from a list of values.
" }, "type":{ "shape":"SchemaAttributeType", "documentation":"The type of the attribute, selected from a list of values.
" } }, "documentation":"An object containing FieldName, Type, GroupName, and MatchKey.
The timestamp of when the SchemaMapping was created.
Specifies whether the schema mapping has been applied to a workflow.
" }, "schemaArn":{ "shape":"SchemaMappingArn", "documentation":"The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the SchemaMapping was last updated.
An object containing SchemaName, SchemaArn, CreatedAt, andUpdatedAt.
The name of the ID mapping job to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "StartIdMappingJobOutput":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
" } } }, "StartMatchingJobInput":{ "type":"structure", "required":["workflowName"], "members":{ "workflowName":{ "shape":"EntityName", "documentation":"The name of the matching job to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "StartMatchingJobOutput":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"JobId", "documentation":"The ID of the job.
" } } }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":0 }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"VeniceGlobalArn", "documentation":"The ARN of the resource for which you want to view tags.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "TagResourceOutput":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request was denied due to request throttling. HTTP Status Code: 429
The ARN of the resource for which you want to untag.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"The list of tag keys to remove from the resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceOutput":{ "type":"structure", "members":{ } }, "UpdateIdMappingWorkflowInput":{ "type":"structure", "required":[ "idMappingTechniques", "inputSourceConfig", "outputSourceConfig", "roleArn", "workflowName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "idMappingTechniques":{ "shape":"IdMappingTechniques", "documentation":"An object which defines the idMappingType and the providerProperties.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
", "location":"uri", "locationName":"workflowName" } } }, "UpdateIdMappingWorkflowOutput":{ "type":"structure", "required":[ "idMappingTechniques", "inputSourceConfig", "outputSourceConfig", "roleArn", "workflowArn", "workflowName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "idMappingTechniques":{ "shape":"IdMappingTechniques", "documentation":"An object which defines the idMappingType and the providerProperties.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.
" }, "workflowArn":{ "shape":"IdMappingWorkflowArn", "documentation":"The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access resources on your behalf.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
" } } }, "UpdateMatchingWorkflowInput":{ "type":"structure", "required":[ "inputSourceConfig", "outputSourceConfig", "resolutionTechniques", "roleArn", "workflowName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
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.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow to be retrieved.
", "location":"uri", "locationName":"workflowName" } } }, "UpdateMatchingWorkflowOutput":{ "type":"structure", "required":[ "inputSourceConfig", "outputSourceConfig", "resolutionTechniques", "roleArn", "workflowName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the workflow.
" }, "incrementalRunConfig":{ "shape":"IncrementalRunConfig", "documentation":"An object which defines an incremental run type and has only incrementalRunType as a field.
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
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.
" }, "workflowName":{ "shape":"EntityName", "documentation":"The name of the workflow.
" } } }, "UpdateSchemaMappingInput":{ "type":"structure", "required":[ "mappedInputFields", "schemaName" ], "members":{ "description":{ "shape":"Description", "documentation":"A description of the schema.
" }, "mappedInputFields":{ "shape":"SchemaInputAttributes", "documentation":"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.
The name of the schema. There can't be multiple SchemaMappings with the same name.
A description of the schema.
" }, "mappedInputFields":{ "shape":"SchemaInputAttributes", "documentation":"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.
The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
The name of the schema.
" } } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
Welcome to the Entity Resolution API Reference.
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.
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.
To learn more about Entity Resolution concepts, procedures, and best practices, see the Entity Resolution User Guide.
" }