@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EntityResolutionClient extends AwsClient
builder() method.
Welcome to the AWS Entity Resolution API Reference.
AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.
With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address.
To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the AWS Entity Resolution User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static EntityResolutionClientBuilder |
builder()
Create a builder that can be used to configure and create a
EntityResolutionClient. |
static EntityResolutionClient |
create()
Create a
EntityResolutionClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateMatchingWorkflowResponse |
createMatchingWorkflow(Consumer<CreateMatchingWorkflowRequest.Builder> createMatchingWorkflowRequest)
Creates a
MatchingWorkflow object which stores the configuration of the data processing job to be
run. |
default CreateMatchingWorkflowResponse |
createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest)
Creates a
MatchingWorkflow object which stores the configuration of the data processing job to be
run. |
default CreateSchemaMappingResponse |
createSchemaMapping(Consumer<CreateSchemaMappingRequest.Builder> createSchemaMappingRequest)
Creates a schema mapping, which defines the schema of the input customer records table.
|
default CreateSchemaMappingResponse |
createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest)
Creates a schema mapping, which defines the schema of the input customer records table.
|
default DeleteMatchingWorkflowResponse |
deleteMatchingWorkflow(Consumer<DeleteMatchingWorkflowRequest.Builder> deleteMatchingWorkflowRequest)
Deletes the
MatchingWorkflow with a given name. |
default DeleteMatchingWorkflowResponse |
deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest)
Deletes the
MatchingWorkflow with a given name. |
default DeleteSchemaMappingResponse |
deleteSchemaMapping(Consumer<DeleteSchemaMappingRequest.Builder> deleteSchemaMappingRequest)
Deletes the
SchemaMapping with a given name. |
default DeleteSchemaMappingResponse |
deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest)
Deletes the
SchemaMapping with a given name. |
default GetMatchIdResponse |
getMatchId(Consumer<GetMatchIdRequest.Builder> getMatchIdRequest)
Returns the corresponding Match ID of a customer record if the record has been processed.
|
default GetMatchIdResponse |
getMatchId(GetMatchIdRequest getMatchIdRequest)
Returns the corresponding Match ID of a customer record if the record has been processed.
|
default GetMatchingJobResponse |
getMatchingJob(Consumer<GetMatchingJobRequest.Builder> getMatchingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
|
default GetMatchingJobResponse |
getMatchingJob(GetMatchingJobRequest getMatchingJobRequest)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
|
default GetMatchingWorkflowResponse |
getMatchingWorkflow(Consumer<GetMatchingWorkflowRequest.Builder> getMatchingWorkflowRequest)
Returns the
MatchingWorkflow with a given name, if it exists. |
default GetMatchingWorkflowResponse |
getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest)
Returns the
MatchingWorkflow with a given name, if it exists. |
default GetSchemaMappingResponse |
getSchemaMapping(Consumer<GetSchemaMappingRequest.Builder> getSchemaMappingRequest)
Returns the SchemaMapping of a given name.
|
default GetSchemaMappingResponse |
getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest)
Returns the SchemaMapping of a given name.
|
default ListMatchingJobsResponse |
listMatchingJobs(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest)
Lists all jobs for a given workflow.
|
default ListMatchingJobsResponse |
listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest)
Lists all jobs for a given workflow.
|
default ListMatchingJobsIterable |
listMatchingJobsPaginator(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest)
Lists all jobs for a given workflow.
|
default ListMatchingJobsIterable |
listMatchingJobsPaginator(ListMatchingJobsRequest listMatchingJobsRequest)
Lists all jobs for a given workflow.
|
default ListMatchingWorkflowsResponse |
listMatchingWorkflows(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest)
Returns a list of all the
MatchingWorkflows that have been created for an AWS account. |
default ListMatchingWorkflowsResponse |
listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest)
Returns a list of all the
MatchingWorkflows that have been created for an AWS account. |
default ListMatchingWorkflowsIterable |
listMatchingWorkflowsPaginator(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest)
Returns a list of all the
MatchingWorkflows that have been created for an AWS account. |
default ListMatchingWorkflowsIterable |
listMatchingWorkflowsPaginator(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest)
Returns a list of all the
MatchingWorkflows that have been created for an AWS account. |
default ListSchemaMappingsResponse |
listSchemaMappings(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest)
Returns a list of all the
SchemaMappings that have been created for an AWS account. |
default ListSchemaMappingsResponse |
listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest)
Returns a list of all the
SchemaMappings that have been created for an AWS account. |
default ListSchemaMappingsIterable |
listSchemaMappingsPaginator(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest)
Returns a list of all the
SchemaMappings that have been created for an AWS account. |
default ListSchemaMappingsIterable |
listSchemaMappingsPaginator(ListSchemaMappingsRequest listSchemaMappingsRequest)
Returns a list of all the
SchemaMappings that have been created for an AWS account. |
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with an AWS Entity Resolution resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an AWS Entity Resolution resource.
|
default EntityResolutionServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartMatchingJobResponse |
startMatchingJob(Consumer<StartMatchingJobRequest.Builder> startMatchingJobRequest)
Starts the
MatchingJob of a workflow. |
default StartMatchingJobResponse |
startMatchingJob(StartMatchingJobRequest startMatchingJobRequest)
Starts the
MatchingJob of a workflow. |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified AWS Entity Resolution resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified AWS Entity Resolution resource.
|
default UpdateMatchingWorkflowResponse |
updateMatchingWorkflow(Consumer<UpdateMatchingWorkflowRequest.Builder> updateMatchingWorkflowRequest)
Updates an existing
MatchingWorkflow. |
default UpdateMatchingWorkflowResponse |
updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest)
Updates an existing
MatchingWorkflow. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateMatchingWorkflowResponse createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Creates a MatchingWorkflow object which stores the configuration of the data processing job to be
run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same
name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
createMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault CreateMatchingWorkflowResponse createMatchingWorkflow(Consumer<CreateMatchingWorkflowRequest.Builder> createMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
createMatchingWorkflowRequest - A Consumer that will call methods on CreateMatchingWorkflowInput.Builder to create a
request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault CreateSchemaMappingResponse createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Creates a schema mapping, which defines the schema of the input customer records table. The
SchemaMapping also provides Entity Resolution with some metadata about the table, such as the
attribute types of the columns and which columns to match on.
createSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault CreateSchemaMappingResponse createSchemaMapping(Consumer<CreateSchemaMappingRequest.Builder> createSchemaMappingRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
createSchemaMappingRequest - A Consumer that will call methods on CreateSchemaMappingInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault DeleteMatchingWorkflowResponse deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with
the given name does not exist.
deleteMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault DeleteMatchingWorkflowResponse deleteMatchingWorkflow(Consumer<DeleteMatchingWorkflowRequest.Builder> deleteMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
deleteMatchingWorkflowRequest - A Consumer that will call methods on DeleteMatchingWorkflowInput.Builder to create a
request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault DeleteSchemaMappingResponse deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the
given name does not exist. This operation will fail if there is a DataIntegrationWorkflow object
that references the SchemaMapping in the workflow's InputSourceConfig.
deleteSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault DeleteSchemaMappingResponse deleteSchemaMapping(Consumer<DeleteSchemaMappingRequest.Builder> deleteSchemaMappingRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the
given name does not exist. This operation will fail if there is a DataIntegrationWorkflow object
that references the SchemaMapping in the workflow's InputSourceConfig.
This is a convenience which creates an instance of the DeleteSchemaMappingRequest.Builder avoiding the
need to create one manually via DeleteSchemaMappingRequest.builder()
deleteSchemaMappingRequest - A Consumer that will call methods on DeleteSchemaMappingInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchIdResponse getMatchId(GetMatchIdRequest getMatchIdRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns the corresponding Match ID of a customer record if the record has been processed.
getMatchIdRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchIdResponse getMatchId(Consumer<GetMatchIdRequest.Builder> getMatchIdRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
getMatchIdRequest - A Consumer that will call methods on GetMatchIdInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchingJobResponse getMatchingJob(GetMatchingJobRequest getMatchingJobRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Gets the status, metrics, and errors (if there are any) that are associated with a job.
getMatchingJobRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchingJobResponse getMatchingJob(Consumer<GetMatchingJobRequest.Builder> getMatchingJobRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
getMatchingJobRequest - A Consumer that will call methods on GetMatchingJobInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchingWorkflowResponse getMatchingWorkflow(GetMatchingWorkflowRequest getMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns the MatchingWorkflow with a given name, if it exists.
getMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetMatchingWorkflowResponse getMatchingWorkflow(Consumer<GetMatchingWorkflowRequest.Builder> getMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
getMatchingWorkflowRequest - A Consumer that will call methods on GetMatchingWorkflowInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetSchemaMappingResponse getSchemaMapping(GetSchemaMappingRequest getSchemaMappingRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns the SchemaMapping of a given name.
getSchemaMappingRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault GetSchemaMappingResponse getSchemaMapping(Consumer<GetSchemaMappingRequest.Builder> getSchemaMappingRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
getSchemaMappingRequest - A Consumer that will call methods on GetSchemaMappingInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingJobsResponse listMatchingJobs(ListMatchingJobsRequest listMatchingJobsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Lists all jobs for a given workflow.
listMatchingJobsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingJobsResponse listMatchingJobs(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
listMatchingJobsRequest - A Consumer that will call methods on ListMatchingJobsInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingJobsIterable listMatchingJobsPaginator(ListMatchingJobsRequest listMatchingJobsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client.listMatchingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client
.listMatchingJobsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client.listMatchingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listMatchingJobsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingJobsIterable listMatchingJobsPaginator(Consumer<ListMatchingJobsRequest.Builder> listMatchingJobsRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client.listMatchingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client
.listMatchingJobsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListMatchingJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingJobsIterable responses = client.listMatchingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listMatchingJobsRequest - A Consumer that will call methods on ListMatchingJobsInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingWorkflowsResponse listMatchingWorkflows(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
listMatchingWorkflowsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingWorkflowsResponse listMatchingWorkflows(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
This is a convenience which creates an instance of the ListMatchingWorkflowsRequest.Builder avoiding the
need to create one manually via ListMatchingWorkflowsRequest.builder()
listMatchingWorkflowsRequest - A Consumer that will call methods on ListMatchingWorkflowsInput.Builder to create a
request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingWorkflowsIterable listMatchingWorkflowsPaginator(ListMatchingWorkflowsRequest listMatchingWorkflowsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
This is a variant of
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client.listMatchingWorkflowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client
.listMatchingWorkflowsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client.listMatchingWorkflowsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listMatchingWorkflowsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListMatchingWorkflowsIterable listMatchingWorkflowsPaginator(Consumer<ListMatchingWorkflowsRequest.Builder> listMatchingWorkflowsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
This is a variant of
listMatchingWorkflows(software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client.listMatchingWorkflowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client
.listMatchingWorkflowsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListMatchingWorkflowsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListMatchingWorkflowsIterable responses = client.listMatchingWorkflowsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listMatchingWorkflowsRequest - A Consumer that will call methods on ListMatchingWorkflowsInput.Builder to create a
request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListSchemaMappingsResponse listSchemaMappings(ListSchemaMappingsRequest listSchemaMappingsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the SchemaMappings that have been created for an AWS account.
listSchemaMappingsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListSchemaMappingsResponse listSchemaMappings(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the SchemaMappings that have been created for an AWS account.
This is a convenience which creates an instance of the ListSchemaMappingsRequest.Builder avoiding the
need to create one manually via ListSchemaMappingsRequest.builder()
listSchemaMappingsRequest - A Consumer that will call methods on ListSchemaMappingsInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListSchemaMappingsIterable listSchemaMappingsPaginator(ListSchemaMappingsRequest listSchemaMappingsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the SchemaMappings that have been created for an AWS account.
This is a variant of
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client.listSchemaMappingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client
.listSchemaMappingsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client.listSchemaMappingsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listSchemaMappingsRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListSchemaMappingsIterable listSchemaMappingsPaginator(Consumer<ListSchemaMappingsRequest.Builder> listSchemaMappingsRequest) throws ThrottlingException, InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Returns a list of all the SchemaMappings that have been created for an AWS account.
This is a variant of
listSchemaMappings(software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client.listSchemaMappingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client
.listSchemaMappingsPaginator(request);
for (software.amazon.awssdk.services.entityresolution.model.ListSchemaMappingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.entityresolution.paginators.ListSchemaMappingsIterable responses = client.listSchemaMappingsPaginator(request);
responses.iterator().forEachRemaining(....);
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()
listSchemaMappingsRequest - A Consumer that will call methods on ListSchemaMappingsInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
listTagsForResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Displays the tags associated with an AWS 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault StartMatchingJobResponse startMatchingJob(StartMatchingJobRequest startMatchingJobRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Starts the MatchingJob of a workflow. The workflow must have previously been created using the
CreateMatchingWorkflow endpoint.
startMatchingJobRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault StartMatchingJobResponse startMatchingJob(Consumer<StartMatchingJobRequest.Builder> startMatchingJobRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ExceedsLimitException, ConflictException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
startMatchingJobRequest - A Consumer that will call methods on StartMatchingJobInput.Builder to create a request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current AWS Entity
Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402ConflictException - 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: 400ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you
organize and categorize your resources. You can also use them to scope user permissions by granting a user
permission to access or change only resources with certain tag values. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic meaning
to AWS and are interpreted strictly as strings of characters. You can use the TagResource action
with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags
associated with the resource. If you specify a tag key that is already associated with the resource, the new tag
value that you specify replaces the previous value for that tag.
tagResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you
organize and categorize your resources. You can also use them to scope user permissions by granting a user
permission to access or change only resources with certain tag values. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged. Tags don't have any semantic meaning
to AWS and are interpreted strictly as strings of characters. You can use the TagResource action
with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags
associated with the resource. If you specify a tag key that is already associated with the resource, the new tag
value that you specify replaces the previous value for that tag.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EntityResolutionException
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
untagResourceRequest - InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404SdkException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EntityResolutionException
Removes one or more tags from the specified AWS 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404SdkException - 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.AwsServiceExceptiondefault UpdateMatchingWorkflowResponse updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
Updates an existing MatchingWorkflow. This method is identical to
CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a
POST request, and the MatchingWorkflow must already exist for the method to succeed.
updateMatchingWorkflowRequest - ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptiondefault UpdateMatchingWorkflowResponse updateMatchingWorkflow(Consumer<UpdateMatchingWorkflowRequest.Builder> updateMatchingWorkflowRequest) throws ThrottlingException, InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, EntityResolutionException
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()
updateMatchingWorkflowRequest - A Consumer that will call methods on UpdateMatchingWorkflowInput.Builder to create a
request.ThrottlingException - The request was denied due to request throttling. HTTP Status Code: 429InternalServerException - This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500ResourceNotFoundException - The resource could not be found. HTTP Status Code: 404AccessDeniedException - You do not have sufficient access to perform this action. HTTP Status Code: 403ValidationException - The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400SdkException - 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.AwsServiceExceptionstatic EntityResolutionClient create()
EntityResolutionClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EntityResolutionClientBuilder builder()
EntityResolutionClient.static ServiceMetadata serviceMetadata()
default EntityResolutionServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.