EntityResolutionClient

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 .

Installation

NPM
npm install @aws-sdk/client-entityresolution
Yarn
yarn add @aws-sdk/client-entityresolution
pnpm
pnpm add @aws-sdk/client-entityresolution

EntityResolutionClient Operations

Command
Summary
AddPolicyStatementCommand

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

BatchDeleteUniqueIdCommand

Deletes multiple unique IDs in a matching workflow.

CreateIdMappingWorkflowCommand

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.

CreateIdNamespaceCommand

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.

CreateMatchingWorkflowCommand

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.

CreateSchemaMappingCommand

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.

DeleteIdMappingWorkflowCommand

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

DeleteIdNamespaceCommand

Deletes the IdNamespace with a given name.

DeleteMatchingWorkflowCommand

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

DeletePolicyStatementCommand

Deletes the policy statement.

DeleteSchemaMappingCommand

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.

GetIdMappingJobCommand

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

GetIdMappingWorkflowCommand

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

GetIdNamespaceCommand

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

GetMatchIdCommand

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

GetMatchingJobCommand

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

GetMatchingWorkflowCommand

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

GetPolicyCommand

Returns the resource-based policy.

GetProviderServiceCommand

Returns the ProviderService of a given name.

GetSchemaMappingCommand

Returns the SchemaMapping of a given name.

ListIdMappingJobsCommand

Lists all ID mapping jobs for a given workflow.

ListIdMappingWorkflowsCommand

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

ListIdNamespacesCommand

Returns a list of all ID namespaces.

ListMatchingJobsCommand

Lists all jobs for a given workflow.

ListMatchingWorkflowsCommand

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

ListProviderServicesCommand

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

ListSchemaMappingsCommand

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

ListTagsForResourceCommand

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

PutPolicyCommand

Updates the resource-based policy.

StartIdMappingJobCommand

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

StartMatchingJobCommand

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

TagResourceCommand

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.

UntagResourceCommand

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

UpdateIdMappingWorkflowCommand

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.

UpdateIdNamespaceCommand

Updates an existing ID namespace.

UpdateMatchingWorkflowCommand

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.

UpdateSchemaMappingCommand

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.

EntityResolutionClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: EntityResolutionClientConfig