View Source AWS.EntityResolution (aws-elixir v1.0.0)

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.

Summary

Functions

add_policy_statement(client, arn, statement_id, input, options \\ [])

Adds a policy statement object.

create_id_mapping_workflow(client, input, options \\ [])

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.

create_id_namespace(client, input, options \\ [])

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.

create_matching_workflow(client, input, options \\ [])

Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run.

create_schema_mapping(client, input, options \\ [])

Creates a schema mapping, which defines the schema of the input customer records table.

delete_id_mapping_workflow(client, workflow_name, input, options \\ [])

Deletes the IdMappingWorkflow with a given name.

delete_id_namespace(client, id_namespace_name, input, options \\ [])

Deletes the IdNamespace with a given name.

delete_matching_workflow(client, workflow_name, input, options \\ [])

Deletes the MatchingWorkflow with a given name.

delete_policy_statement(client, arn, statement_id, input, options \\ [])

Deletes the policy statement.

delete_schema_mapping(client, schema_name, input, options \\ [])

Deletes the SchemaMapping with a given name.

get_id_mapping_job(client, job_id, workflow_name, options \\ [])

Gets the status, metrics, and errors (if there are any) that are associated with a job.

get_id_mapping_workflow(client, workflow_name, options \\ [])

Returns the IdMappingWorkflow with a given name, if it exists.

get_id_namespace(client, id_namespace_name, options \\ [])

Returns the IdNamespace with a given name, if it exists.

get_match_id(client, workflow_name, input, options \\ [])

Returns the corresponding Match ID of a customer record if the record has been processed.

get_matching_job(client, job_id, workflow_name, options \\ [])

Gets the status, metrics, and errors (if there are any) that are associated with a job.

get_matching_workflow(client, workflow_name, options \\ [])

Returns the MatchingWorkflow with a given name, if it exists.

get_policy(client, arn, options \\ [])

Returns the resource-based policy.

get_provider_service(client, provider_name, provider_service_name, options \\ [])

Returns the ProviderService of a given name.

get_schema_mapping(client, schema_name, options \\ [])

Returns the SchemaMapping of a given name.

list_id_mapping_jobs(client, workflow_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all ID mapping jobs for a given workflow.

list_id_mapping_workflows(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.

list_id_namespaces(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all ID namespaces.

list_matching_jobs(client, workflow_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all jobs for a given workflow.

list_matching_workflows(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

list_provider_services(client, max_results \\ nil, next_token \\ nil, provider_name \\ nil, options \\ [])

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

list_schema_mappings(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

list_tags_for_resource(client, resource_arn, options \\ [])

Displays the tags associated with an Entity Resolution resource.

metadata()

put_policy(client, arn, input, options \\ [])

Updates the resource-based policy.

start_id_mapping_job(client, workflow_name, input, options \\ [])

Starts the IdMappingJob of a workflow.

start_matching_job(client, workflow_name, input, options \\ [])

Starts the MatchingJob of a workflow.

tag_resource(client, resource_arn, input, options \\ [])

Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from the specified Entity Resolution resource.

update_id_mapping_workflow(client, workflow_name, input, options \\ [])

Updates an existing IdMappingWorkflow.

update_id_namespace(client, id_namespace_name, input, options \\ [])

Updates an existing ID namespace.

update_matching_workflow(client, workflow_name, input, options \\ [])

Updates an existing MatchingWorkflow.

update_schema_mapping(client, schema_name, input, options \\ [])

Updates a schema mapping.

Functions

add_policy_statement(client, arn, statement_id, input, options \\ [])

Adds a policy statement object.

To retrieve a list of existing policy statements, use the GetPolicy API.

create_id_mapping_workflow(client, input, options \\ [])

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.

create_id_namespace(client, input, options \\ [])

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.

Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

create_matching_workflow(client, input, options \\ [])

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.

create_schema_mapping(client, input, options \\ [])

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.

delete_id_mapping_workflow(client, workflow_name, input, options \\ [])

Deletes the IdMappingWorkflow with a given name.

This operation will succeed even if a workflow with the given name does not exist.

delete_id_namespace(client, id_namespace_name, input, options \\ [])

Deletes the IdNamespace with a given name.

delete_matching_workflow(client, workflow_name, input, options \\ [])

Deletes the MatchingWorkflow with a given name.

This operation will succeed even if a workflow with the given name does not exist.

delete_policy_statement(client, arn, statement_id, input, options \\ [])

Deletes the policy statement.

delete_schema_mapping(client, schema_name, input, options \\ [])

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.

get_id_mapping_job(client, job_id, workflow_name, options \\ [])

Gets the status, metrics, and errors (if there are any) that are associated with a job.

get_id_mapping_workflow(client, workflow_name, options \\ [])

Returns the IdMappingWorkflow with a given name, if it exists.

get_id_namespace(client, id_namespace_name, options \\ [])

Returns the IdNamespace with a given name, if it exists.

get_match_id(client, workflow_name, input, options \\ [])

Returns the corresponding Match ID of a customer record if the record has been processed.

get_matching_job(client, job_id, workflow_name, options \\ [])

Gets the status, metrics, and errors (if there are any) that are associated with a job.

get_matching_workflow(client, workflow_name, options \\ [])

Returns the MatchingWorkflow with a given name, if it exists.

get_policy(client, arn, options \\ [])

Returns the resource-based policy.

get_provider_service(client, provider_name, provider_service_name, options \\ [])

Returns the ProviderService of a given name.

get_schema_mapping(client, schema_name, options \\ [])

Returns the SchemaMapping of a given name.

list_id_mapping_jobs(client, workflow_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all ID mapping jobs for a given workflow.

list_id_mapping_workflows(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.

list_id_namespaces(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all ID namespaces.

list_matching_jobs(client, workflow_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all jobs for a given workflow.

list_matching_workflows(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

list_provider_services(client, max_results \\ nil, next_token \\ nil, provider_name \\ nil, options \\ [])

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

list_schema_mappings(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

list_tags_for_resource(client, resource_arn, options \\ [])

Displays the tags associated with an Entity Resolution resource.

In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

metadata()

put_policy(client, arn, input, options \\ [])

Updates the resource-based policy.

start_id_mapping_job(client, workflow_name, input, options \\ [])

Starts the IdMappingJob of a workflow.

The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

start_matching_job(client, workflow_name, input, options \\ [])

Starts the MatchingJob of a workflow.

The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

tag_resource(client, resource_arn, input, options \\ [])

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.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from the specified Entity Resolution resource.

In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

update_id_mapping_workflow(client, workflow_name, input, options \\ [])

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.

update_id_namespace(client, id_namespace_name, input, options \\ [])

Updates an existing ID namespace.

update_matching_workflow(client, workflow_name, input, options \\ [])

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.

update_schema_mapping(client, schema_name, input, options \\ [])

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.