(constructor)

[configuration]

Constructs a new instance of the <code>EntityResolutionClient</code> class

config

The resolved configuration of EntityResolutionClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-entityresolution!EntityResolutionClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

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 <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution User Guide</a>.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AddPolicyStatementCommand

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

BatchDeleteUniqueIdCommand

Deletes multiple unique IDs in a matching workflow.

CreateIdMappingWorkflowCommand

Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the <code>UpdateIdMappingWorkflow</code> 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 <code>UpdateIdNamespace</code> API.

CreateMatchingWorkflowCommand

Creates a <code>MatchingWorkflow</code> 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 <code>MatchingWorkflow</code> with the same name. To modify an existing workflow, utilize the <code>UpdateMatchingWorkflow</code> API.

CreateSchemaMappingCommand

Creates a schema mapping, which defines the schema of the input customer records table. The <code>SchemaMapping</code> 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 <code>IdMappingWorkflow</code> with a given name. This operation will succeed even if a workflow with the given name does not exist.

DeleteIdNamespaceCommand

Deletes the <code>IdNamespace</code> with a given name.

DeleteMatchingWorkflowCommand

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

DeletePolicyStatementCommand

DeleteSchemaMappingCommand

Deletes the <code>SchemaMapping</code> 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 <code>MatchingWorkflow</code> object that references the <code>SchemaMapping</code> in the workflow's <code>InputSourceConfig</code>.

GetIdMappingJobCommand

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

GetIdMappingWorkflowCommand

Returns the <code>IdMappingWorkflow</code> with a given name, if it exists.

GetIdNamespaceCommand

Returns the <code>IdNamespace</code> with a given name, if it exists.

GetMatchIdCommand

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

GetMatchingJobCommand

GetMatchingWorkflowCommand

Returns the <code>MatchingWorkflow</code> with a given name, if it exists.

GetPolicyCommand

Returns the resource-based policy.

GetProviderServiceCommand

Returns the <code>ProviderService</code> 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 <code>IdMappingWorkflows</code> 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 <code>MatchingWorkflows</code> that have been created for an Amazon Web Services account.

ListProviderServicesCommand

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

ListSchemaMappingsCommand

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

ListTagsForResourceCommand

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

PutPolicyCommand

Updates the resource-based policy.

StartIdMappingJobCommand

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

StartMatchingJobCommand

Starts the <code>MatchingJob</code> of a workflow. The workflow must have previously been created using the <code>CreateMatchingWorkflow</code> 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, <code>SchemaMapping</code> and <code>MatchingWorkflow</code> 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 <code>TagResource</code> 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, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be tagged.

UpdateIdMappingWorkflowCommand

Updates an existing <code>IdMappingWorkflow</code>. This method is identical to <code>CreateIdMappingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>IdMappingWorkflow</code> must already exist for the method to succeed.

UpdateIdNamespaceCommand

UpdateMatchingWorkflowCommand

Updates an existing <code>MatchingWorkflow</code>. This method is identical to <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already exist for the method to succeed.

UpdateSchemaMappingCommand

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. </note>