EntityResolutionClient

Index > EntityResolution > EntityResolutionClient

Auto-generated documentation for EntityResolution type annotations stubs module types-aiobotocore-entityresolution.

EntityResolutionClient

Type annotations and code completion for session.create_client("entityresolution") boto3 documentation

EntityResolutionClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_entityresolution.client import EntityResolutionClient

session = get_session()
async with session.create_client("entityresolution") as client:
    client: EntityResolutionClient

Exceptions

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("entityresolution").exceptions structure.

EntityResolutionClient.exceptions usage example

async with session.create_client("entityresolution") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.ExceedsLimitException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)

EntityResolutionClient usage 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.create_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.create_client("entityresolution").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

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

1. See InputSourceTypeDef
2. See OutputSourceTypeDef
3. See ResolutionTechniquesTypeDef
4. See IncrementalRunConfigTypeDef
5. See CreateMatchingWorkflowOutputTypeDef

# create_matching_workflow method usage example with argument unpacking

kwargs: CreateMatchingWorkflowInputRequestTypeDef = {  # (1)
    "inputSourceConfig": ...,
    "outputSourceConfig": ...,
    "resolutionTechniques": ...,
    "roleArn": ...,
    "workflowName": ...,
}

parent.create_matching_workflow(**kwargs)

1. See CreateMatchingWorkflowInputRequestTypeDef

create_schema_mapping

Creates a schema mapping, which defines the schema of the input customer records table.

Type annotations and code completion for session.create_client("entityresolution").create_schema_mapping method. boto3 documentation

# create_schema_mapping method definition

await def create_schema_mapping(
    self,
    *,
    schemaName: str,
    description: str = ...,
    mappedInputFields: Sequence[SchemaInputAttributeTypeDef] = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateSchemaMappingOutputTypeDef:  # (2)
    ...

1. See SchemaInputAttributeTypeDef
2. See CreateSchemaMappingOutputTypeDef

# create_schema_mapping method usage example with argument unpacking

kwargs: CreateSchemaMappingInputRequestTypeDef = {  # (1)
    "schemaName": ...,
}

parent.create_schema_mapping(**kwargs)

1. See CreateSchemaMappingInputRequestTypeDef

delete_matching_workflow

Deletes the MatchingWorkflow with a given name.

Type annotations and code completion for session.create_client("entityresolution").delete_matching_workflow method. boto3 documentation

# delete_matching_workflow method definition

await def delete_matching_workflow(
    self,
    *,
    workflowName: str,
) -> DeleteMatchingWorkflowOutputTypeDef:  # (1)
    ...

1. See DeleteMatchingWorkflowOutputTypeDef

# delete_matching_workflow method usage example with argument unpacking

kwargs: DeleteMatchingWorkflowInputRequestTypeDef = {  # (1)
    "workflowName": ...,
}

parent.delete_matching_workflow(**kwargs)

1. See DeleteMatchingWorkflowInputRequestTypeDef

delete_schema_mapping

Deletes the SchemaMapping with a given name.

Type annotations and code completion for session.create_client("entityresolution").delete_schema_mapping method. boto3 documentation

# delete_schema_mapping method definition

await def delete_schema_mapping(
    self,
    *,
    schemaName: str,
) -> DeleteSchemaMappingOutputTypeDef:  # (1)
    ...

1. See DeleteSchemaMappingOutputTypeDef

# delete_schema_mapping method usage example with argument unpacking

kwargs: DeleteSchemaMappingInputRequestTypeDef = {  # (1)
    "schemaName": ...,
}

parent.delete_schema_mapping(**kwargs)

1. See DeleteSchemaMappingInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.create_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_match_id

Returns the corresponding Match ID of a customer record if the record has been processed.

Type annotations and code completion for session.create_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)
    ...

1. See GetMatchIdOutputTypeDef

# get_match_id method usage example with argument unpacking

kwargs: GetMatchIdInputRequestTypeDef = {  # (1)
    "record": ...,
    "workflowName": ...,
}

parent.get_match_id(**kwargs)

1. See GetMatchIdInputRequestTypeDef

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

1. See GetMatchingJobOutputTypeDef

# get_matching_job method usage example with argument unpacking

kwargs: GetMatchingJobInputRequestTypeDef = {  # (1)
    "jobId": ...,
    "workflowName": ...,
}

parent.get_matching_job(**kwargs)

1. See GetMatchingJobInputRequestTypeDef

get_matching_workflow

Returns the MatchingWorkflow with a given name, if it exists.

Type annotations and code completion for session.create_client("entityresolution").get_matching_workflow method. boto3 documentation

# get_matching_workflow method definition

await def get_matching_workflow(
    self,
    *,
    workflowName: str,
) -> GetMatchingWorkflowOutputTypeDef:  # (1)
    ...

1. See GetMatchingWorkflowOutputTypeDef

# get_matching_workflow method usage example with argument unpacking

kwargs: GetMatchingWorkflowInputRequestTypeDef = {  # (1)
    "workflowName": ...,
}

parent.get_matching_workflow(**kwargs)

1. See GetMatchingWorkflowInputRequestTypeDef

get_schema_mapping

Returns the SchemaMapping of a given name.

Type annotations and code completion for session.create_client("entityresolution").get_schema_mapping method. boto3 documentation

# get_schema_mapping method definition

await def get_schema_mapping(
    self,
    *,
    schemaName: str,
) -> GetSchemaMappingOutputTypeDef:  # (1)
    ...

1. See GetSchemaMappingOutputTypeDef

# get_schema_mapping method usage example with argument unpacking

kwargs: GetSchemaMappingInputRequestTypeDef = {  # (1)
    "schemaName": ...,
}

parent.get_schema_mapping(**kwargs)

1. See GetSchemaMappingInputRequestTypeDef

list_matching_jobs

Lists all jobs for a given workflow.

Type annotations and code completion for session.create_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)
    ...

1. See ListMatchingJobsOutputTypeDef

# list_matching_jobs method usage example with argument unpacking

kwargs: ListMatchingJobsInputRequestTypeDef = {  # (1)
    "workflowName": ...,
}

parent.list_matching_jobs(**kwargs)

1. See ListMatchingJobsInputRequestTypeDef

list_matching_workflows

Returns a list of all the MatchingWorkflows that have been created for an AWS account.

Type annotations and code completion for session.create_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)
    ...

1. See ListMatchingWorkflowsOutputTypeDef

# list_matching_workflows method usage example with argument unpacking

kwargs: ListMatchingWorkflowsInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_matching_workflows(**kwargs)

1. See ListMatchingWorkflowsInputRequestTypeDef

list_schema_mappings

Returns a list of all the SchemaMappings that have been created for an AWS account.

Type annotations and code completion for session.create_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)
    ...

1. See ListSchemaMappingsOutputTypeDef

# list_schema_mappings method usage example with argument unpacking

kwargs: ListSchemaMappingsInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_schema_mappings(**kwargs)

1. See ListSchemaMappingsInputRequestTypeDef

list_tags_for_resource

Displays the tags associated with an AWS Entity Resolution resource.

Type annotations and code completion for session.create_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)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

start_matching_job

Starts the MatchingJob of a workflow.

Type annotations and code completion for session.create_client("entityresolution").start_matching_job method. boto3 documentation

# start_matching_job method definition

await def start_matching_job(
    self,
    *,
    workflowName: str,
) -> StartMatchingJobOutputTypeDef:  # (1)
    ...

1. See StartMatchingJobOutputTypeDef

# start_matching_job method usage example with argument unpacking

kwargs: StartMatchingJobInputRequestTypeDef = {  # (1)
    "workflowName": ...,
}

parent.start_matching_job(**kwargs)

1. See StartMatchingJobInputRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource.

Type annotations and code completion for session.create_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)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes one or more tags from the specified AWS Entity Resolution resource.

Type annotations and code completion for session.create_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)

1. See UntagResourceInputRequestTypeDef

update_matching_workflow

Updates an existing MatchingWorkflow.

Type annotations and code completion for session.create_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)
    ...

1. See InputSourceTypeDef
2. See OutputSourceTypeDef
3. See ResolutionTechniquesTypeDef
4. See IncrementalRunConfigTypeDef
5. See UpdateMatchingWorkflowOutputTypeDef

# update_matching_workflow method usage example with argument unpacking

kwargs: UpdateMatchingWorkflowInputRequestTypeDef = {  # (1)
    "inputSourceConfig": ...,
    "outputSourceConfig": ...,
    "resolutionTechniques": ...,
    "roleArn": ...,
    "workflowName": ...,
}

parent.update_matching_workflow(**kwargs)

1. See UpdateMatchingWorkflowInputRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("entityresolution").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> EntityResolutionClient:
    ...

__aexit__

Type annotations and code completion for session.create_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.create_client("entityresolution").get_paginator method with overloads.

• client.get_paginator("list_matching_jobs") -> ListMatchingJobsPaginator
• client.get_paginator("list_matching_workflows") -> ListMatchingWorkflowsPaginator
• client.get_paginator("list_schema_mappings") -> ListSchemaMappingsPaginator