EntityResolutionClient

Index > EntityResolution > EntityResolutionClient

Auto-generated documentation for EntityResolution type annotations stubs module mypy-boto3-entityresolution.

EntityResolutionClient

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

# EntityResolutionClient usage example

from boto3.session import Session
from mypy_boto3_entityresolution.client import EntityResolutionClient

def get_entityresolution_client() -> EntityResolutionClient:
    return Session().client("entityresolution")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("entityresolution")

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)

# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.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 boto3.client("entityresolution").close method. boto3 documentation

# close method definition

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 boto3.client("entityresolution").create_id_mapping_workflow method. boto3 documentation

# create_id_mapping_workflow method definition

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

1. See IdMappingTechniquesTypeDef
2. See IdMappingWorkflowInputSourceTypeDef
3. See IdMappingWorkflowOutputSourceTypeDef
4. 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)

1. See CreateIdMappingWorkflowInputRequestTypeDef

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 boto3.client("entityresolution").create_matching_workflow method. boto3 documentation

# create_matching_workflow method definition

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 boto3.client("entityresolution").create_schema_mapping method. boto3 documentation

# create_schema_mapping method definition

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

1. See SchemaInputAttributeTypeDef
2. See CreateSchemaMappingOutputTypeDef

# create_schema_mapping method usage example with argument unpacking

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

parent.create_schema_mapping(**kwargs)

1. See CreateSchemaMappingInputRequestTypeDef

delete_id_mapping_workflow

Deletes the IdMappingWorkflow with a given name.

Type annotations and code completion for boto3.client("entityresolution").delete_id_mapping_workflow method. boto3 documentation

# delete_id_mapping_workflow method definition

def delete_id_mapping_workflow(
    self,
    *,
    workflowName: str,
) -> DeleteIdMappingWorkflowOutputTypeDef:  # (1)
    ...

1. See DeleteIdMappingWorkflowOutputTypeDef

# delete_id_mapping_workflow method usage example with argument unpacking

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

parent.delete_id_mapping_workflow(**kwargs)

1. See DeleteIdMappingWorkflowInputRequestTypeDef

delete_matching_workflow

Deletes the MatchingWorkflow with a given name.

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

# delete_matching_workflow method definition

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 boto3.client("entityresolution").delete_schema_mapping method. boto3 documentation

# delete_schema_mapping method definition

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 boto3.client("entityresolution").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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 boto3.client("entityresolution").get_id_mapping_job method. boto3 documentation

# get_id_mapping_job method definition

def get_id_mapping_job(
    self,
    *,
    jobId: str,
    workflowName: str,
) -> GetIdMappingJobOutputTypeDef:  # (1)
    ...

1. See GetIdMappingJobOutputTypeDef

# get_id_mapping_job method usage example with argument unpacking

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

parent.get_id_mapping_job(**kwargs)

1. See GetIdMappingJobInputRequestTypeDef

get_id_mapping_workflow

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

Type annotations and code completion for boto3.client("entityresolution").get_id_mapping_workflow method. boto3 documentation

# get_id_mapping_workflow method definition

def get_id_mapping_workflow(
    self,
    *,
    workflowName: str,
) -> GetIdMappingWorkflowOutputTypeDef:  # (1)
    ...

1. See GetIdMappingWorkflowOutputTypeDef

# get_id_mapping_workflow method usage example with argument unpacking

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

parent.get_id_mapping_workflow(**kwargs)

1. See GetIdMappingWorkflowInputRequestTypeDef

get_match_id

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

Type annotations and code completion for boto3.client("entityresolution").get_match_id method. boto3 documentation

# get_match_id method definition

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 boto3.client("entityresolution").get_matching_job method. boto3 documentation

# get_matching_job method definition

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 boto3.client("entityresolution").get_matching_workflow method. boto3 documentation

# get_matching_workflow method definition

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_provider_service

Returns the ProviderService of a given name.

Type annotations and code completion for boto3.client("entityresolution").get_provider_service method. boto3 documentation

# get_provider_service method definition

def get_provider_service(
    self,
    *,
    providerName: str,
    providerServiceName: str,
) -> GetProviderServiceOutputTypeDef:  # (1)
    ...

1. See GetProviderServiceOutputTypeDef

# get_provider_service method usage example with argument unpacking

kwargs: GetProviderServiceInputRequestTypeDef = {  # (1)
    "providerName": ...,
    "providerServiceName": ...,
}

parent.get_provider_service(**kwargs)

1. See GetProviderServiceInputRequestTypeDef

get_schema_mapping

Returns the SchemaMapping of a given name.

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

# get_schema_mapping method definition

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_id_mapping_jobs

Lists all ID mapping jobs for a given workflow.

Type annotations and code completion for boto3.client("entityresolution").list_id_mapping_jobs method.