- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
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 install @aws-sdk/client-entityresolution
yarn add @aws-sdk/client-entityresolution
pnpm add @aws-sdk/client-entityresolution
EntityResolutionClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AddPolicyStatementCommand | Adds a policy statement object. To retrieve a list of existing policy statements, use the |
BatchDeleteUniqueIdCommand | Deletes multiple unique IDs in a matching workflow. |
CreateIdMappingWorkflowCommand | Creates an |
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 |
CreateMatchingWorkflowCommand | Creates a |
CreateSchemaMappingCommand | Creates a schema mapping, which defines the schema of the input customer records table. The |
DeleteIdMappingWorkflowCommand | Deletes the |
DeleteIdNamespaceCommand | Deletes the |
DeleteMatchingWorkflowCommand | Deletes the |
DeletePolicyStatementCommand | Deletes the policy statement. |
DeleteSchemaMappingCommand | Deletes the |
GetIdMappingJobCommand | Gets the status, metrics, and errors (if there are any) that are associated with a job. |
GetIdMappingWorkflowCommand | Returns the |
GetIdNamespaceCommand | Returns the |
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 |
GetPolicyCommand | Returns the resource-based policy. |
GetProviderServiceCommand | Returns the |
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 |
ListIdNamespacesCommand | Returns a list of all ID namespaces. |
ListMatchingJobsCommand | Lists all jobs for a given workflow. |
ListMatchingWorkflowsCommand | Returns a list of all the |
ListProviderServicesCommand | Returns a list of all the |
ListSchemaMappingsCommand | Returns a list of all the |
ListTagsForResourceCommand | Displays the tags associated with an Entity Resolution resource. In Entity Resolution, |
PutPolicyCommand | Updates the resource-based policy. |
StartIdMappingJobCommand | Starts the |
StartMatchingJobCommand | Starts the |
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, |
UntagResourceCommand | Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, |
UpdateIdMappingWorkflowCommand | Updates an existing |
UpdateIdNamespaceCommand | Updates an existing ID namespace. |
UpdateMatchingWorkflowCommand | Updates an existing |
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 |
---|
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