EntityResolutionClient#
Index > EntityResolution > EntityResolutionClient
Auto-generated documentation for EntityResolution type annotations stubs module types-aiobotocore-entityresolution.
EntityResolutionClient#
Type annotations and code completion for session.client("entityresolution")
boto3 documentation
# EntityResolutionClient usage example
from aioboto3.session import Session
from types_aiobotocore_entityresolution.client import EntityResolutionClient
session = Session()
async with session.client("entityresolution") as client:
client: EntityResolutionClient
Exceptions#
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("entityresolution").exceptions
structure.
# EntityResolutionClient.exceptions usage example
async with session.client("entityresolution") as client:
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ExceedsLimitException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# EntityResolutionClient.exceptions type checking example
from types_aiobotocore_entityresolution.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.client("entityresolution").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.client("entityresolution").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_id_mapping_workflow#
Creates an IdMappingWorkflow
object which stores the configuration of the
data processing job to be
run.
Type annotations and code completion for session.client("entityresolution").create_id_mapping_workflow
method.
boto3 documentation
# create_id_mapping_workflow method definition
await def create_id_mapping_workflow(
self,
*,
idMappingTechniques: IdMappingTechniquesTypeDef, # (1)
inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef], # (2)
outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef], # (3)
roleArn: str,
workflowName: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateIdMappingWorkflowOutputTypeDef: # (4)
...
- See IdMappingTechniquesTypeDef
- See IdMappingWorkflowInputSourceTypeDef
- See IdMappingWorkflowOutputSourceTypeDef
- See CreateIdMappingWorkflowOutputTypeDef
# create_id_mapping_workflow method usage example with argument unpacking
kwargs: CreateIdMappingWorkflowInputRequestTypeDef = { # (1)
"idMappingTechniques": ...,
"inputSourceConfig": ...,
"outputSourceConfig": ...,
"roleArn": ...,
"workflowName": ...,
}
parent.create_id_mapping_workflow(**kwargs)
create_matching_workflow#
Creates a MatchingWorkflow
object which stores the configuration of the data
processing job to be
run.
Type annotations and code completion for session.client("entityresolution").create_matching_workflow
method.
boto3 documentation
# create_matching_workflow method definition
await def create_matching_workflow(
self,
*,
inputSourceConfig: Sequence[InputSourceTypeDef], # (1)
outputSourceConfig: Sequence[OutputSourceTypeDef], # (2)
resolutionTechniques: ResolutionTechniquesTypeDef, # (3)
roleArn: str,
workflowName: str,
description: str = ...,
incrementalRunConfig: IncrementalRunConfigTypeDef = ..., # (4)
tags: Mapping[str, str] = ...,
) -> CreateMatchingWorkflowOutputTypeDef: # (5)
...
- See InputSourceTypeDef
- See OutputSourceTypeDef
- See ResolutionTechniquesTypeDef
- See IncrementalRunConfigTypeDef
- See CreateMatchingWorkflowOutputTypeDef
# create_matching_workflow method usage example with argument unpacking
kwargs: CreateMatchingWorkflowInputRequestTypeDef = { # (1)
"inputSourceConfig": ...,
"outputSourceConfig": ...,
"resolutionTechniques": ...,
"roleArn": ...,
"workflowName": ...,
}
parent.create_matching_workflow(**kwargs)
create_schema_mapping#
Creates a schema mapping, which defines the schema of the input customer records table.
Type annotations and code completion for session.client("entityresolution").create_schema_mapping
method.
boto3 documentation
# create_schema_mapping method definition
await def create_schema_mapping(
self,
*,
mappedInputFields: Sequence[SchemaInputAttributeTypeDef], # (1)
schemaName: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateSchemaMappingOutputTypeDef: # (2)
...
# create_schema_mapping method usage example with argument unpacking
kwargs: CreateSchemaMappingInputRequestTypeDef = { # (1)
"mappedInputFields": ...,
"schemaName": ...,
}
parent.create_schema_mapping(**kwargs)
delete_id_mapping_workflow#
Deletes the IdMappingWorkflow
with a given name.
Type annotations and code completion for session.client("entityresolution").delete_id_mapping_workflow
method.
boto3 documentation
# delete_id_mapping_workflow method definition
await def delete_id_mapping_workflow(
self,
*,
workflowName: str,
) -> DeleteIdMappingWorkflowOutputTypeDef: # (1)
...
# delete_id_mapping_workflow method usage example with argument unpacking
kwargs: DeleteIdMappingWorkflowInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.delete_id_mapping_workflow(**kwargs)
delete_matching_workflow#
Deletes the MatchingWorkflow
with a given name.
Type annotations and code completion for session.client("entityresolution").delete_matching_workflow
method.
boto3 documentation
# delete_matching_workflow method definition
await def delete_matching_workflow(
self,
*,
workflowName: str,
) -> DeleteMatchingWorkflowOutputTypeDef: # (1)
...
# delete_matching_workflow method usage example with argument unpacking
kwargs: DeleteMatchingWorkflowInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.delete_matching_workflow(**kwargs)
delete_schema_mapping#
Deletes the SchemaMapping
with a given name.
Type annotations and code completion for session.client("entityresolution").delete_schema_mapping
method.
boto3 documentation
# delete_schema_mapping method definition
await def delete_schema_mapping(
self,
*,
schemaName: str,
) -> DeleteSchemaMappingOutputTypeDef: # (1)
...
# delete_schema_mapping method usage example with argument unpacking
kwargs: DeleteSchemaMappingInputRequestTypeDef = { # (1)
"schemaName": ...,
}
parent.delete_schema_mapping(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("entityresolution").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_id_mapping_job#
Gets the status, metrics, and errors (if there are any) that are associated with a job.
Type annotations and code completion for session.client("entityresolution").get_id_mapping_job
method.
boto3 documentation
# get_id_mapping_job method definition
await def get_id_mapping_job(
self,
*,
jobId: str,
workflowName: str,
) -> GetIdMappingJobOutputTypeDef: # (1)
...
# get_id_mapping_job method usage example with argument unpacking
kwargs: GetIdMappingJobInputRequestTypeDef = { # (1)
"jobId": ...,
"workflowName": ...,
}
parent.get_id_mapping_job(**kwargs)
get_id_mapping_workflow#
Returns the IdMappingWorkflow
with a given name, if it exists.
Type annotations and code completion for session.client("entityresolution").get_id_mapping_workflow
method.
boto3 documentation
# get_id_mapping_workflow method definition
await def get_id_mapping_workflow(
self,
*,
workflowName: str,
) -> GetIdMappingWorkflowOutputTypeDef: # (1)
...
# get_id_mapping_workflow method usage example with argument unpacking
kwargs: GetIdMappingWorkflowInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.get_id_mapping_workflow(**kwargs)
get_match_id#
Returns the corresponding Match ID of a customer record if the record has been processed.
Type annotations and code completion for session.client("entityresolution").get_match_id
method.
boto3 documentation
# get_match_id method definition
await def get_match_id(
self,
*,
record: Mapping[str, str],
workflowName: str,
) -> GetMatchIdOutputTypeDef: # (1)
...
# get_match_id method usage example with argument unpacking
kwargs: GetMatchIdInputRequestTypeDef = { # (1)
"record": ...,
"workflowName": ...,
}
parent.get_match_id(**kwargs)
get_matching_job#
Gets the status, metrics, and errors (if there are any) that are associated with a job.
Type annotations and code completion for session.client("entityresolution").get_matching_job
method.
boto3 documentation
# get_matching_job method definition
await def get_matching_job(
self,
*,
jobId: str,
workflowName: str,
) -> GetMatchingJobOutputTypeDef: # (1)
...
# get_matching_job method usage example with argument unpacking
kwargs: GetMatchingJobInputRequestTypeDef = { # (1)
"jobId": ...,
"workflowName": ...,
}
parent.get_matching_job(**kwargs)
get_matching_workflow#
Returns the MatchingWorkflow
with a given name, if it exists.
Type annotations and code completion for session.client("entityresolution").get_matching_workflow
method.
boto3 documentation
# get_matching_workflow method definition
await def get_matching_workflow(
self,
*,
workflowName: str,
) -> GetMatchingWorkflowOutputTypeDef: # (1)
...
# get_matching_workflow method usage example with argument unpacking
kwargs: GetMatchingWorkflowInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.get_matching_workflow(**kwargs)
get_provider_service#
Returns the ProviderService
of a given name.
Type annotations and code completion for session.client("entityresolution").get_provider_service
method.
boto3 documentation
# get_provider_service method definition
await def get_provider_service(
self,
*,
providerName: str,
providerServiceName: str,
) -> GetProviderServiceOutputTypeDef: # (1)
...
# get_provider_service method usage example with argument unpacking
kwargs: GetProviderServiceInputRequestTypeDef = { # (1)
"providerName": ...,
"providerServiceName": ...,
}
parent.get_provider_service(**kwargs)
get_schema_mapping#
Returns the SchemaMapping of a given name.
Type annotations and code completion for session.client("entityresolution").get_schema_mapping
method.
boto3 documentation
# get_schema_mapping method definition
await def get_schema_mapping(
self,
*,
schemaName: str,
) -> GetSchemaMappingOutputTypeDef: # (1)
...
# get_schema_mapping method usage example with argument unpacking
kwargs: GetSchemaMappingInputRequestTypeDef = { # (1)
"schemaName": ...,
}
parent.get_schema_mapping(**kwargs)
list_id_mapping_jobs#
Lists all ID mapping jobs for a given workflow.
Type annotations and code completion for session.client("entityresolution").list_id_mapping_jobs
method.
boto3 documentation
# list_id_mapping_jobs method definition
await def list_id_mapping_jobs(
self,
*,
workflowName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListIdMappingJobsOutputTypeDef: # (1)
...
# list_id_mapping_jobs method usage example with argument unpacking
kwargs: ListIdMappingJobsInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.list_id_mapping_jobs(**kwargs)
list_id_mapping_workflows#
Returns a list of all the IdMappingWorkflows
that have been created for an
Amazon Web Services
account.
Type annotations and code completion for session.client("entityresolution").list_id_mapping_workflows
method.
boto3 documentation
# list_id_mapping_workflows method definition
await def list_id_mapping_workflows(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListIdMappingWorkflowsOutputTypeDef: # (1)
...
# list_id_mapping_workflows method usage example with argument unpacking
kwargs: ListIdMappingWorkflowsInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_id_mapping_workflows(**kwargs)
list_matching_jobs#
Lists all jobs for a given workflow.
Type annotations and code completion for session.client("entityresolution").list_matching_jobs
method.
boto3 documentation
# list_matching_jobs method definition
await def list_matching_jobs(
self,
*,
workflowName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListMatchingJobsOutputTypeDef: # (1)
...
# list_matching_jobs method usage example with argument unpacking
kwargs: ListMatchingJobsInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.list_matching_jobs(**kwargs)
list_matching_workflows#
Returns a list of all the MatchingWorkflows
that have been created for an
Amazon Web Services
account.
Type annotations and code completion for session.client("entityresolution").list_matching_workflows
method.
boto3 documentation
# list_matching_workflows method definition
await def list_matching_workflows(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListMatchingWorkflowsOutputTypeDef: # (1)
...
# list_matching_workflows method usage example with argument unpacking
kwargs: ListMatchingWorkflowsInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_matching_workflows(**kwargs)
list_provider_services#
Returns a list of all the ProviderServices
that are available in this Amazon
Web Services
Region.
Type annotations and code completion for session.client("entityresolution").list_provider_services
method.
boto3 documentation
# list_provider_services method definition
await def list_provider_services(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
providerName: str = ...,
) -> ListProviderServicesOutputTypeDef: # (1)
...
# list_provider_services method usage example with argument unpacking
kwargs: ListProviderServicesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_provider_services(**kwargs)
list_schema_mappings#
Returns a list of all the SchemaMappings
that have been created for an Amazon
Web Services
account.
Type annotations and code completion for session.client("entityresolution").list_schema_mappings
method.
boto3 documentation
# list_schema_mappings method definition
await def list_schema_mappings(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSchemaMappingsOutputTypeDef: # (1)
...
# list_schema_mappings method usage example with argument unpacking
kwargs: ListSchemaMappingsInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_schema_mappings(**kwargs)
list_tags_for_resource#
Displays the tags associated with an Entity Resolution resource.
Type annotations and code completion for session.client("entityresolution").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_id_mapping_job#
Starts the IdMappingJob
of a workflow.
Type annotations and code completion for session.client("entityresolution").start_id_mapping_job
method.
boto3 documentation
# start_id_mapping_job method definition
await def start_id_mapping_job(
self,
*,
workflowName: str,
) -> StartIdMappingJobOutputTypeDef: # (1)
...
# start_id_mapping_job method usage example with argument unpacking
kwargs: StartIdMappingJobInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.start_id_mapping_job(**kwargs)
start_matching_job#
Starts the MatchingJob
of a workflow.
Type annotations and code completion for session.client("entityresolution").start_matching_job
method.
boto3 documentation
# start_matching_job method definition
await def start_matching_job(
self,
*,
workflowName: str,
) -> StartMatchingJobOutputTypeDef: # (1)
...
# start_matching_job method usage example with argument unpacking
kwargs: StartMatchingJobInputRequestTypeDef = { # (1)
"workflowName": ...,
}
parent.start_matching_job(**kwargs)
tag_resource#
Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.
Type annotations and code completion for session.client("entityresolution").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes one or more tags from the specified Entity Resolution resource.
Type annotations and code completion for session.client("entityresolution").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_id_mapping_workflow#
Updates an existing IdMappingWorkflow
.
Type annotations and code completion for session.client("entityresolution").update_id_mapping_workflow
method.
boto3 documentation
# update_id_mapping_workflow method definition
await def update_id_mapping_workflow(
self,
*,
idMappingTechniques: IdMappingTechniquesTypeDef, # (1)
inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef], # (2)
outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef], # (3)
roleArn: str,
workflowName: str,
description: str = ...,
) -> UpdateIdMappingWorkflowOutputTypeDef: # (4)
...
- See IdMappingTechniquesTypeDef
- See IdMappingWorkflowInputSourceTypeDef
- See IdMappingWorkflowOutputSourceTypeDef
- See UpdateIdMappingWorkflowOutputTypeDef
# update_id_mapping_workflow method usage example with argument unpacking
kwargs: UpdateIdMappingWorkflowInputRequestTypeDef = { # (1)
"idMappingTechniques": ...,
"inputSourceConfig": ...,
"outputSourceConfig": ...,
"roleArn": ...,
"workflowName": ...,
}
parent.update_id_mapping_workflow(**kwargs)
update_matching_workflow#
Updates an existing MatchingWorkflow
.
Type annotations and code completion for session.client("entityresolution").update_matching_workflow
method.
boto3 documentation
# update_matching_workflow method definition
await def update_matching_workflow(
self,
*,
inputSourceConfig: Sequence[InputSourceTypeDef], # (1)
outputSourceConfig: Sequence[OutputSourceTypeDef], # (2)
resolutionTechniques: ResolutionTechniquesTypeDef, # (3)
roleArn: str,
workflowName: str,
description: str = ...,
incrementalRunConfig: IncrementalRunConfigTypeDef = ..., # (4)
) -> UpdateMatchingWorkflowOutputTypeDef: # (5)
...
- See InputSourceTypeDef
- See OutputSourceTypeDef
- See ResolutionTechniquesTypeDef
- See IncrementalRunConfigTypeDef
- See UpdateMatchingWorkflowOutputTypeDef
# update_matching_workflow method usage example with argument unpacking
kwargs: UpdateMatchingWorkflowInputRequestTypeDef = { # (1)
"inputSourceConfig": ...,
"outputSourceConfig": ...,
"resolutionTechniques": ...,
"roleArn": ...,
"workflowName": ...,
}
parent.update_matching_workflow(**kwargs)
update_schema_mapping#
Updates a schema mapping.
Type annotations and code completion for session.client("entityresolution").update_schema_mapping
method.
boto3 documentation
# update_schema_mapping method definition
await def update_schema_mapping(
self,
*,
mappedInputFields: Sequence[SchemaInputAttributeTypeDef], # (1)
schemaName: str,
description: str = ...,
) -> UpdateSchemaMappingOutputTypeDef: # (2)
...
# update_schema_mapping method usage example with argument unpacking
kwargs: UpdateSchemaMappingInputRequestTypeDef = { # (1)
"mappedInputFields": ...,
"schemaName": ...,
}
parent.update_schema_mapping(**kwargs)
__aenter__#
Type annotations and code completion for session.client("entityresolution").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> EntityResolutionClient:
...
__aexit__#
Type annotations and code completion for session.client("entityresolution").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.client("entityresolution").get_paginator
method with overloads.
client.get_paginator("list_id_mapping_jobs")
-> ListIdMappingJobsPaginatorclient.get_paginator("list_id_mapping_workflows")
-> ListIdMappingWorkflowsPaginatorclient.get_paginator("list_matching_jobs")
-> ListMatchingJobsPaginatorclient.get_paginator("list_matching_workflows")
-> ListMatchingWorkflowsPaginatorclient.get_paginator("list_provider_services")
-> ListProviderServicesPaginatorclient.get_paginator("list_schema_mappings")
-> ListSchemaMappingsPaginator