Skip to content

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#

add_policy_statement#

Adds a policy statement object.

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

# add_policy_statement method definition

def add_policy_statement(
    self,
    *,
    action: Sequence[str],
    arn: str,
    effect: StatementEffectType,  # (1)
    principal: Sequence[str],
    statementId: str,
    condition: str = ...,
) -> AddPolicyStatementOutputTypeDef:  # (2)
    ...
  1. See StatementEffectType
  2. See AddPolicyStatementOutputTypeDef
# add_policy_statement method usage example with argument unpacking

kwargs: AddPolicyStatementInputRequestTypeDef = {  # (1)
    "action": ...,
    "arn": ...,
    "effect": ...,
    "principal": ...,
    "statementId": ...,
}

parent.add_policy_statement(**kwargs)
  1. See AddPolicyStatementInputRequestTypeDef

batch_delete_unique_id#

Deletes multiple unique IDs in a matching workflow.

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

# batch_delete_unique_id method definition

def batch_delete_unique_id(
    self,
    *,
    uniqueIds: Sequence[str],
    workflowName: str,
    inputSource: str = ...,
) -> BatchDeleteUniqueIdOutputTypeDef:  # (1)
    ...
  1. See BatchDeleteUniqueIdOutputTypeDef
# batch_delete_unique_id method usage example with argument unpacking

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

parent.batch_delete_unique_id(**kwargs)
  1. See BatchDeleteUniqueIdInputRequestTypeDef

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: Union[IdMappingTechniquesTypeDef, IdMappingTechniquesOutputTypeDef],  # (1)
    inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef],  # (2)
    roleArn: str,
    workflowName: str,
    description: str = ...,
    outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef] = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> CreateIdMappingWorkflowOutputTypeDef:  # (4)
    ...
  1. See IdMappingTechniquesTypeDef IdMappingTechniquesOutputTypeDef
  2. See IdMappingWorkflowInputSourceTypeDef
  3. See IdMappingWorkflowOutputSourceTypeDef
  4. See CreateIdMappingWorkflowOutputTypeDef
# create_id_mapping_workflow method usage example with argument unpacking

kwargs: CreateIdMappingWorkflowInputRequestTypeDef = {  # (1)
    "idMappingTechniques": ...,
    "inputSourceConfig": ...,
    "roleArn": ...,
    "workflowName": ...,
}

parent.create_id_mapping_workflow(**kwargs)
  1. See CreateIdMappingWorkflowInputRequestTypeDef

create_id_namespace#

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.

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

# create_id_namespace method definition

def create_id_namespace(
    self,
    *,
    idNamespaceName: str,
    type: IdNamespaceTypeType,  # (1)
    description: str = ...,
    idMappingWorkflowProperties: Sequence[Union[IdNamespaceIdMappingWorkflowPropertiesTypeDef, IdNamespaceIdMappingWorkflowPropertiesOutputTypeDef]] = ...,  # (2)
    inputSourceConfig: Sequence[IdNamespaceInputSourceTypeDef] = ...,  # (3)
    roleArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateIdNamespaceOutputTypeDef:  # (4)
    ...
  1. See IdNamespaceTypeType
  2. See IdNamespaceIdMappingWorkflowPropertiesTypeDef IdNamespaceIdMappingWorkflowPropertiesOutputTypeDef
  3. See IdNamespaceInputSourceTypeDef
  4. See CreateIdNamespaceOutputTypeDef
# create_id_namespace method usage example with argument unpacking

kwargs: CreateIdNamespaceInputRequestTypeDef = {  # (1)
    "idNamespaceName": ...,
    "type": ...,
}

parent.create_id_namespace(**kwargs)
  1. See CreateIdNamespaceInputRequestTypeDef

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[Union[OutputSourceTypeDef, OutputSourceOutputTypeDef]],  # (2)
    resolutionTechniques: Union[ResolutionTechniquesTypeDef, ResolutionTechniquesOutputTypeDef],  # (3)
    roleArn: str,
    workflowName: str,
    description: str = ...,
    incrementalRunConfig: IncrementalRunConfigTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateMatchingWorkflowOutputTypeDef:  # (5)
    ...
  1. See InputSourceTypeDef
  2. See OutputSourceTypeDef OutputSourceOutputTypeDef
  3. See ResolutionTechniquesTypeDef ResolutionTechniquesOutputTypeDef
  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_id_namespace#

Deletes the IdNamespace with a given name.

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

# delete_id_namespace method definition

def delete_id_namespace(
    self,
    *,
    idNamespaceName: str,
) -> DeleteIdNamespaceOutputTypeDef:  # (1)
    ...
  1. See DeleteIdNamespaceOutputTypeDef
# delete_id_namespace method usage example with argument unpacking

kwargs: DeleteIdNamespaceInputRequestTypeDef = {  # (1)
    "idNamespaceName": ...,
}

parent.delete_id_namespace(**kwargs)
  1. See