Package-level declarations

Types

Link copied to clipboard

Welcome to the Entity Resolution API Reference.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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

Link copied to clipboard

Deletes multiple unique IDs in a matching workflow.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Deletes the IdNamespace with a given name.

Link copied to clipboard

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

Link copied to clipboard

Deletes the policy statement.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow or ML matching workflow.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the resource-based policy.

Link copied to clipboard

Returns the ProviderService of a given name.

Link copied to clipboard

Returns the SchemaMapping of a given name.

Link copied to clipboard

Lists all ID mapping jobs for a given workflow.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of all ID namespaces.

Link copied to clipboard

Lists all jobs for a given workflow.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates the resource-based policy.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Updates an existing ID namespace.

Link copied to clipboard

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.

Link copied to clipboard

Updates a schema mapping.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.