Package software.amazon.awssdk.services.entityresolution

Interface EntityResolutionAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EntityResolutionAsyncClient extends AwsClient
Service client for accessing AWSEntityResolution asynchronously. This can be created using the static builder() method.

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 Details

  • Method Details

    • createIdMappingWorkflow

      default CompletableFuture<CreateIdMappingWorkflowResponse> createIdMappingWorkflow(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest)

      Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.


      This is a convenience which creates an instance of the CreateIdMappingWorkflowRequest.Builder avoiding the need to create one manually via CreateIdMappingWorkflowRequest.builder()

      Parameters:
      createIdMappingWorkflowRequest - A Consumer that will call methods on CreateIdMappingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.


      This is a convenience which creates an instance of the CreateMatchingWorkflowRequest.Builder avoiding the need to create one manually via CreateMatchingWorkflowRequest.builder()

      Parameters:
      createMatchingWorkflowRequest - A Consumer that will call methods on CreateMatchingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.


      This is a convenience which creates an instance of the CreateSchemaMappingRequest.Builder avoiding the need to create one manually via CreateSchemaMappingRequest.builder()

      Parameters:
      createSchemaMappingRequest - A Consumer that will call methods on CreateSchemaMappingRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflow with 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflow with 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.Builder avoiding the need to create one manually via DeleteIdMappingWorkflowRequest.builder()

      Parameters:
      deleteIdMappingWorkflowRequest - A Consumer that will call methods on DeleteIdMappingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow with 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow with 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.Builder avoiding the need to create one manually via DeleteMatchingWorkflowRequest.builder()

      Parameters:
      deleteMatchingWorkflowRequest - A Consumer that will call methods on DeleteMatchingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.


      This is a convenience which creates an instance of the DeleteSchemaMappingRequest.Builder avoiding the need to create one manually via DeleteSchemaMappingRequest.builder()

      Parameters:
      deleteSchemaMappingRequest - A Consumer that will call methods on DeleteSchemaMappingRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via GetIdMappingJobRequest.builder()

      Parameters:
      getIdMappingJobRequest - A Consumer that will call methods on GetIdMappingJobRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflow with 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflow with a given name, if it exists.


      This is a convenience which creates an instance of the GetIdMappingWorkflowRequest.Builder avoiding the need to create one manually via GetIdMappingWorkflowRequest.builder()

      Parameters:
      getIdMappingWorkflowRequest - A Consumer that will call methods on GetIdMappingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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(GetMatchIdRequest getMatchIdRequest)

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via GetMatchIdRequest.builder()

      Parameters:
      getMatchIdRequest - A Consumer that will call methods on GetMatchIdRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via GetMatchingJobRequest.builder()

      Parameters:
      getMatchingJobRequest - A Consumer that will call methods on GetMatchingJobRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow with 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflow with a given name, if it exists.


      This is a convenience which creates an instance of the GetMatchingWorkflowRequest.Builder avoiding the need to create one manually via GetMatchingWorkflowRequest.builder()

      Parameters:
      getMatchingWorkflowRequest - A Consumer that will call methods on GetMatchingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 ProviderService of 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 ProviderService of a given name.


      This is a convenience which creates an instance of the GetProviderServiceRequest.Builder avoiding the need to create one manually via GetProviderServiceRequest.builder()

      Parameters:
      getProviderServiceRequest - A Consumer that will call methods on GetProviderServiceRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via GetSchemaMappingRequest.builder()

      Parameters:
      getSchemaMappingRequest - A Consumer that will call methods on GetSchemaMappingRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via ListIdMappingJobsRequest.builder()

      Parameters:
      listIdMappingJobsRequest - A Consumer that will call methods on ListIdMappingJobsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Lists all ID mapping jobs for a given workflow.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Lists all ID mapping jobs for a given workflow.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingJobsPublisher publisher = client.listIdMappingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListIdMappingJobsRequest.builder()

      Parameters:
      listIdMappingJobsRequest - A Consumer that will call methods on ListIdMappingJobsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflows that 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingWorkflows that have been created for an Amazon Web Services account.


      This is a convenience which creates an instance of the ListIdMappingWorkflowsRequest.Builder avoiding the need to create one manually via ListIdMappingWorkflowsRequest.builder()

      Parameters:
      listIdMappingWorkflowsRequest - A Consumer that will call methods on ListIdMappingWorkflowsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListIdMappingWorkflowsPublisher publisher = client.listIdMappingWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListIdMappingWorkflowsRequest.builder()

      Parameters:
      listIdMappingWorkflowsRequest - A Consumer that will call methods on ListIdMappingWorkflowsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via ListMatchingJobsRequest.builder()

      Parameters:
      listMatchingJobsRequest - A Consumer that will call methods on ListMatchingJobsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Lists all jobs for a given workflow.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Lists all jobs for a given workflow.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsPublisher publisher = client.listMatchingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListMatchingJobsRequest.builder()

      Parameters:
      listMatchingJobsRequest - A Consumer that will call methods on ListMatchingJobsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflows that 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingWorkflows that have been created for an Amazon Web Services account.


      This is a convenience which creates an instance of the ListMatchingWorkflowsRequest.Builder avoiding the need to create one manually via ListMatchingWorkflowsRequest.builder()

      Parameters:
      listMatchingWorkflowsRequest - A Consumer that will call methods on ListMatchingWorkflowsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsPublisher publisher = client.listMatchingWorkflowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListMatchingWorkflowsRequest.builder()

      Parameters:
      listMatchingWorkflowsRequest - A Consumer that will call methods on ListMatchingWorkflowsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 ProviderServices that 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 ProviderServices that are available in this Amazon Web Services Region.


      This is a convenience which creates an instance of the ListProviderServicesRequest.Builder avoiding the need to create one manually via ListProviderServicesRequest.builder()

      Parameters:
      listProviderServicesRequest - A Consumer that will call methods on ListProviderServicesRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListProviderServicesPublisher publisher = client.listProviderServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListProviderServicesRequest.builder()

      Parameters:
      listProviderServicesRequest - A Consumer that will call methods on ListProviderServicesRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMappings that 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 SchemaMappings that have been created for an Amazon Web Services account.


      This is a convenience which creates an instance of the ListSchemaMappingsRequest.Builder avoiding the need to create one manually via ListSchemaMappingsRequest.builder()

      Parameters:
      listSchemaMappingsRequest - A Consumer that will call methods on ListSchemaMappingsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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)

      Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.


      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 new Subscription i.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 
       
 software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsPublisher publisher = client.listSchemaMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListSchemaMappingsRequest.builder()

      Parameters:
      listSchemaMappingsRequest - A Consumer that will call methods on ListSchemaMappingsRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 , and MatchingWorkflow can 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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 , and MatchingWorkflow can be tagged.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to 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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.


      This is a convenience which creates an instance of the StartIdMappingJobRequest.Builder avoiding the need to create one manually via StartIdMappingJobRequest.builder()

      Parameters:
      startIdMappingJobRequest - A Consumer that will call methods on StartIdMappingJobRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.


      This is a convenience which creates an instance of the StartMatchingJobRequest.Builder avoiding the need to create one manually via StartMatchingJobRequest.builder()

      Parameters:
      startMatchingJobRequest - A Consumer that will call methods on StartMatchingJobRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ExceedsLimitException The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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(TagResourceRequest tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

      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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to 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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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, and MatchingWorkflow can 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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • 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, and MatchingWorkflow can be tagged.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to 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.
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • 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 to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.


      This is a convenience which creates an instance of the UpdateIdMappingWorkflowRequest.Builder avoiding the need to create one manually via UpdateIdMappingWorkflowRequest.builder()

      Parameters:
      updateIdMappingWorkflowRequest - A Consumer that will call methods on UpdateIdMappingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.

      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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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 to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.


      This is a convenience which creates an instance of the UpdateMatchingWorkflowRequest.Builder avoiding the need to create one manually via UpdateMatchingWorkflowRequest.builder()

      Parameters:
      updateMatchingWorkflowRequest - A Consumer that will call methods on UpdateMatchingWorkflowRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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.Builder avoiding the need to create one manually via UpdateSchemaMappingRequest.builder()

      Parameters:
      updateSchemaMappingRequest - A Consumer that will call methods on UpdateSchemaMappingRequest.Builder to 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.
      • ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429
      • InternalServerException This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500
      • ResourceNotFoundException The resource could not be found. HTTP Status Code: 404
      • AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403
      • ConflictException The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
      • ValidationException The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400
      • 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

      default EntityResolutionServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static EntityResolutionAsyncClient create()
      Create a EntityResolutionAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static EntityResolutionAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EntityResolutionAsyncClient.