View Source aws_entityresolution (aws v1.0.4)
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: https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html.Summary
Functions
Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.
Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run.
Creates a schema mapping, which defines the schema of the input customer records table.
Deletes the IdMappingWorkflow with a given name.
Deletes the MatchingWorkflow with a given name.
Deletes the SchemaMapping with a given name.
IdMappingWorkflow with a given name, if it exists.MatchingWorkflow with a given name, if it exists.IdMappingWorkflows that have been created for an Amazon Web Services account.MatchingWorkflows that have been created for an Amazon Web Services account.ProviderServices that are available in this Amazon Web Services Region.SchemaMappings that have been created for an Amazon Web Services account.Displays the tags associated with an Entity Resolution resource.
Starts the IdMappingJob of a workflow.
Starts the MatchingJob of a workflow.
Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.
Removes one or more tags from the specified Entity Resolution resource.
Updates an existing IdMappingWorkflow.
Updates an existing MatchingWorkflow.
Updates a schema mapping.
Functions
Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.
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.
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.
TheSchemaMapping 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.
delete_id_mapping_workflow(Client, WorkflowName, Input0, Options0)
View SourceDeletes the MatchingWorkflow with a given name.
Deletes the SchemaMapping with a given name.
MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.
get_id_mapping_job(Client, JobId, WorkflowName, QueryMap, HeadersMap)
View Sourceget_id_mapping_job(Client, JobId, WorkflowName, QueryMap, HeadersMap, Options0)
View SourceIdMappingWorkflow with a given name, if it exists.
get_id_mapping_workflow(Client, WorkflowName, QueryMap, HeadersMap)
View Sourceget_id_mapping_workflow(Client, WorkflowName, QueryMap, HeadersMap, Options0)
View Sourceget_matching_job(Client, JobId, WorkflowName, QueryMap, HeadersMap)
View Sourceget_matching_job(Client, JobId, WorkflowName, QueryMap, HeadersMap, Options0)
View SourceMatchingWorkflow with a given name, if it exists.
get_matching_workflow(Client, WorkflowName, QueryMap, HeadersMap, Options0)
View Sourceget_schema_mapping(Client, SchemaName, QueryMap, HeadersMap, Options0)
View Sourcelist_id_mapping_jobs(Client, WorkflowName, QueryMap, HeadersMap, Options0)
View SourceIdMappingWorkflows that have been created for an Amazon Web Services account.
list_matching_jobs(Client, WorkflowName, QueryMap, HeadersMap, Options0)
View SourceMatchingWorkflows that have been created for an Amazon Web Services account.
ProviderServices that are available in this Amazon Web Services Region.
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.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceStarts the IdMappingJob of a workflow.
CreateIdMappingWorkflow endpoint.
Starts the MatchingJob of a workflow.
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.
CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.
update_id_mapping_workflow(Client, WorkflowName, Input0, Options0)
View SourceUpdates an existing MatchingWorkflow.
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.