AWS.EntityResolution — AWS SDK for JavaScript (original) (raw)

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using EntityResolution

var entityresolution = new AWS.EntityResolution();
entityresolution.addPolicyStatement(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EntityResolution object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var entityresolution = new AWS.EntityResolution({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the entityresolution service identifier:

AWS.config.apiVersions = {
  entityresolution: '2018-05-10',
  // other service API versions
};

var entityresolution = new AWS.EntityResolution();

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addPolicyStatement(params = {}, callback) ⇒ AWS.Request

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

batchDeleteUniqueId(params = {}, callback) ⇒ AWS.Request

Deletes multiple unique IDs in a matching workflow.

createIdMappingWorkflow(params = {}, callback) ⇒ AWS.Request

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.

createIdNamespace(params = {}, callback) ⇒ AWS.Request

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.

createMatchingWorkflow(params = {}, callback) ⇒ AWS.Request

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.

createSchemaMapping(params = {}, callback) ⇒ AWS.Request

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.

deleteIdMappingWorkflow(params = {}, callback) ⇒ AWS.Request

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

deleteIdNamespace(params = {}, callback) ⇒ AWS.Request

Deletes the IdNamespace with a given name.

deleteMatchingWorkflow(params = {}, callback) ⇒ AWS.Request

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

deletePolicyStatement(params = {}, callback) ⇒ AWS.Request

Deletes the policy statement.

deleteSchemaMapping(params = {}, callback) ⇒ AWS.Request

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.

getIdMappingJob(params = {}, callback) ⇒ AWS.Request

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

getIdMappingWorkflow(params = {}, callback) ⇒ AWS.Request

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

getIdNamespace(params = {}, callback) ⇒ AWS.Request

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

getMatchId(params = {}, callback) ⇒ AWS.Request

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

getMatchingJob(params = {}, callback) ⇒ AWS.Request

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

getMatchingWorkflow(params = {}, callback) ⇒ AWS.Request

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

getPolicy(params = {}, callback) ⇒ AWS.Request

Returns the resource-based policy.

getProviderService(params = {}, callback) ⇒ AWS.Request

Returns the ProviderService of a given name.

getSchemaMapping(params = {}, callback) ⇒ AWS.Request

Returns the SchemaMapping of a given name.

listIdMappingJobs(params = {}, callback) ⇒ AWS.Request

Lists all ID mapping jobs for a given workflow.

listIdMappingWorkflows(params = {}, callback) ⇒ AWS.Request

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

listIdNamespaces(params = {}, callback) ⇒ AWS.Request

Returns a list of all ID namespaces.

listMatchingJobs(params = {}, callback) ⇒ AWS.Request

Lists all jobs for a given workflow.

listMatchingWorkflows(params = {}, callback) ⇒ AWS.Request

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

listProviderServices(params = {}, callback) ⇒ AWS.Request

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

listSchemaMappings(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

putPolicy(params = {}, callback) ⇒ AWS.Request

Updates the resource-based policy.

startIdMappingJob(params = {}, callback) ⇒ AWS.Request

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

startMatchingJob(params = {}, callback) ⇒ AWS.Request

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

updateIdMappingWorkflow(params = {}, callback) ⇒ AWS.Request

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.

updateIdNamespace(params = {}, callback) ⇒ AWS.Request

Updates an existing ID namespace.

updateMatchingWorkflow(params = {}, callback) ⇒ AWS.Request

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.

updateSchemaMapping(params = {}, callback) ⇒ AWS.Request

Updates a schema mapping.

Note: 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.