@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSEntityResolutionAsync extends AWSEntityResolution
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSEntityResolutionAsync instead.
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.
ENDPOINT_PREFIXcreateIdMappingWorkflow, createMatchingWorkflow, createSchemaMapping, deleteIdMappingWorkflow, deleteMatchingWorkflow, deleteSchemaMapping, getCachedResponseMetadata, getIdMappingJob, getIdMappingWorkflow, getMatchId, getMatchingJob, getMatchingWorkflow, getSchemaMapping, listIdMappingJobs, listIdMappingWorkflows, listMatchingJobs, listMatchingWorkflows, listProviderServices, listSchemaMappings, listTagsForResource, shutdown, startIdMappingJob, startMatchingJob, tagResource, untagResource, updateIdMappingWorkflow, updateMatchingWorkflow, updateSchemaMappingFuture<CreateIdMappingWorkflowResult> createIdMappingWorkflowAsync(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest)
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.
createIdMappingWorkflowRequest - Future<CreateIdMappingWorkflowResult> createIdMappingWorkflowAsync(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest, AsyncHandler<CreateIdMappingWorkflowRequest,CreateIdMappingWorkflowResult> asyncHandler)
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.
createIdMappingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMatchingWorkflowResult> createMatchingWorkflowAsync(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 - Future<CreateMatchingWorkflowResult> createMatchingWorkflowAsync(CreateMatchingWorkflowRequest createMatchingWorkflowRequest, AsyncHandler<CreateMatchingWorkflowRequest,CreateMatchingWorkflowResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateSchemaMappingResult> createSchemaMappingAsync(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 - Future<CreateSchemaMappingResult> createSchemaMappingAsync(CreateSchemaMappingRequest createSchemaMappingRequest, AsyncHandler<CreateSchemaMappingRequest,CreateSchemaMappingResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIdMappingWorkflowResult> deleteIdMappingWorkflowAsync(DeleteIdMappingWorkflowRequest deleteIdMappingWorkflowRequest)
Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with
the given name does not exist.
deleteIdMappingWorkflowRequest - Future<DeleteIdMappingWorkflowResult> deleteIdMappingWorkflowAsync(DeleteIdMappingWorkflowRequest deleteIdMappingWorkflowRequest, AsyncHandler<DeleteIdMappingWorkflowRequest,DeleteIdMappingWorkflowResult> asyncHandler)
Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with
the given name does not exist.
deleteIdMappingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMatchingWorkflowResult> deleteMatchingWorkflowAsync(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 - Future<DeleteMatchingWorkflowResult> deleteMatchingWorkflowAsync(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest, AsyncHandler<DeleteMatchingWorkflowRequest,DeleteMatchingWorkflowResult> asyncHandler)
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with
the given name does not exist.
deleteMatchingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSchemaMappingResult> deleteSchemaMappingAsync(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 MatchingWorkflow object that
references the SchemaMapping in the workflow's InputSourceConfig.
deleteSchemaMappingRequest - Future<DeleteSchemaMappingResult> deleteSchemaMappingAsync(DeleteSchemaMappingRequest deleteSchemaMappingRequest, AsyncHandler<DeleteSchemaMappingRequest,DeleteSchemaMappingResult> asyncHandler)
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.
deleteSchemaMappingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIdMappingJobResult> getIdMappingJobAsync(GetIdMappingJobRequest getIdMappingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getIdMappingJobRequest - Future<GetIdMappingJobResult> getIdMappingJobAsync(GetIdMappingJobRequest getIdMappingJobRequest, AsyncHandler<GetIdMappingJobRequest,GetIdMappingJobResult> asyncHandler)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getIdMappingJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIdMappingWorkflowResult> getIdMappingWorkflowAsync(GetIdMappingWorkflowRequest getIdMappingWorkflowRequest)
Returns the IdMappingWorkflow with a given name, if it exists.
getIdMappingWorkflowRequest - Future<GetIdMappingWorkflowResult> getIdMappingWorkflowAsync(GetIdMappingWorkflowRequest getIdMappingWorkflowRequest, AsyncHandler<GetIdMappingWorkflowRequest,GetIdMappingWorkflowResult> asyncHandler)
Returns the IdMappingWorkflow with a given name, if it exists.
getIdMappingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMatchIdResult> getMatchIdAsync(GetMatchIdRequest getMatchIdRequest)
Returns the corresponding Match ID of a customer record if the record has been processed.
getMatchIdRequest - Future<GetMatchIdResult> getMatchIdAsync(GetMatchIdRequest getMatchIdRequest, AsyncHandler<GetMatchIdRequest,GetMatchIdResult> asyncHandler)
Returns the corresponding Match ID of a customer record if the record has been processed.
getMatchIdRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMatchingJobResult> getMatchingJobAsync(GetMatchingJobRequest getMatchingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getMatchingJobRequest - Future<GetMatchingJobResult> getMatchingJobAsync(GetMatchingJobRequest getMatchingJobRequest, AsyncHandler<GetMatchingJobRequest,GetMatchingJobResult> asyncHandler)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getMatchingJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMatchingWorkflowResult> getMatchingWorkflowAsync(GetMatchingWorkflowRequest getMatchingWorkflowRequest)
Returns the MatchingWorkflow with a given name, if it exists.
getMatchingWorkflowRequest - Future<GetMatchingWorkflowResult> getMatchingWorkflowAsync(GetMatchingWorkflowRequest getMatchingWorkflowRequest, AsyncHandler<GetMatchingWorkflowRequest,GetMatchingWorkflowResult> asyncHandler)
Returns the MatchingWorkflow with a given name, if it exists.
getMatchingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSchemaMappingResult> getSchemaMappingAsync(GetSchemaMappingRequest getSchemaMappingRequest)
Returns the SchemaMapping of a given name.
getSchemaMappingRequest - Future<GetSchemaMappingResult> getSchemaMappingAsync(GetSchemaMappingRequest getSchemaMappingRequest, AsyncHandler<GetSchemaMappingRequest,GetSchemaMappingResult> asyncHandler)
Returns the SchemaMapping of a given name.
getSchemaMappingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIdMappingJobsResult> listIdMappingJobsAsync(ListIdMappingJobsRequest listIdMappingJobsRequest)
Lists all ID mapping jobs for a given workflow.
listIdMappingJobsRequest - Future<ListIdMappingJobsResult> listIdMappingJobsAsync(ListIdMappingJobsRequest listIdMappingJobsRequest, AsyncHandler<ListIdMappingJobsRequest,ListIdMappingJobsResult> asyncHandler)
Lists all ID mapping jobs for a given workflow.
listIdMappingJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIdMappingWorkflowsResult> listIdMappingWorkflowsAsync(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest)
Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services
account.
listIdMappingWorkflowsRequest - Future<ListIdMappingWorkflowsResult> listIdMappingWorkflowsAsync(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest, AsyncHandler<ListIdMappingWorkflowsRequest,ListIdMappingWorkflowsResult> asyncHandler)
Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services
account.
listIdMappingWorkflowsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMatchingJobsResult> listMatchingJobsAsync(ListMatchingJobsRequest listMatchingJobsRequest)
Lists all jobs for a given workflow.
listMatchingJobsRequest - Future<ListMatchingJobsResult> listMatchingJobsAsync(ListMatchingJobsRequest listMatchingJobsRequest, AsyncHandler<ListMatchingJobsRequest,ListMatchingJobsResult> asyncHandler)
Lists all jobs for a given workflow.
listMatchingJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMatchingWorkflowsResult> listMatchingWorkflowsAsync(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest)
Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services
account.
listMatchingWorkflowsRequest - Future<ListMatchingWorkflowsResult> listMatchingWorkflowsAsync(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest, AsyncHandler<ListMatchingWorkflowsRequest,ListMatchingWorkflowsResult> asyncHandler)
Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services
account.
listMatchingWorkflowsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProviderServicesResult> listProviderServicesAsync(ListProviderServicesRequest listProviderServicesRequest)
Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
listProviderServicesRequest - Future<ListProviderServicesResult> listProviderServicesAsync(ListProviderServicesRequest listProviderServicesRequest, AsyncHandler<ListProviderServicesRequest,ListProviderServicesResult> asyncHandler)
Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
listProviderServicesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSchemaMappingsResult> listSchemaMappingsAsync(ListSchemaMappingsRequest listSchemaMappingsRequest)
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
listSchemaMappingsRequest - Future<ListSchemaMappingsResult> listSchemaMappingsAsync(ListSchemaMappingsRequest listSchemaMappingsRequest, AsyncHandler<ListSchemaMappingsRequest,ListSchemaMappingsResult> asyncHandler)
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
listSchemaMappingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping
, and MatchingWorkflow can be tagged.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping
, and MatchingWorkflow can be tagged.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartIdMappingJobResult> startIdMappingJobAsync(StartIdMappingJobRequest startIdMappingJobRequest)
Starts the IdMappingJob of a workflow. The workflow must have previously been created using the
CreateIdMappingWorkflow endpoint.
startIdMappingJobRequest - Future<StartIdMappingJobResult> startIdMappingJobAsync(StartIdMappingJobRequest startIdMappingJobRequest, AsyncHandler<StartIdMappingJobRequest,StartIdMappingJobResult> asyncHandler)
Starts the IdMappingJob of a workflow. The workflow must have previously been created using the
CreateIdMappingWorkflow endpoint.
startIdMappingJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartMatchingJobResult> startMatchingJobAsync(StartMatchingJobRequest startMatchingJobRequest)
Starts the MatchingJob of a workflow. The workflow must have previously been created using the
CreateMatchingWorkflow endpoint.
startMatchingJobRequest - Future<StartMatchingJobResult> startMatchingJobAsync(StartMatchingJobRequest startMatchingJobRequest, AsyncHandler<StartMatchingJobRequest,StartMatchingJobResult> asyncHandler)
Starts the MatchingJob of a workflow. The workflow must have previously been created using the
CreateMatchingWorkflow endpoint.
startMatchingJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIdMappingWorkflowResult> updateIdMappingWorkflowAsync(UpdateIdMappingWorkflowRequest updateIdMappingWorkflowRequest)
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.
updateIdMappingWorkflowRequest - Future<UpdateIdMappingWorkflowResult> updateIdMappingWorkflowAsync(UpdateIdMappingWorkflowRequest updateIdMappingWorkflowRequest, AsyncHandler<UpdateIdMappingWorkflowRequest,UpdateIdMappingWorkflowResult> asyncHandler)
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.
updateIdMappingWorkflowRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMatchingWorkflowResult> updateMatchingWorkflowAsync(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 - Future<UpdateMatchingWorkflowResult> updateMatchingWorkflowAsync(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest, AsyncHandler<UpdateMatchingWorkflowRequest,UpdateMatchingWorkflowResult> asyncHandler)
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 - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateSchemaMappingResult> updateSchemaMappingAsync(UpdateSchemaMappingRequest updateSchemaMappingRequest)
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.
updateSchemaMappingRequest - Future<UpdateSchemaMappingResult> updateSchemaMappingAsync(UpdateSchemaMappingRequest updateSchemaMappingRequest, AsyncHandler<UpdateSchemaMappingRequest,UpdateSchemaMappingResult> asyncHandler)
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.
updateSchemaMappingRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.