AWSEntityResolutionClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

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

All Methods
Modifier and Type	Method and Description
`AddPolicyStatementResult`	`addPolicyStatement (AddPolicyStatementRequest request)` Adds a policy statement object.
`BatchDeleteUniqueIdResult`	`batchDeleteUniqueId (BatchDeleteUniqueIdRequest request)` Deletes multiple unique IDs in a matching workflow.
`static AWSEntityResolutionClientBuilder`	`builder ()`
`CreateIdMappingWorkflowResult`	`createIdMappingWorkflow (CreateIdMappingWorkflowRequest request)` Creates an `IdMappingWorkflow` object which stores the configuration of the data processing job to be run.
`CreateIdNamespaceResult`	`createIdNamespace (CreateIdNamespaceRequest request)` Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.
`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.
`DeleteIdMappingWorkflowResult`	`deleteIdMappingWorkflow (DeleteIdMappingWorkflowRequest request)` Deletes the `IdMappingWorkflow` with a given name.
`DeleteIdNamespaceResult`	`deleteIdNamespace (DeleteIdNamespaceRequest request)` Deletes the `IdNamespace` with a given name.
`DeleteMatchingWorkflowResult`	`deleteMatchingWorkflow (DeleteMatchingWorkflowRequest request)` Deletes the `MatchingWorkflow` with a given name.
`DeletePolicyStatementResult`	`deletePolicyStatement (DeletePolicyStatementRequest request)` Deletes the policy statement.
`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.
`GetIdMappingJobResult`	`getIdMappingJob (GetIdMappingJobRequest request)` Gets the status, metrics, and errors (if there are any) that are associated with a job.
`GetIdMappingWorkflowResult`	`getIdMappingWorkflow (GetIdMappingWorkflowRequest request)` Returns the `IdMappingWorkflow` with a given name, if it exists.
`GetIdNamespaceResult`	`getIdNamespace (GetIdNamespaceRequest request)` Returns the `IdNamespace` with a given name, if it exists.
`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.
`GetPolicyResult`	`getPolicy (GetPolicyRequest request)` Returns the resource-based policy.
`GetSchemaMappingResult`	`getSchemaMapping (GetSchemaMappingRequest request)` Returns the SchemaMapping of a given name.
`ListIdMappingJobsResult`	`listIdMappingJobs (ListIdMappingJobsRequest request)` Lists all ID mapping jobs for a given workflow.
`ListIdMappingWorkflowsResult`	`listIdMappingWorkflows (ListIdMappingWorkflowsRequest request)` Returns a list of all the `IdMappingWorkflows` that have been created for an Amazon Web Services account.
`ListIdNamespacesResult`	`listIdNamespaces (ListIdNamespacesRequest request)` Returns a list of all ID namespaces.
`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 Amazon Web Services account.
`ListProviderServicesResult`	`listProviderServices (ListProviderServicesRequest request)` Returns a list of all the `ProviderServices` that are available in this Amazon Web Services Region.
`ListSchemaMappingsResult`	`listSchemaMappings (ListSchemaMappingsRequest request)` Returns a list of all the `SchemaMappings` that have been created for an Amazon Web Services account.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Displays the tags associated with an Entity Resolution resource.
`PutPolicyResult`	`putPolicy (PutPolicyRequest request)` Updates the resource-based policy.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`StartIdMappingJobResult`	`startIdMappingJob (StartIdMappingJobRequest request)` Starts the `IdMappingJob` of a workflow.
`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 Entity Resolution resource.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes one or more tags from the specified Entity Resolution resource.
`UpdateIdMappingWorkflowResult`	`updateIdMappingWorkflow (UpdateIdMappingWorkflowRequest request)` Updates an existing `IdMappingWorkflow`.
`UpdateIdNamespaceResult`	`updateIdNamespace (UpdateIdNamespaceRequest request)` Updates an existing ID namespace.
`UpdateMatchingWorkflowResult`	`updateMatchingWorkflow (UpdateMatchingWorkflowRequest request)` Updates an existing `MatchingWorkflow`.
`UpdateSchemaMappingResult`	`updateSchemaMapping (UpdateSchemaMappingRequest request)` Updates a schema mapping.

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()
```
  - addPolicyStatement
```
public AddPolicyStatementResult addPolicyStatement(AddPolicyStatementRequest request)
```
    Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.
    
    Specified by:
    
    addPolicyStatement in interface AWSEntityResolution
    
    Parameters:
    
    addPolicyStatementRequest -
    
    Returns:
    
    Result of the AddPolicyStatement operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteUniqueId
```
public BatchDeleteUniqueIdResult batchDeleteUniqueId(BatchDeleteUniqueIdRequest request)
```
    Deletes multiple unique IDs in a matching workflow.
    
    Specified by:
    
    batchDeleteUniqueId in interface AWSEntityResolution
    
    Parameters:
    
    batchDeleteUniqueIdRequest -
    
    Returns:
    
    Result of the BatchDeleteUniqueId operation returned by the service.
    
    Throws:
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - createIdMappingWorkflow
```
public CreateIdMappingWorkflowResult createIdMappingWorkflow(CreateIdMappingWorkflowRequest request)
```
    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.
    
    Specified by:
    
    createIdMappingWorkflow in interface AWSEntityResolution
    
    Parameters:
    
    createIdMappingWorkflowRequest -
    
    Returns:
    
    Result of the CreateIdMappingWorkflow operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - createIdNamespace
```
public CreateIdNamespaceResult createIdNamespace(CreateIdNamespaceRequest request)
```
    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.
    
    Specified by:
    
    createIdNamespace in interface AWSEntityResolution
    
    Parameters:
    
    createIdNamespaceRequest -
    
    Returns:
    
    Result of the CreateIdNamespace operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - deleteIdMappingWorkflow
```
public DeleteIdMappingWorkflowResult deleteIdMappingWorkflow(DeleteIdMappingWorkflowRequest request)
```
    Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
    
    Specified by:
    
    deleteIdMappingWorkflow in interface AWSEntityResolution
    
    Parameters:
    
    deleteIdMappingWorkflowRequest -
    
    Returns:
    
    Result of the DeleteIdMappingWorkflow operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - deleteIdNamespace
```
public DeleteIdNamespaceResult deleteIdNamespace(DeleteIdNamespaceRequest request)
```
    Deletes the IdNamespace with a given name.
    
    Specified by:
    
    deleteIdNamespace in interface AWSEntityResolution
    
    Parameters:
    
    deleteIdNamespaceRequest -
    
    Returns:
    
    Result of the DeleteIdNamespace operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - deletePolicyStatement
```
public DeletePolicyStatementResult deletePolicyStatement(DeletePolicyStatementRequest request)
```
    Deletes the policy statement.
    
    Specified by:
    
    deletePolicyStatement in interface AWSEntityResolution
    
    Parameters:
    
    deletePolicyStatementRequest -
    
    Returns:
    
    Result of the DeletePolicyStatement operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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 MatchingWorkflow 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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - getIdMappingJob
```
public GetIdMappingJobResult getIdMappingJob(GetIdMappingJobRequest request)
```
    Gets the status, metrics, and errors (if there are any) that are associated with a job.
    
    Specified by:
    
    getIdMappingJob in interface AWSEntityResolution
    
    Parameters:
    
    getIdMappingJobRequest -
    
    Returns:
    
    Result of the GetIdMappingJob operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - getIdMappingWorkflow
```
public GetIdMappingWorkflowResult getIdMappingWorkflow(GetIdMappingWorkflowRequest request)
```
    Returns the IdMappingWorkflow with a given name, if it exists.
    
    Specified by:
    
    getIdMappingWorkflow in interface AWSEntityResolution
    
    Parameters:
    
    getIdMappingWorkflowRequest -
    
    Returns:
    
    Result of the GetIdMappingWorkflow operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - getIdNamespace
```
public GetIdNamespaceResult getIdNamespace(GetIdNamespaceRequest request)
```
    Returns the IdNamespace with a given name, if it exists.
    
    Specified by:
    
    getIdNamespace in interface AWSEntityResolution
    
    Parameters:
    
    getIdNamespaceRequest -
    
    Returns:
    
    Result of the GetIdNamespace operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - getPolicy
```
public GetPolicyResult getPolicy(GetPolicyRequest request)
```
    Returns the resource-based policy.
    
    Specified by:
    
    getPolicy in interface AWSEntityResolution
    
    Parameters:
    
    getPolicyRequest -
    
    Returns:
    
    Result of the GetPolicy operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listIdMappingJobs
```
public ListIdMappingJobsResult listIdMappingJobs(ListIdMappingJobsRequest request)
```
    Lists all ID mapping jobs for a given workflow.
    
    Specified by:
    
    listIdMappingJobs in interface AWSEntityResolution
    
    Parameters:
    
    listIdMappingJobsRequest -
    
    Returns:
    
    Result of the ListIdMappingJobs operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listIdMappingWorkflows
```
public ListIdMappingWorkflowsResult listIdMappingWorkflows(ListIdMappingWorkflowsRequest request)
```
    Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
    
    Specified by:
    
    listIdMappingWorkflows in interface AWSEntityResolution
    
    Parameters:
    
    listIdMappingWorkflowsRequest -
    
    Returns:
    
    Result of the ListIdMappingWorkflows operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listIdNamespaces
```
public ListIdNamespacesResult listIdNamespaces(ListIdNamespacesRequest request)
```
    Returns a list of all ID namespaces.
    
    Specified by:
    
    listIdNamespaces in interface AWSEntityResolution
    
    Parameters:
    
    listIdNamespacesRequest -
    
    Returns:
    
    Result of the ListIdNamespaces operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listMatchingWorkflows
```
public ListMatchingWorkflowsResult listMatchingWorkflows(ListMatchingWorkflowsRequest request)
```
    Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services 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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listProviderServices
```
public ListProviderServicesResult listProviderServices(ListProviderServicesRequest request)
```
    Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
    
    Specified by:
    
    listProviderServices in interface AWSEntityResolution
    
    Parameters:
    
    listProviderServicesRequest -
    
    Returns:
    
    Result of the ListProviderServices operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listSchemaMappings
```
public ListSchemaMappingsResult listSchemaMappings(ListSchemaMappingsRequest request)
```
    Returns a list of all the SchemaMappings that have been created for an Amazon Web Services 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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Displays the tags associated with an 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 Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - putPolicy
```
public PutPolicyResult putPolicy(PutPolicyRequest request)
```
    Updates the resource-based policy.
    
    Specified by:
    
    putPolicy in interface AWSEntityResolution
    
    Parameters:
    
    putPolicyRequest -
    
    Returns:
    
    Result of the PutPolicy operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - startIdMappingJob
```
public StartIdMappingJobResult startIdMappingJob(StartIdMappingJobRequest request)
```
    Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
    
    Specified by:
    
    startIdMappingJob in interface AWSEntityResolution
    
    Parameters:
    
    startIdMappingJobRequest -
    
    Returns:
    
    Result of the StartIdMappingJob operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    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 Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified 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 Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    See Also:
    
    AWS API Documentation
  - updateIdMappingWorkflow
```
public UpdateIdMappingWorkflowResult updateIdMappingWorkflow(UpdateIdMappingWorkflowRequest request)
```
    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.
    
    Specified by:
    
    updateIdMappingWorkflow in interface AWSEntityResolution
    
    Parameters:
    
    updateIdMappingWorkflowRequest -
    
    Returns:
    
    Result of the UpdateIdMappingWorkflow operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - updateIdNamespace
```
public UpdateIdNamespaceResult updateIdNamespace(UpdateIdNamespaceRequest request)
```
    Updates an existing ID namespace.
    
    Specified by:
    
    updateIdNamespace in interface AWSEntityResolution
    
    Parameters:
    
    updateIdNamespaceRequest -
    
    Returns:
    
    Result of the UpdateIdNamespace operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    See Also:
    
    AWS API Documentation
  - updateSchemaMapping
```
public UpdateSchemaMappingResult updateSchemaMapping(UpdateSchemaMappingRequest request)
```
    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.
    
    Specified by:
    
    updateSchemaMapping in interface AWSEntityResolution
    
    Parameters:
    
    updateSchemaMappingRequest -
    
    Returns:
    
    Result of the UpdateSchemaMapping operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied due to request throttling.
    
    InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
    
    ResourceNotFoundException - The resource could not be found.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    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.
    
    ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
    
    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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class AWSEntityResolutionClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

addPolicyStatement

batchDeleteUniqueId

createIdMappingWorkflow

createIdNamespace

createMatchingWorkflow

createSchemaMapping

deleteIdMappingWorkflow

deleteIdNamespace

deleteMatchingWorkflow

deletePolicyStatement

deleteSchemaMapping

getIdMappingJob

getIdMappingWorkflow

getIdNamespace

getMatchId

getMatchingJob

getMatchingWorkflow

getPolicy

getSchemaMapping

listIdMappingJobs

listIdMappingWorkflows

listIdNamespaces

listMatchingJobs

listMatchingWorkflows

listProviderServices

listSchemaMappings

listTagsForResource

putPolicy

startIdMappingJob

startMatchingJob

tagResource

untagResource

updateIdMappingWorkflow

updateIdNamespace

updateMatchingWorkflow

updateSchemaMapping

getCachedResponseMetadata

shutdown