Amazon Web Services, Inc.

AWS EntityResolution

Welcome to the Entity Resolution API Reference . Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 38

  • POSTAdd policy statement/policies/:arn/:statementIdAdds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.
  • DELETEDelete policy statement/policies/:arn/:statementIdDeletes the policy statement.
  • DELETEBatch delete unique id/matchingworkflows/:workflowName/uniqueidsDeletes multiple unique IDs in a matching workflow.
  • GETList id mapping workflows/idmappingworkflows?nextToken=string&maxResults=0Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
  • POSTCreate id mapping workflow/idmappingworkflowsCreates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow…
  • GETList id namespaces/idnamespaces?nextToken=string&maxResults=0Returns a list of all ID namespaces.
  • POSTCreate id namespace/idnamespacesCreates 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…
  • GETList matching workflows/matchingworkflows?nextToken=string&maxResults=0Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
  • POSTCreate matching workflow/matchingworkflowsCreates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use…
  • GETList schema mappings/schemas?nextToken=string&maxResults=0Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
  • POSTCreate schema mapping/schemasCreates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata…
  • GETGet id mapping workflow/idmappingworkflows/:workflowNameReturns the IdMappingWorkflow with a given name, if it exists.
  • PUTUpdate id mapping workflow/idmappingworkflows/:workflowNameUpdates an existing IdMappingWorkflow . This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and…
  • DELETEDelete id mapping workflow/idmappingworkflows/:workflowNameDeletes the IdMappingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist.
  • GETGet id namespace/idnamespaces/:idNamespaceNameReturns the IdNamespace with a given name, if it exists.
  • PUTUpdate id namespace/idnamespaces/:idNamespaceNameUpdates an existing ID namespace.
  • DELETEDelete id namespace/idnamespaces/:idNamespaceNameDeletes the IdNamespace with a given name. This operation returns a ResourceNotFoundException if an ID namespace with the given name does not exist.
  • GETGet matching workflow/matchingworkflows/:workflowNameReturns the MatchingWorkflow with a given name, if it exists.
  • PUTUpdate matching workflow/matchingworkflows/:workflowNameUpdates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is PROVIDER ,…
  • DELETEDelete matching workflow/matchingworkflows/:workflowNameDeletes the MatchingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist.
  • GETGet schema mapping/schemas/:schemaNameReturns the SchemaMapping of a given name.
  • PUTUpdate schema mapping/schemas/:schemaNameUpdates 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…
  • DELETEDelete schema mapping/schemas/:schemaNameDeletes the SchemaMapping with a given name. This operation returns a ResourceNotFoundException if a schema with the given name does not exist. This operation…
  • POSTGenerate match id/matchingworkflows/:workflowName/generateMatchesGenerates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the…
  • GETGet id mapping job/idmappingworkflows/:workflowName/jobs/:jobIdReturns the status, metrics, and errors (if there are any) that are associated with a job.
  • POSTGet match id/matchingworkflows/:workflowName/matchesReturns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow. You can call this API as a dry run…
  • GETGet matching job/matchingworkflows/:workflowName/jobs/:jobIdReturns the status, metrics, and errors (if there are any) that are associated with a job.
  • GETGet policy/policies/:arnReturns the resource-based policy.
  • PUTPut policy/policies/:arnUpdates the resource-based policy.
  • GETGet provider service/providerservices/:providerName/:providerServiceNameReturns the ProviderService of a given name.
  • GETList id mapping jobs/idmappingworkflows/:workflowName/jobs?nextToken=string&maxResults=0Lists all ID mapping jobs for a given workflow.
  • POSTStart id mapping job/idmappingworkflows/:workflowName/jobsStarts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
  • GETList matching jobs/matchingworkflows/:workflowName/jobs?nextToken=string&maxResults=0Lists all jobs for a given workflow.
  • POSTStart matching job/matchingworkflows/:workflowName/jobsStarts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
  • GETList provider services/providerservices?nextToken=string&maxResults=0&providerName=stringReturns a list of all the ProviderServices that are available in this Amazon Web Services Region.
  • GETList tags for resource/tags/:resourceArnDisplays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping , and MatchingWorkflow can be tagged.
  • POSTTag resource/tags/:resourceArnAssigns 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…
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping , and MatchingWorkflow can be tagged.

API details

Base URL
https://entityresolution.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
38 operations on 20 pathsGET 16POST 10DELETE 7PUT 5
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS EntityResolution in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS EntityResolution collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add policy statement” (POST /policies/:arn/:statementId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS EntityResolution?

Welcome to the Entity Resolution API Reference . Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution… It is listed under Developer tools and has 38 endpoints.

Who publishes the AWS EntityResolution?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS EntityResolution?

Requests go to https://entityresolution.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS EntityResolution?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS EntityResolution have?

38 operations on 20 paths (16 GET, 10 POST, 7 DELETE, 5 PUT).

Is forking the AWS EntityResolution free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.