@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSEntityResolution
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSEntityResolution instead.
Welcome to the AWS Entity Resolution API Reference.
AWS Entity Resolution is an AWS 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 AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address.
To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the AWS Entity Resolution User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateMatchingWorkflowResult |
createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest)
Creates a
MatchingWorkflow object which stores the configuration of the data processing job to be
run. |
CreateSchemaMappingResult |
createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest)
Creates a schema mapping, which defines the schema of the input customer records table.
|
DeleteMatchingWorkflowResult |
deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest)
Deletes the
MatchingWorkflow with a given name. |
DeleteSchemaMappingResult |
deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest)
Deletes the
SchemaMapping with a given name. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetMatchIdResult |
getMatchId(GetMatchIdRequest getMatchIdRequest)
Returns the corresponding Match ID of a customer record if the record has been processed.
|
GetMatchingJobResult |
getMatchingJob(GetMatchingJobRequest getMatchingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
|
GetMatchingWorkflowResult |
getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest)
Returns the
MatchingWorkflow with a given name, if it exists. |
GetSchemaMappingResult |
getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest)
Returns the SchemaMapping of a given name.
|
ListMatchingJobsResult |
listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest)
Lists all jobs for a given workflow.
|
ListMatchingWorkflowsResult |
listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest)
Returns a list of all the
MatchingWorkflows that have been created for an AWS account. |
ListSchemaMappingsResult |
listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest)
Returns a list of all the
SchemaMappings that have been created for an AWS account. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an AWS Entity Resolution resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartMatchingJobResult |
startMatchingJob(StartMatchingJobRequest startMatchingJobRequest)
Starts the
MatchingJob of a workflow. |
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified AWS Entity Resolution resource.
|
UpdateMatchingWorkflowResult |
updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest)
Updates an existing
MatchingWorkflow. |
static final String ENDPOINT_PREFIX
CreateMatchingWorkflowResult createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest)
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.
createMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - The request could not be processed because of conflict in the current state of the resource. Example:
Workflow already exists, Schema already exists, Workflow is currently running, etc.
HTTP Status Code: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400CreateSchemaMappingResult createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest)
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.
createSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - The request could not be processed because of conflict in the current state of the resource. Example:
Workflow already exists, Schema already exists, Workflow is currently running, etc.
HTTP Status Code: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400DeleteMatchingWorkflowResult deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest)
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with
the given name does not exist.
deleteMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400DeleteSchemaMappingResult deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest)
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 DataIntegrationWorkflow object
that references the SchemaMapping in the workflow's InputSourceConfig.
deleteSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ConflictException - The request could not be processed because of conflict in the current state of the resource. Example:
Workflow already exists, Schema already exists, Workflow is currently running, etc.
HTTP Status Code: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400GetMatchIdResult getMatchId(GetMatchIdRequest getMatchIdRequest)
Returns the corresponding Match ID of a customer record if the record has been processed.
getMatchIdRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400GetMatchingJobResult getMatchingJob(GetMatchingJobRequest getMatchingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getMatchingJobRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400GetMatchingWorkflowResult getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest)
Returns the MatchingWorkflow with a given name, if it exists.
getMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400GetSchemaMappingResult getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest)
Returns the SchemaMapping of a given name.
getSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400ListMatchingJobsResult listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest)
Lists all jobs for a given workflow.
listMatchingJobsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400ListMatchingWorkflowsResult listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest)
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
listMatchingWorkflowsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400ListSchemaMappingsResult listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest)
Returns a list of all the SchemaMappings that have been created for an AWS account.
listSchemaMappingsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
listTagsForResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400StartMatchingJobResult startMatchingJob(StartMatchingJobRequest startMatchingJobRequest)
Starts the MatchingJob of a workflow. The workflow must have previously been created using the
CreateMatchingWorkflow endpoint.
startMatchingJobRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - The request could not be processed because of conflict in the current state of the resource. Example:
Workflow already exists, Schema already exists, Workflow is currently running, etc.
HTTP Status Code: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified AWS 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 AWS 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.
tagResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
untagResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404UpdateMatchingWorkflowResult updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest)
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.
updateMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.