Interface EntityResolutionAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionaddPolicyStatement(Consumer<AddPolicyStatementRequest.Builder> addPolicyStatementRequest) Adds a policy statement object.addPolicyStatement(AddPolicyStatementRequest addPolicyStatementRequest) Adds a policy statement object.batchDeleteUniqueId(Consumer<BatchDeleteUniqueIdRequest.Builder> batchDeleteUniqueIdRequest) Deletes multiple unique IDs in a matching workflow.batchDeleteUniqueId(BatchDeleteUniqueIdRequest batchDeleteUniqueIdRequest) Deletes multiple unique IDs in a matching workflow.builder()Create a builder that can be used to configure and create aEntityResolutionAsyncClient.static EntityResolutionAsyncClientcreate()Create aEntityResolutionAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createIdMappingWorkflow(Consumer<CreateIdMappingWorkflowRequest.Builder> createIdMappingWorkflowRequest) Creates anIdMappingWorkflowobject which stores the configuration of the data processing job to be run.createIdMappingWorkflow(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest) Creates anIdMappingWorkflowobject which stores the configuration of the data processing job to be run.createIdNamespace(Consumer<CreateIdNamespaceRequest.Builder> createIdNamespaceRequest) Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.createIdNamespace(CreateIdNamespaceRequest createIdNamespaceRequest) Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.createMatchingWorkflow(Consumer<CreateMatchingWorkflowRequest.Builder> createMatchingWorkflowRequest) Creates aMatchingWorkflowobject which stores the configuration of the data processing job to be run.createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest) Creates aMatchingWorkflowobject which stores the configuration of the data processing job to be run.createSchemaMapping(Consumer<CreateSchemaMappingRequest.Builder> createSchemaMappingRequest) Creates a schema mapping, which defines the schema of the input customer records table.createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest) Creates a schema mapping, which defines the schema of the input customer records table.deleteIdMappingWorkflow(Consumer<DeleteIdMappingWorkflowRequest.Builder> deleteIdMappingWorkflowRequest) Deletes theIdMappingWorkflowwith a given name.deleteIdMappingWorkflow(DeleteIdMappingWorkflowRequest deleteIdMappingWorkflowRequest) Deletes theIdMappingWorkflowwith a given name.deleteIdNamespace(Consumer<DeleteIdNamespaceRequest.Builder> deleteIdNamespaceRequest) Deletes theIdNamespacewith a given name.deleteIdNamespace(DeleteIdNamespaceRequest deleteIdNamespaceRequest) Deletes theIdNamespacewith a given name.deleteMatchingWorkflow(Consumer<DeleteMatchingWorkflowRequest.Builder> deleteMatchingWorkflowRequest) Deletes theMatchingWorkflowwith a given name.deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest) Deletes theMatchingWorkflowwith a given name.deletePolicyStatement(Consumer<DeletePolicyStatementRequest.Builder> deletePolicyStatementRequest) Deletes the policy statement.deletePolicyStatement(DeletePolicyStatementRequest deletePolicyStatementRequest) Deletes the policy statement.deleteSchemaMapping(Consumer<DeleteSchemaMappingRequest.Builder> deleteSchemaMappingRequest) Deletes theSchemaMappingwith a given name.deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest) Deletes theSchemaMappingwith a given name.default CompletableFuture<GetIdMappingJobResponse> getIdMappingJob(Consumer<GetIdMappingJobRequest.Builder> getIdMappingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.default CompletableFuture<GetIdMappingJobResponse> getIdMappingJob(GetIdMappingJobRequest getIdMappingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.getIdMappingWorkflow(Consumer<GetIdMappingWorkflowRequest.Builder> getIdMappingWorkflowRequest) Returns theIdMappingWorkflowwith a given name, if it exists.getIdMappingWorkflow(GetIdMappingWorkflowRequest getIdMappingWorkflowRequest) Returns theIdMappingWorkflowwith a given name, if it exists.default CompletableFuture<GetIdNamespaceResponse> getIdNamespace(Consumer<GetIdNamespaceRequest.Builder> getIdNamespaceRequest) Returns theIdNamespacewith a given name, if it exists.default CompletableFuture<GetIdNamespaceResponse> getIdNamespace(GetIdNamespaceRequest getIdNamespaceRequest) Returns theIdNamespacewith a given name, if it exists.default CompletableFuture<GetMatchIdResponse> getMatchId(Consumer<GetMatchIdRequest.Builder> getMatchIdRequest) Returns the corresponding Match ID of a customer record if the record has been processed.default CompletableFuture<GetMatchIdResponse> getMatchId(GetMatchIdRequest getMatchIdRequest) Returns the corresponding Match ID of a customer record if the record has been processed.default CompletableFuture<GetMatchingJobResponse> getMatchingJob(Consumer<GetMatchingJobRequest.Builder> getMatchingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.default CompletableFuture<GetMatchingJobResponse> getMatchingJob(GetMatchingJobRequest getMatchingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.getMatchingWorkflow(Consumer<GetMatchingWorkflowRequest.Builder> getMatchingWorkflowRequest) Returns theMatchingWorkflowwith a given name, if it exists.getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest) Returns theMatchingWorkflowwith a given name, if it exists.default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns the resource-based policy.default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest) Returns the resource-based policy.getProviderService(Consumer<GetProviderServiceRequest.Builder> getProviderServiceRequest) Returns theProviderServiceof a given name.getProviderService(GetProviderServiceRequest getProviderServiceRequest) Returns theProviderServiceof a given name.getSchemaMapping(Consumer<GetSchemaMappingRequest.Builder> getSchemaMappingRequest) Returns the SchemaMapping of a given name.getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest) Returns the SchemaMapping of a given name.listIdMappingJobs(Consumer<ListIdMappingJobsRequest.Builder> listIdMappingJobsRequest) Lists all ID mapping jobs for a given workflow.listIdMappingJobs(ListIdMappingJobsRequest listIdMappingJobsRequest) Lists all ID mapping jobs for a given workflow.default ListIdMappingJobsPublisherlistIdMappingJobsPaginator(Consumer<ListIdMappingJobsRequest.Builder> listIdMappingJobsRequest) This is a variant oflistIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation.default ListIdMappingJobsPublisherlistIdMappingJobsPaginator(ListIdMappingJobsRequest listIdMappingJobsRequest) This is a variant oflistIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation.listIdMappingWorkflows(Consumer<ListIdMappingWorkflowsRequest.Builder> listIdMappingWorkflowsRequest) Returns a list of all theIdMappingWorkflowsthat have been created for an Amazon Web Services account.listIdMappingWorkflows(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest) Returns a list of all theIdMappingWorkflowsthat have been created for an Amazon Web Services account.default ListIdMappingWorkflowsPublisherlistIdMappingWorkflowsPaginator(Consumer<ListIdMappingWorkflowsRequest.Builder> listIdMappingWorkflowsRequest) This is a variant oflistIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation.default ListIdMappingWorkflowsPublisherlistIdMappingWorkflowsPaginator(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest) This is a variant oflistIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation.listIdNamespaces(Consumer<ListIdNamespacesRequest.Builder> listIdNamespacesRequest) Returns a list of all ID namespaces.listIdNamespaces(ListIdNamespacesRequest listIdNamespacesRequest) Returns a list of all ID namespaces.default ListIdNamespacesPublisherlistIdNamespacesPaginator(Consumer<ListIdNamespacesRequest.Builder> listIdNamespacesRequest) This is a variant oflistIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation.default ListIdNamespacesPublisherlistIdNamespacesPaginator(ListIdNamespacesRequest listIdNamespacesRequest) This is a variant oflistIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation.listMatchingJobs(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) Lists all jobs for a given workflow.listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest) Lists all jobs for a given workflow.default ListMatchingJobsPublisherlistMatchingJobsPaginator(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) This is a variant oflistMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation.default ListMatchingJobsPublisherlistMatchingJobsPaginator(ListMatchingJobsRequest listMatchingJobsRequest) This is a variant oflistMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation.listMatchingWorkflows(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) Returns a list of all theMatchingWorkflowsthat have been created for an Amazon Web Services account.listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) Returns a list of all theMatchingWorkflowsthat have been created for an Amazon Web Services account.default ListMatchingWorkflowsPublisherlistMatchingWorkflowsPaginator(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) This is a variant oflistMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation.default ListMatchingWorkflowsPublisherlistMatchingWorkflowsPaginator(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) This is a variant oflistMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation.listProviderServices(Consumer<ListProviderServicesRequest.Builder> listProviderServicesRequest) Returns a list of all theProviderServicesthat are available in this Amazon Web Services Region.listProviderServices(ListProviderServicesRequest listProviderServicesRequest) Returns a list of all theProviderServicesthat are available in this Amazon Web Services Region.default ListProviderServicesPublisherlistProviderServicesPaginator(Consumer<ListProviderServicesRequest.Builder> listProviderServicesRequest) This is a variant oflistProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation.default ListProviderServicesPublisherlistProviderServicesPaginator(ListProviderServicesRequest listProviderServicesRequest) This is a variant oflistProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation.listSchemaMappings(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) Returns a list of all theSchemaMappingsthat have been created for an Amazon Web Services account.listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest) Returns a list of all theSchemaMappingsthat have been created for an Amazon Web Services account.default ListSchemaMappingsPublisherlistSchemaMappingsPaginator(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) This is a variant oflistSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation.default ListSchemaMappingsPublisherlistSchemaMappingsPaginator(ListSchemaMappingsRequest listSchemaMappingsRequest) This is a variant oflistSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with an Entity Resolution resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with an Entity Resolution resource.default CompletableFuture<PutPolicyResponse> putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Updates the resource-based policy.default CompletableFuture<PutPolicyResponse> putPolicy(PutPolicyRequest putPolicyRequest) Updates the resource-based policy.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartIdMappingJob(Consumer<StartIdMappingJobRequest.Builder> startIdMappingJobRequest) Starts theIdMappingJobof a workflow.startIdMappingJob(StartIdMappingJobRequest startIdMappingJobRequest) Starts theIdMappingJobof a workflow.startMatchingJob(Consumer<StartMatchingJobRequest.Builder> startMatchingJobRequest) Starts theMatchingJobof a workflow.startMatchingJob(StartMatchingJobRequest startMatchingJobRequest) Starts theMatchingJobof a workflow.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified Entity Resolution resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Entity Resolution resource.updateIdMappingWorkflow(Consumer<UpdateIdMappingWorkflowRequest.Builder> updateIdMappingWorkflowRequest) Updates an existingIdMappingWorkflow.updateIdMappingWorkflow(UpdateIdMappingWorkflowRequest updateIdMappingWorkflowRequest) Updates an existingIdMappingWorkflow.updateIdNamespace(Consumer<UpdateIdNamespaceRequest.Builder> updateIdNamespaceRequest) Updates an existing ID namespace.updateIdNamespace(UpdateIdNamespaceRequest updateIdNamespaceRequest) Updates an existing ID namespace.updateMatchingWorkflow(Consumer<UpdateMatchingWorkflowRequest.Builder> updateMatchingWorkflowRequest) Updates an existingMatchingWorkflow.updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest) Updates an existingMatchingWorkflow.updateSchemaMapping(Consumer<UpdateSchemaMappingRequest.Builder> updateSchemaMappingRequest) Updates a schema mapping.updateSchemaMapping(UpdateSchemaMappingRequest updateSchemaMappingRequest) Updates a schema mapping.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addPolicyStatement
default CompletableFuture<AddPolicyStatementResponse> addPolicyStatement(AddPolicyStatementRequest addPolicyStatementRequest) Adds a policy statement object. To retrieve a list of existing policy statements, use the
GetPolicyAPI.- Parameters:
addPolicyStatementRequest-- Returns:
- A Java Future containing the result of the AddPolicyStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addPolicyStatement
default CompletableFuture<AddPolicyStatementResponse> addPolicyStatement(Consumer<AddPolicyStatementRequest.Builder> addPolicyStatementRequest) Adds a policy statement object. To retrieve a list of existing policy statements, use the
GetPolicyAPI.
This is a convenience which creates an instance of the
AddPolicyStatementRequest.Builderavoiding the need to create one manually viaAddPolicyStatementRequest.builder()- Parameters:
addPolicyStatementRequest- AConsumerthat will call methods onAddPolicyStatementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AddPolicyStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteUniqueId
default CompletableFuture<BatchDeleteUniqueIdResponse> batchDeleteUniqueId(BatchDeleteUniqueIdRequest batchDeleteUniqueIdRequest) Deletes multiple unique IDs in a matching workflow.
- Parameters:
batchDeleteUniqueIdRequest-- Returns:
- A Java Future containing the result of the BatchDeleteUniqueId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteUniqueId
default CompletableFuture<BatchDeleteUniqueIdResponse> batchDeleteUniqueId(Consumer<BatchDeleteUniqueIdRequest.Builder> batchDeleteUniqueIdRequest) Deletes multiple unique IDs in a matching workflow.
This is a convenience which creates an instance of the
BatchDeleteUniqueIdRequest.Builderavoiding the need to create one manually viaBatchDeleteUniqueIdRequest.builder()- Parameters:
batchDeleteUniqueIdRequest- AConsumerthat will call methods onBatchDeleteUniqueIdRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteUniqueId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdMappingWorkflow
default CompletableFuture<CreateIdMappingWorkflowResponse> createIdMappingWorkflow(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest) Creates an
IdMappingWorkflowobject which stores the configuration of the data processing job to be run. EachIdMappingWorkflowmust have a unique workflow name. To modify an existing workflow, use theUpdateIdMappingWorkflowAPI.- Parameters:
createIdMappingWorkflowRequest-- Returns:
- A Java Future containing the result of the CreateIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdMappingWorkflow
default CompletableFuture<CreateIdMappingWorkflowResponse> createIdMappingWorkflow(Consumer<CreateIdMappingWorkflowRequest.Builder> createIdMappingWorkflowRequest) Creates an
IdMappingWorkflowobject which stores the configuration of the data processing job to be run. EachIdMappingWorkflowmust have a unique workflow name. To modify an existing workflow, use theUpdateIdMappingWorkflowAPI.
This is a convenience which creates an instance of the
CreateIdMappingWorkflowRequest.Builderavoiding the need to create one manually viaCreateIdMappingWorkflowRequest.builder()- Parameters:
createIdMappingWorkflowRequest- AConsumerthat will call methods onCreateIdMappingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdNamespace
default CompletableFuture<CreateIdNamespaceResponse> createIdNamespace(CreateIdNamespaceRequest createIdNamespaceRequest) 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
UpdateIdNamespaceAPI.- Parameters:
createIdNamespaceRequest-- Returns:
- A Java Future containing the result of the CreateIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIdNamespace
default CompletableFuture<CreateIdNamespaceResponse> createIdNamespace(Consumer<CreateIdNamespaceRequest.Builder> createIdNamespaceRequest) 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
UpdateIdNamespaceAPI.
This is a convenience which creates an instance of the
CreateIdNamespaceRequest.Builderavoiding the need to create one manually viaCreateIdNamespaceRequest.builder()- Parameters:
createIdNamespaceRequest- AConsumerthat will call methods onCreateIdNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchingWorkflow
default CompletableFuture<CreateMatchingWorkflowResponse> createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest) Creates a
MatchingWorkflowobject which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existingMatchingWorkflowwith the same name. To modify an existing workflow, utilize theUpdateMatchingWorkflowAPI.- Parameters:
createMatchingWorkflowRequest-- Returns:
- A Java Future containing the result of the CreateMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchingWorkflow
default CompletableFuture<CreateMatchingWorkflowResponse> createMatchingWorkflow(Consumer<CreateMatchingWorkflowRequest.Builder> createMatchingWorkflowRequest) Creates a
MatchingWorkflowobject which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existingMatchingWorkflowwith the same name. To modify an existing workflow, utilize theUpdateMatchingWorkflowAPI.
This is a convenience which creates an instance of the
CreateMatchingWorkflowRequest.Builderavoiding the need to create one manually viaCreateMatchingWorkflowRequest.builder()- Parameters:
createMatchingWorkflowRequest- AConsumerthat will call methods onCreateMatchingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSchemaMapping
default CompletableFuture<CreateSchemaMappingResponse> createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest) Creates a schema mapping, which defines the schema of the input customer records table. The
SchemaMappingalso provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.- Parameters:
createSchemaMappingRequest-- Returns:
- A Java Future containing the result of the CreateSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSchemaMapping
default CompletableFuture<CreateSchemaMappingResponse> createSchemaMapping(Consumer<CreateSchemaMappingRequest.Builder> createSchemaMappingRequest) Creates a schema mapping, which defines the schema of the input customer records table. The
SchemaMappingalso provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
This is a convenience which creates an instance of the
CreateSchemaMappingRequest.Builderavoiding the need to create one manually viaCreateSchemaMappingRequest.builder()- Parameters:
createSchemaMappingRequest- AConsumerthat will call methods onCreateSchemaMappingRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdMappingWorkflow
default CompletableFuture<DeleteIdMappingWorkflowResponse> deleteIdMappingWorkflow(DeleteIdMappingWorkflowRequest deleteIdMappingWorkflowRequest) Deletes the
IdMappingWorkflowwith a given name. This operation will succeed even if a workflow with the given name does not exist.- Parameters:
deleteIdMappingWorkflowRequest-- Returns:
- A Java Future containing the result of the DeleteIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdMappingWorkflow
default CompletableFuture<DeleteIdMappingWorkflowResponse> deleteIdMappingWorkflow(Consumer<DeleteIdMappingWorkflowRequest.Builder> deleteIdMappingWorkflowRequest) Deletes the
IdMappingWorkflowwith a given name. This operation will succeed even if a workflow with the given name does not exist.
This is a convenience which creates an instance of the
DeleteIdMappingWorkflowRequest.Builderavoiding the need to create one manually viaDeleteIdMappingWorkflowRequest.builder()- Parameters:
deleteIdMappingWorkflowRequest- AConsumerthat will call methods onDeleteIdMappingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdNamespace
default CompletableFuture<DeleteIdNamespaceResponse> deleteIdNamespace(DeleteIdNamespaceRequest deleteIdNamespaceRequest) Deletes the
IdNamespacewith a given name.- Parameters:
deleteIdNamespaceRequest-- Returns:
- A Java Future containing the result of the DeleteIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdNamespace
default CompletableFuture<DeleteIdNamespaceResponse> deleteIdNamespace(Consumer<DeleteIdNamespaceRequest.Builder> deleteIdNamespaceRequest) Deletes the
IdNamespacewith a given name.
This is a convenience which creates an instance of the
DeleteIdNamespaceRequest.Builderavoiding the need to create one manually viaDeleteIdNamespaceRequest.builder()- Parameters:
deleteIdNamespaceRequest- AConsumerthat will call methods onDeleteIdNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchingWorkflow
default CompletableFuture<DeleteMatchingWorkflowResponse> deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest) Deletes the
MatchingWorkflowwith a given name. This operation will succeed even if a workflow with the given name does not exist.- Parameters:
deleteMatchingWorkflowRequest-- Returns:
- A Java Future containing the result of the DeleteMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchingWorkflow
default CompletableFuture<DeleteMatchingWorkflowResponse> deleteMatchingWorkflow(Consumer<DeleteMatchingWorkflowRequest.Builder> deleteMatchingWorkflowRequest) Deletes the
MatchingWorkflowwith a given name. This operation will succeed even if a workflow with the given name does not exist.
This is a convenience which creates an instance of the
DeleteMatchingWorkflowRequest.Builderavoiding the need to create one manually viaDeleteMatchingWorkflowRequest.builder()- Parameters:
deleteMatchingWorkflowRequest- AConsumerthat will call methods onDeleteMatchingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePolicyStatement
default CompletableFuture<DeletePolicyStatementResponse> deletePolicyStatement(DeletePolicyStatementRequest deletePolicyStatementRequest) Deletes the policy statement.
- Parameters:
deletePolicyStatementRequest-- Returns:
- A Java Future containing the result of the DeletePolicyStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePolicyStatement
default CompletableFuture<DeletePolicyStatementResponse> deletePolicyStatement(Consumer<DeletePolicyStatementRequest.Builder> deletePolicyStatementRequest) Deletes the policy statement.
This is a convenience which creates an instance of the
DeletePolicyStatementRequest.Builderavoiding the need to create one manually viaDeletePolicyStatementRequest.builder()- Parameters:
deletePolicyStatementRequest- AConsumerthat will call methods onDeletePolicyStatementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeletePolicyStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSchemaMapping
default CompletableFuture<DeleteSchemaMappingResponse> deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest) Deletes the
SchemaMappingwith 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 aMatchingWorkflowobject that references theSchemaMappingin the workflow'sInputSourceConfig.- Parameters:
deleteSchemaMappingRequest-- Returns:
- A Java Future containing the result of the DeleteSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSchemaMapping
default CompletableFuture<DeleteSchemaMappingResponse> deleteSchemaMapping(Consumer<DeleteSchemaMappingRequest.Builder> deleteSchemaMappingRequest) Deletes the
SchemaMappingwith 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 aMatchingWorkflowobject that references theSchemaMappingin the workflow'sInputSourceConfig.
This is a convenience which creates an instance of the
DeleteSchemaMappingRequest.Builderavoiding the need to create one manually viaDeleteSchemaMappingRequest.builder()- Parameters:
deleteSchemaMappingRequest- AConsumerthat will call methods onDeleteSchemaMappingRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdMappingJob
default CompletableFuture<GetIdMappingJobResponse> getIdMappingJob(GetIdMappingJobRequest getIdMappingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.
- Parameters:
getIdMappingJobRequest-- Returns:
- A Java Future containing the result of the GetIdMappingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdMappingJob
default CompletableFuture<GetIdMappingJobResponse> getIdMappingJob(Consumer<GetIdMappingJobRequest.Builder> getIdMappingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.
This is a convenience which creates an instance of the
GetIdMappingJobRequest.Builderavoiding the need to create one manually viaGetIdMappingJobRequest.builder()- Parameters:
getIdMappingJobRequest- AConsumerthat will call methods onGetIdMappingJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetIdMappingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdMappingWorkflow
default CompletableFuture<GetIdMappingWorkflowResponse> getIdMappingWorkflow(GetIdMappingWorkflowRequest getIdMappingWorkflowRequest) Returns the
IdMappingWorkflowwith a given name, if it exists.- Parameters:
getIdMappingWorkflowRequest-- Returns:
- A Java Future containing the result of the GetIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdMappingWorkflow
default CompletableFuture<GetIdMappingWorkflowResponse> getIdMappingWorkflow(Consumer<GetIdMappingWorkflowRequest.Builder> getIdMappingWorkflowRequest) Returns the
IdMappingWorkflowwith a given name, if it exists.
This is a convenience which creates an instance of the
GetIdMappingWorkflowRequest.Builderavoiding the need to create one manually viaGetIdMappingWorkflowRequest.builder()- Parameters:
getIdMappingWorkflowRequest- AConsumerthat will call methods onGetIdMappingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdNamespace
default CompletableFuture<GetIdNamespaceResponse> getIdNamespace(GetIdNamespaceRequest getIdNamespaceRequest) Returns the
IdNamespacewith a given name, if it exists.- Parameters:
getIdNamespaceRequest-- Returns:
- A Java Future containing the result of the GetIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIdNamespace
default CompletableFuture<GetIdNamespaceResponse> getIdNamespace(Consumer<GetIdNamespaceRequest.Builder> getIdNamespaceRequest) Returns the
IdNamespacewith a given name, if it exists.
This is a convenience which creates an instance of the
GetIdNamespaceRequest.Builderavoiding the need to create one manually viaGetIdNamespaceRequest.builder()- Parameters:
getIdNamespaceRequest- AConsumerthat will call methods onGetIdNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchId
Returns the corresponding Match ID of a customer record if the record has been processed.
- Parameters:
getMatchIdRequest-- Returns:
- A Java Future containing the result of the GetMatchId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchId
default CompletableFuture<GetMatchIdResponse> getMatchId(Consumer<GetMatchIdRequest.Builder> getMatchIdRequest) Returns the corresponding Match ID of a customer record if the record has been processed.
This is a convenience which creates an instance of the
GetMatchIdRequest.Builderavoiding the need to create one manually viaGetMatchIdRequest.builder()- Parameters:
getMatchIdRequest- AConsumerthat will call methods onGetMatchIdRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMatchId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchingJob
default CompletableFuture<GetMatchingJobResponse> getMatchingJob(GetMatchingJobRequest getMatchingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.
- Parameters:
getMatchingJobRequest-- Returns:
- A Java Future containing the result of the GetMatchingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchingJob
default CompletableFuture<GetMatchingJobResponse> getMatchingJob(Consumer<GetMatchingJobRequest.Builder> getMatchingJobRequest) Gets the status, metrics, and errors (if there are any) that are associated with a job.
This is a convenience which creates an instance of the
GetMatchingJobRequest.Builderavoiding the need to create one manually viaGetMatchingJobRequest.builder()- Parameters:
getMatchingJobRequest- AConsumerthat will call methods onGetMatchingJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMatchingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchingWorkflow
default CompletableFuture<GetMatchingWorkflowResponse> getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest) Returns the
MatchingWorkflowwith a given name, if it exists.- Parameters:
getMatchingWorkflowRequest-- Returns:
- A Java Future containing the result of the GetMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMatchingWorkflow
default CompletableFuture<GetMatchingWorkflowResponse> getMatchingWorkflow(Consumer<GetMatchingWorkflowRequest.Builder> getMatchingWorkflowRequest) Returns the
MatchingWorkflowwith a given name, if it exists.
This is a convenience which creates an instance of the
GetMatchingWorkflowRequest.Builderavoiding the need to create one manually viaGetMatchingWorkflowRequest.builder()- Parameters:
getMatchingWorkflowRequest- AConsumerthat will call methods onGetMatchingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPolicy
Returns the resource-based policy.
- Parameters:
getPolicyRequest-- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPolicy
default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns the resource-based policy.
This is a convenience which creates an instance of the
GetPolicyRequest.Builderavoiding the need to create one manually viaGetPolicyRequest.builder()- Parameters:
getPolicyRequest- AConsumerthat will call methods onGetPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProviderService
default CompletableFuture<GetProviderServiceResponse> getProviderService(GetProviderServiceRequest getProviderServiceRequest) Returns the
ProviderServiceof a given name.- Parameters:
getProviderServiceRequest-- Returns:
- A Java Future containing the result of the GetProviderService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProviderService
default CompletableFuture<GetProviderServiceResponse> getProviderService(Consumer<GetProviderServiceRequest.Builder> getProviderServiceRequest) Returns the
ProviderServiceof a given name.
This is a convenience which creates an instance of the
GetProviderServiceRequest.Builderavoiding the need to create one manually viaGetProviderServiceRequest.builder()- Parameters:
getProviderServiceRequest- AConsumerthat will call methods onGetProviderServiceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProviderService operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSchemaMapping
default CompletableFuture<GetSchemaMappingResponse> getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest) Returns the SchemaMapping of a given name.
- Parameters:
getSchemaMappingRequest-- Returns:
- A Java Future containing the result of the GetSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSchemaMapping
default CompletableFuture<GetSchemaMappingResponse> getSchemaMapping(Consumer<GetSchemaMappingRequest.Builder> getSchemaMappingRequest) Returns the SchemaMapping of a given name.
This is a convenience which creates an instance of the
GetSchemaMappingRequest.Builderavoiding the need to create one manually viaGetSchemaMappingRequest.builder()- Parameters:
getSchemaMappingRequest- AConsumerthat will call methods onGetSchemaMappingRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingJobs
default CompletableFuture<ListIdMappingJobsResponse> listIdMappingJobs(ListIdMappingJobsRequest listIdMappingJobsRequest) Lists all ID mapping jobs for a given workflow.
- Parameters:
listIdMappingJobsRequest-- Returns:
- A Java Future containing the result of the ListIdMappingJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingJobs
default CompletableFuture<ListIdMappingJobsResponse> listIdMappingJobs(Consumer<ListIdMappingJobsRequest.Builder> listIdMappingJobsRequest) Lists all ID mapping jobs for a given workflow.
This is a convenience which creates an instance of the
ListIdMappingJobsRequest.Builderavoiding the need to create one manually viaListIdMappingJobsRequest.builder()- Parameters:
listIdMappingJobsRequest- AConsumerthat will call methods onListIdMappingJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIdMappingJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingJobsPaginator
default ListIdMappingJobsPublisher listIdMappingJobsPaginator(ListIdMappingJobsRequest listIdMappingJobsRequest) This is a variant of
listIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation.- Parameters:
listIdMappingJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingJobsPaginator
default ListIdMappingJobsPublisher listIdMappingJobsPaginator(Consumer<ListIdMappingJobsRequest.Builder> listIdMappingJobsRequest) This is a variant of
listIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdMappingJobs(software.amazon.awssdk.services.entityresolution.model.ListIdMappingJobsRequest)operation.
This is a convenience which creates an instance of the
ListIdMappingJobsRequest.Builderavoiding the need to create one manually viaListIdMappingJobsRequest.builder()- Parameters:
listIdMappingJobsRequest- AConsumerthat will call methods onListIdMappingJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingWorkflows
default CompletableFuture<ListIdMappingWorkflowsResponse> listIdMappingWorkflows(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest) Returns a list of all the
IdMappingWorkflowsthat have been created for an Amazon Web Services account.- Parameters:
listIdMappingWorkflowsRequest-- Returns:
- A Java Future containing the result of the ListIdMappingWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingWorkflows
default CompletableFuture<ListIdMappingWorkflowsResponse> listIdMappingWorkflows(Consumer<ListIdMappingWorkflowsRequest.Builder> listIdMappingWorkflowsRequest) Returns a list of all the
IdMappingWorkflowsthat have been created for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListIdMappingWorkflowsRequest.Builderavoiding the need to create one manually viaListIdMappingWorkflowsRequest.builder()- Parameters:
listIdMappingWorkflowsRequest- AConsumerthat will call methods onListIdMappingWorkflowsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIdMappingWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingWorkflowsPaginator
default ListIdMappingWorkflowsPublisher listIdMappingWorkflowsPaginator(ListIdMappingWorkflowsRequest listIdMappingWorkflowsRequest) This is a variant of
listIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation.- Parameters:
listIdMappingWorkflowsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdMappingWorkflowsPaginator
default ListIdMappingWorkflowsPublisher listIdMappingWorkflowsPaginator(Consumer<ListIdMappingWorkflowsRequest.Builder> listIdMappingWorkflowsRequest) This is a variant of
listIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdMappingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListIdMappingWorkflowsRequest)operation.
This is a convenience which creates an instance of the
ListIdMappingWorkflowsRequest.Builderavoiding the need to create one manually viaListIdMappingWorkflowsRequest.builder()- Parameters:
listIdMappingWorkflowsRequest- AConsumerthat will call methods onListIdMappingWorkflowsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdNamespaces
default CompletableFuture<ListIdNamespacesResponse> listIdNamespaces(ListIdNamespacesRequest listIdNamespacesRequest) Returns a list of all ID namespaces.
- Parameters:
listIdNamespacesRequest-- Returns:
- A Java Future containing the result of the ListIdNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdNamespaces
default CompletableFuture<ListIdNamespacesResponse> listIdNamespaces(Consumer<ListIdNamespacesRequest.Builder> listIdNamespacesRequest) Returns a list of all ID namespaces.
This is a convenience which creates an instance of the
ListIdNamespacesRequest.Builderavoiding the need to create one manually viaListIdNamespacesRequest.builder()- Parameters:
listIdNamespacesRequest- AConsumerthat will call methods onListIdNamespacesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIdNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdNamespacesPaginator
default ListIdNamespacesPublisher listIdNamespacesPaginator(ListIdNamespacesRequest listIdNamespacesRequest) This is a variant of
listIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdNamespacesPublisher publisher = client.listIdNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdNamespacesPublisher publisher = client.listIdNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation.- Parameters:
listIdNamespacesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdNamespacesPaginator
default ListIdNamespacesPublisher listIdNamespacesPaginator(Consumer<ListIdNamespacesRequest.Builder> listIdNamespacesRequest) This is a variant of
listIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListIdNamespacesPublisher publisher = client.listIdNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListIdNamespacesPublisher publisher = client.listIdNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdNamespaces(software.amazon.awssdk.services.entityresolution.model.ListIdNamespacesRequest)operation.
This is a convenience which creates an instance of the
ListIdNamespacesRequest.Builderavoiding the need to create one manually viaListIdNamespacesRequest.builder()- Parameters:
listIdNamespacesRequest- AConsumerthat will call methods onListIdNamespacesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingJobs
default CompletableFuture<ListMatchingJobsResponse> listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest) Lists all jobs for a given workflow.
- Parameters:
listMatchingJobsRequest-- Returns:
- A Java Future containing the result of the ListMatchingJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingJobs
default CompletableFuture<ListMatchingJobsResponse> listMatchingJobs(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) Lists all jobs for a given workflow.
This is a convenience which creates an instance of the
ListMatchingJobsRequest.Builderavoiding the need to create one manually viaListMatchingJobsRequest.builder()- Parameters:
listMatchingJobsRequest- AConsumerthat will call methods onListMatchingJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMatchingJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingJobsPaginator
default ListMatchingJobsPublisher listMatchingJobsPaginator(ListMatchingJobsRequest listMatchingJobsRequest) This is a variant of
listMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation.- Parameters:
listMatchingJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingJobsPaginator
default ListMatchingJobsPublisher listMatchingJobsPaginator(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) This is a variant of
listMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMatchingJobs(software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsRequest)operation.
This is a convenience which creates an instance of the
ListMatchingJobsRequest.Builderavoiding the need to create one manually viaListMatchingJobsRequest.builder()- Parameters:
listMatchingJobsRequest- AConsumerthat will call methods onListMatchingJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingWorkflows
default CompletableFuture<ListMatchingWorkflowsResponse> listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) Returns a list of all the
MatchingWorkflowsthat have been created for an Amazon Web Services account.- Parameters:
listMatchingWorkflowsRequest-- Returns:
- A Java Future containing the result of the ListMatchingWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingWorkflows
default CompletableFuture<ListMatchingWorkflowsResponse> listMatchingWorkflows(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) Returns a list of all the
MatchingWorkflowsthat have been created for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListMatchingWorkflowsRequest.Builderavoiding the need to create one manually viaListMatchingWorkflowsRequest.builder()- Parameters:
listMatchingWorkflowsRequest- AConsumerthat will call methods onListMatchingWorkflowsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListMatchingWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingWorkflowsPaginator
default ListMatchingWorkflowsPublisher listMatchingWorkflowsPaginator(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) This is a variant of
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation.- Parameters:
listMatchingWorkflowsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMatchingWorkflowsPaginator
default ListMatchingWorkflowsPublisher listMatchingWorkflowsPaginator(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) This is a variant of
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)operation.
This is a convenience which creates an instance of the
ListMatchingWorkflowsRequest.Builderavoiding the need to create one manually viaListMatchingWorkflowsRequest.builder()- Parameters:
listMatchingWorkflowsRequest- AConsumerthat will call methods onListMatchingWorkflowsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProviderServices
default CompletableFuture<ListProviderServicesResponse> listProviderServices(ListProviderServicesRequest listProviderServicesRequest) Returns a list of all the
ProviderServicesthat are available in this Amazon Web Services Region.- Parameters:
listProviderServicesRequest-- Returns:
- A Java Future containing the result of the ListProviderServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProviderServices
default CompletableFuture<ListProviderServicesResponse> listProviderServices(Consumer<ListProviderServicesRequest.Builder> listProviderServicesRequest) Returns a list of all the
ProviderServicesthat are available in this Amazon Web Services Region.
This is a convenience which creates an instance of the
ListProviderServicesRequest.Builderavoiding the need to create one manually viaListProviderServicesRequest.builder()- Parameters:
listProviderServicesRequest- AConsumerthat will call methods onListProviderServicesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProviderServices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProviderServicesPaginator
default ListProviderServicesPublisher listProviderServicesPaginator(ListProviderServicesRequest listProviderServicesRequest) This is a variant of
listProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListProviderServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation.- Parameters:
listProviderServicesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProviderServicesPaginator
default ListProviderServicesPublisher listProviderServicesPaginator(Consumer<ListProviderServicesRequest.Builder> listProviderServicesRequest) This is a variant of
listProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListProviderServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProviderServices(software.amazon.awssdk.services.entityresolution.model.ListProviderServicesRequest)operation.
This is a convenience which creates an instance of the
ListProviderServicesRequest.Builderavoiding the need to create one manually viaListProviderServicesRequest.builder()- Parameters:
listProviderServicesRequest- AConsumerthat will call methods onListProviderServicesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSchemaMappings
default CompletableFuture<ListSchemaMappingsResponse> listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest) Returns a list of all the
SchemaMappingsthat have been created for an Amazon Web Services account.- Parameters:
listSchemaMappingsRequest-- Returns:
- A Java Future containing the result of the ListSchemaMappings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSchemaMappings
default CompletableFuture<ListSchemaMappingsResponse> listSchemaMappings(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) Returns a list of all the
SchemaMappingsthat have been created for an Amazon Web Services account.
This is a convenience which creates an instance of the
ListSchemaMappingsRequest.Builderavoiding the need to create one manually viaListSchemaMappingsRequest.builder()- Parameters:
listSchemaMappingsRequest- AConsumerthat will call methods onListSchemaMappingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSchemaMappings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSchemaMappingsPaginator
default ListSchemaMappingsPublisher listSchemaMappingsPaginator(ListSchemaMappingsRequest listSchemaMappingsRequest) This is a variant of
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation.- Parameters:
listSchemaMappingsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSchemaMappingsPaginator
default ListSchemaMappingsPublisher listSchemaMappingsPaginator(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) This is a variant of
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)operation.
This is a convenience which creates an instance of the
ListSchemaMappingsRequest.Builderavoiding the need to create one manually viaListSchemaMappingsRequest.builder()- Parameters:
listSchemaMappingsRequest- AConsumerthat will call methods onListSchemaMappingsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with an Entity Resolution resource. In Entity Resolution,
SchemaMapping, andMatchingWorkflowcan be tagged.- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with an Entity Resolution resource. In Entity Resolution,
SchemaMapping, andMatchingWorkflowcan be tagged.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putPolicy
Updates the resource-based policy.
- Parameters:
putPolicyRequest-- Returns:
- A Java Future containing the result of the PutPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putPolicy
default CompletableFuture<PutPolicyResponse> putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Updates the resource-based policy.
This is a convenience which creates an instance of the
PutPolicyRequest.Builderavoiding the need to create one manually viaPutPolicyRequest.builder()- Parameters:
putPolicyRequest- AConsumerthat will call methods onPutPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startIdMappingJob
default CompletableFuture<StartIdMappingJobResponse> startIdMappingJob(StartIdMappingJobRequest startIdMappingJobRequest) Starts the
IdMappingJobof a workflow. The workflow must have previously been created using theCreateIdMappingWorkflowendpoint.- Parameters:
startIdMappingJobRequest-- Returns:
- A Java Future containing the result of the StartIdMappingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startIdMappingJob
default CompletableFuture<StartIdMappingJobResponse> startIdMappingJob(Consumer<StartIdMappingJobRequest.Builder> startIdMappingJobRequest) Starts the
IdMappingJobof a workflow. The workflow must have previously been created using theCreateIdMappingWorkflowendpoint.
This is a convenience which creates an instance of the
StartIdMappingJobRequest.Builderavoiding the need to create one manually viaStartIdMappingJobRequest.builder()- Parameters:
startIdMappingJobRequest- AConsumerthat will call methods onStartIdMappingJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartIdMappingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMatchingJob
default CompletableFuture<StartMatchingJobResponse> startMatchingJob(StartMatchingJobRequest startMatchingJobRequest) Starts the
MatchingJobof a workflow. The workflow must have previously been created using theCreateMatchingWorkflowendpoint.- Parameters:
startMatchingJobRequest-- Returns:
- A Java Future containing the result of the StartMatchingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMatchingJob
default CompletableFuture<StartMatchingJobResponse> startMatchingJob(Consumer<StartMatchingJobRequest.Builder> startMatchingJobRequest) Starts the
MatchingJobof a workflow. The workflow must have previously been created using theCreateMatchingWorkflowendpoint.
This is a convenience which creates an instance of the
StartMatchingJobRequest.Builderavoiding the need to create one manually viaStartMatchingJobRequest.builder()- Parameters:
startMatchingJobRequest- AConsumerthat will call methods onStartMatchingJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartMatchingJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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,
SchemaMappingandMatchingWorkflowcan be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use theTagResourceaction 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.- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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,
SchemaMappingandMatchingWorkflowcan be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use theTagResourceaction 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution,
SchemaMapping, andMatchingWorkflowcan be tagged.- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service.
- ResourceNotFoundException The resource could not be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution,
SchemaMapping, andMatchingWorkflowcan be tagged.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service.
- ResourceNotFoundException The resource could not be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdMappingWorkflow
default CompletableFuture<UpdateIdMappingWorkflowResponse> updateIdMappingWorkflow(UpdateIdMappingWorkflowRequest updateIdMappingWorkflowRequest) Updates an existing
IdMappingWorkflow. This method is identical toCreateIdMappingWorkflow, except it uses an HTTPPUTrequest instead of aPOSTrequest, and theIdMappingWorkflowmust already exist for the method to succeed.- Parameters:
updateIdMappingWorkflowRequest-- Returns:
- A Java Future containing the result of the UpdateIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdMappingWorkflow
default CompletableFuture<UpdateIdMappingWorkflowResponse> updateIdMappingWorkflow(Consumer<UpdateIdMappingWorkflowRequest.Builder> updateIdMappingWorkflowRequest) Updates an existing
IdMappingWorkflow. This method is identical toCreateIdMappingWorkflow, except it uses an HTTPPUTrequest instead of aPOSTrequest, and theIdMappingWorkflowmust already exist for the method to succeed.
This is a convenience which creates an instance of the
UpdateIdMappingWorkflowRequest.Builderavoiding the need to create one manually viaUpdateIdMappingWorkflowRequest.builder()- Parameters:
updateIdMappingWorkflowRequest- AConsumerthat will call methods onUpdateIdMappingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIdMappingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdNamespace
default CompletableFuture<UpdateIdNamespaceResponse> updateIdNamespace(UpdateIdNamespaceRequest updateIdNamespaceRequest) Updates an existing ID namespace.
- Parameters:
updateIdNamespaceRequest-- Returns:
- A Java Future containing the result of the UpdateIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdNamespace
default CompletableFuture<UpdateIdNamespaceResponse> updateIdNamespace(Consumer<UpdateIdNamespaceRequest.Builder> updateIdNamespaceRequest) Updates an existing ID namespace.
This is a convenience which creates an instance of the
UpdateIdNamespaceRequest.Builderavoiding the need to create one manually viaUpdateIdNamespaceRequest.builder()- Parameters:
updateIdNamespaceRequest- AConsumerthat will call methods onUpdateIdNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIdNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMatchingWorkflow
default CompletableFuture<UpdateMatchingWorkflowResponse> updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest) Updates an existing
MatchingWorkflow. This method is identical toCreateMatchingWorkflow, except it uses an HTTPPUTrequest instead of aPOSTrequest, and theMatchingWorkflowmust already exist for the method to succeed.- Parameters:
updateMatchingWorkflowRequest-- Returns:
- A Java Future containing the result of the UpdateMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMatchingWorkflow
default CompletableFuture<UpdateMatchingWorkflowResponse> updateMatchingWorkflow(Consumer<UpdateMatchingWorkflowRequest.Builder> updateMatchingWorkflowRequest) Updates an existing
MatchingWorkflow. This method is identical toCreateMatchingWorkflow, except it uses an HTTPPUTrequest instead of aPOSTrequest, and theMatchingWorkflowmust already exist for the method to succeed.
This is a convenience which creates an instance of the
UpdateMatchingWorkflowRequest.Builderavoiding the need to create one manually viaUpdateMatchingWorkflowRequest.builder()- Parameters:
updateMatchingWorkflowRequest- AConsumerthat will call methods onUpdateMatchingWorkflowRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateMatchingWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSchemaMapping
default CompletableFuture<UpdateSchemaMappingResponse> updateSchemaMapping(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.
- Parameters:
updateSchemaMappingRequest-- Returns:
- A Java Future containing the result of the UpdateSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSchemaMapping
default CompletableFuture<UpdateSchemaMappingResponse> updateSchemaMapping(Consumer<UpdateSchemaMappingRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateSchemaMappingRequest.Builderavoiding the need to create one manually viaUpdateSchemaMappingRequest.builder()- Parameters:
updateSchemaMappingRequest- AConsumerthat will call methods onUpdateSchemaMappingRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateSchemaMapping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EntityResolutionException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aEntityResolutionAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aEntityResolutionAsyncClient.
-