com.amazonaws.services.entityresolution

Class AWSEntityResolutionClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.entityresolution.AWSEntityResolutionClient

All Implemented Interfaces:

AWSEntityResolution

Direct Known Subclasses:

AWSEntityResolutionAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSEntityResolutionClient
extends AmazonWebServiceClient
implements AWSEntityResolution

Client for accessing AWSEntityResolution. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.entityresolution.AWSEntityResolution

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSEntityResolutionClientBuilder	builder()
CreateMatchingWorkflowResult	createMatchingWorkflow(CreateMatchingWorkflowRequest request) Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run.
CreateSchemaMappingResult	createSchemaMapping(CreateSchemaMappingRequest request) Creates a schema mapping, which defines the schema of the input customer records table.
DeleteMatchingWorkflowResult	deleteMatchingWorkflow(DeleteMatchingWorkflowRequest request) Deletes the MatchingWorkflow with a given name.
DeleteSchemaMappingResult	deleteSchemaMapping(DeleteSchemaMappingRequest request) 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 request) Returns the corresponding Match ID of a customer record if the record has been processed.
GetMatchingJobResult	getMatchingJob(GetMatchingJobRequest request) Gets the status, metrics, and errors (if there are any) that are associated with a job.
GetMatchingWorkflowResult	getMatchingWorkflow(GetMatchingWorkflowRequest request) Returns the MatchingWorkflow with a given name, if it exists.
GetSchemaMappingResult	getSchemaMapping(GetSchemaMappingRequest request) Returns the SchemaMapping of a given name.
ListMatchingJobsResult	listMatchingJobs(ListMatchingJobsRequest request) Lists all jobs for a given workflow.
ListMatchingWorkflowsResult	listMatchingWorkflows(ListMatchingWorkflowsRequest request) Returns a list of all the MatchingWorkflows that have been created for an AWS account.
ListSchemaMappingsResult	listSchemaMappings(ListSchemaMappingsRequest request) Returns a list of all the SchemaMappings that have been created for an AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Starts the MatchingJob of a workflow.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from the specified AWS Entity Resolution resource.
UpdateMatchingWorkflowResult	updateMatchingWorkflow(UpdateMatchingWorkflowRequest request) Updates an existing MatchingWorkflow.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSEntityResolutionClientBuilder builder()

createMatchingWorkflow

public CreateMatchingWorkflowResult createMatchingWorkflow(CreateMatchingWorkflowRequest request)

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.

Specified by:

createMatchingWorkflow in interface AWSEntityResolution

Parameters:

createMatchingWorkflowRequest -

Returns:

Result of the CreateMatchingWorkflow operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ExceedsLimitException - 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: 402

ConflictException - 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: 400

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

createSchemaMapping

public CreateSchemaMappingResult createSchemaMapping(CreateSchemaMappingRequest request)

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.

Specified by:

createSchemaMapping in interface AWSEntityResolution

Parameters:

createSchemaMappingRequest -

Returns:

Result of the CreateSchemaMapping operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ExceedsLimitException - 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: 402

ConflictException - 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: 400

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

deleteMatchingWorkflow

public DeleteMatchingWorkflowResult deleteMatchingWorkflow(DeleteMatchingWorkflowRequest request)

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

Specified by:

deleteMatchingWorkflow in interface AWSEntityResolution

Parameters:

deleteMatchingWorkflowRequest -

Returns:

Result of the DeleteMatchingWorkflow operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

deleteSchemaMapping

public DeleteSchemaMappingResult deleteSchemaMapping(DeleteSchemaMappingRequest request)

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.

Specified by:

deleteSchemaMapping in interface AWSEntityResolution

Parameters:

deleteSchemaMappingRequest -

Returns:

Result of the DeleteSchemaMapping operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ConflictException - 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: 400

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

getMatchId

public GetMatchIdResult getMatchId(GetMatchIdRequest request)

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

Specified by:

getMatchId in interface AWSEntityResolution

Parameters:

getMatchIdRequest -

Returns:

Result of the GetMatchId operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

getMatchingJob

public GetMatchingJobResult getMatchingJob(GetMatchingJobRequest request)

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

Specified by:

getMatchingJob in interface AWSEntityResolution

Parameters:

getMatchingJobRequest -

Returns:

Result of the GetMatchingJob operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

getMatchingWorkflow

public GetMatchingWorkflowResult getMatchingWorkflow(GetMatchingWorkflowRequest request)

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

Specified by:

getMatchingWorkflow in interface AWSEntityResolution

Parameters:

getMatchingWorkflowRequest -

Returns:

Result of the GetMatchingWorkflow operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

getSchemaMapping

public GetSchemaMappingResult getSchemaMapping(GetSchemaMappingRequest request)

Returns the SchemaMapping of a given name.

Specified by:

getSchemaMapping in interface AWSEntityResolution

Parameters:

getSchemaMappingRequest -

Returns:

Result of the GetSchemaMapping operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

listMatchingJobs

public ListMatchingJobsResult listMatchingJobs(ListMatchingJobsRequest request)

Lists all jobs for a given workflow.

Specified by:

listMatchingJobs in interface AWSEntityResolution

Parameters:

listMatchingJobsRequest -

Returns:

Result of the ListMatchingJobs operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

listMatchingWorkflows

public ListMatchingWorkflowsResult listMatchingWorkflows(ListMatchingWorkflowsRequest request)

Returns a list of all the MatchingWorkflows that have been created for an AWS account.

Specified by:

listMatchingWorkflows in interface AWSEntityResolution

Parameters:

listMatchingWorkflowsRequest -

Returns:

Result of the ListMatchingWorkflows operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

listSchemaMappings

public ListSchemaMappingsResult listSchemaMappings(ListSchemaMappingsRequest request)

Returns a list of all the SchemaMappings that have been created for an AWS account.

Specified by:

listSchemaMappings in interface AWSEntityResolution

Parameters:

listSchemaMappingsRequest -

Returns:

Result of the ListSchemaMappings operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSEntityResolution

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

startMatchingJob

public StartMatchingJobResult startMatchingJob(StartMatchingJobRequest request)

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

Specified by:

startMatchingJob in interface AWSEntityResolution

Parameters:

startMatchingJobRequest -

Returns:

Result of the StartMatchingJob operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ExceedsLimitException - 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: 402

ConflictException - 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: 400

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSEntityResolution

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AWSEntityResolution

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

See Also:

AWS API Documentation

updateMatchingWorkflow

public UpdateMatchingWorkflowResult updateMatchingWorkflow(UpdateMatchingWorkflowRequest request)

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.

Specified by:

updateMatchingWorkflow in interface AWSEntityResolution

Parameters:

updateMatchingWorkflowRequest -

Returns:

Result of the UpdateMatchingWorkflow operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429

InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404

AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403

ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSEntityResolution

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSEntityResolution

Overrides:

shutdown in class AmazonWebServiceClient