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: IdMappingTechniquesTypeDef,  # (1)
    inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef],  # (2)
    workflowName: str,
    description: str = ...,
    outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef] = ...,  # (3)
    roleArn: 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": ...,
    "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[IdNamespaceIdMappingWorkflowPropertiesUnionTypeDef] = ...,  # (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[OutputSourceUnionTypeDef],  # (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 OutputSourceOutputTypeDef
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_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 DeleteIdNamespaceInputRequestTypeDef

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_policy_statement

Deletes the policy statement.

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

# delete_policy_statement method definition

def delete_policy_statement(
    self,
    *,
    arn: str,
    statementId: str,
) -> DeletePolicyStatementOutputTypeDef:  # (1)
    ...

1. See DeletePolicyStatementOutputTypeDef

# delete_policy_statement method usage example with argument unpacking

kwargs: DeletePolicyStatementInputRequestTypeDef = {  # (1)
    "arn": ...,
    "statementId": ...,
}

parent.delete_policy_statement(**kwargs)

1. See DeletePolicyStatementInputRequestTypeDef

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_id_namespace

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

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

# get_id_namespace method definition

def get_id_namespace(
    self,
    *,
    idNamespaceName: str,
) -> GetIdNamespaceOutputTypeDef:  # (1)
    ...

1. See GetIdNamespaceOutputTypeDef

# get_id_namespace method usage example with argument unpacking

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

parent.get_id_namespace(**kwargs)

1. See GetIdNamespaceInputRequestTypeDef

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,
    applyNormalization: bool = ...,
) -> 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_policy

Returns the resource-based policy.

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

# get_policy method definition

def get_policy(
    self,
    *,
    arn: str,
) -> GetPolicyOutputTypeDef:  # (1)
    ...

1. See GetPolicyOutputTypeDef

# get_policy method usage example with argument unpacking

kwargs: GetPolicyInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_policy(**kwargs)

1. See GetPolicyInputRequestTypeDef

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. boto3 documentation

# list_id_mapping_jobs method definition

def list_id_mapping_jobs(
    self,
    *,
    workflowName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdMappingJobsOutputTypeDef:  # (1)
    ...

1. See ListIdMappingJobsOutputTypeDef

# list_id_mapping_jobs method usage example with argument unpacking

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

parent.list_id_mapping_jobs(**kwargs)

1. See ListIdMappingJobsInputRequestTypeDef

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

# list_id_mapping_workflows method definition

def list_id_mapping_workflows(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdMappingWorkflowsOutputTypeDef:  # (1)
    ...

1. See ListIdMappingWorkflowsOutputTypeDef

# list_id_mapping_workflows method usage example with argument unpacking

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

parent.list_id_mapping_workflows(**kwargs)

1. See ListIdMappingWorkflowsInputRequestTypeDef

list_id_namespaces

Returns a list of all ID namespaces.

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

# list_id_namespaces method definition

def list_id_namespaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdNamespacesOutputTypeDef:  # (1)
    ...

1. See ListIdNamespacesOutputTypeDef

# list_id_namespaces method usage example with argument unpacking

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

parent.list_id_namespaces(**kwargs)

1. See ListIdNamespacesInputRequestTypeDef

list_matching_jobs

Lists all jobs for a given workflow.

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

# list_matching_jobs method definition

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 Amazon Web Services account.

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

# list_matching_workflows method definition

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_provider_services

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

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

# list_provider_services method definition

def list_provider_services(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    providerName: str = ...,
) -> ListProviderServicesOutputTypeDef:  # (1)
    ...

1. See ListProviderServicesOutputTypeDef

# list_provider_services method usage example with argument unpacking

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

parent.list_provider_services(**kwargs)

1. See ListProviderServicesInputRequestTypeDef

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

# list_schema_mappings method definition

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 Entity Resolution resource.

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

# list_tags_for_resource method definition

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

put_policy

Updates the resource-based policy.

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

# put_policy method definition

def put_policy(
    self,
    *,
    arn: str,
    policy: str,
    token: str = ...,
) -> PutPolicyOutputTypeDef:  # (1)
    ...

1. See PutPolicyOutputTypeDef

# put_policy method usage example with argument unpacking

kwargs: PutPolicyInputRequestTypeDef = {  # (1)
    "arn": ...,
    "policy": ...,
}

parent.put_policy(**kwargs)

1. See PutPolicyInputRequestTypeDef

start_id_mapping_job

Starts the IdMappingJob of a workflow.

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

# start_id_mapping_job method definition

def start_id_mapping_job(
    self,
    *,
    workflowName: str,
    outputSourceConfig: Sequence[IdMappingJobOutputSourceTypeDef] = ...,  # (1)
) -> StartIdMappingJobOutputTypeDef:  # (2)
    ...

1. See IdMappingJobOutputSourceTypeDef
2. See StartIdMappingJobOutputTypeDef

# start_id_mapping_job method usage example with argument unpacking

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

parent.start_id_mapping_job(**kwargs)

1. See StartIdMappingJobInputRequestTypeDef

start_matching_job

Starts the MatchingJob of a workflow.

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

# start_matching_job method definition

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 Entity Resolution resource.

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

# tag_resource method definition

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 Entity Resolution resource.

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

# untag_resource method definition

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_id_mapping_workflow

Updates an existing IdMappingWorkflow.

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

# update_id_mapping_workflow method definition

def update_id_mapping_workflow(
    self,
    *,
    idMappingTechniques: IdMappingTechniquesTypeDef,  # (1)
    inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef],  # (2)
    workflowName: str,
    description: str = ...,
    outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef] = ...,  # (3)
    roleArn: str = ...,
) -> UpdateIdMappingWorkflowOutputTypeDef:  # (4)
    ...

1. See IdMappingTechniquesTypeDef
2. See IdMappingWorkflowInputSourceTypeDef
3. See IdMappingWorkflowOutputSourceTypeDef
4. See UpdateIdMappingWorkflowOutputTypeDef

# update_id_mapping_workflow method usage example with argument unpacking

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

parent.update_id_mapping_workflow(**kwargs)

1. See UpdateIdMappingWorkflowInputRequestTypeDef

update_id_namespace

Updates an existing ID namespace.

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

# update_id_namespace method definition

def update_id_namespace(
    self,
    *,
    idNamespaceName: str,
    description: str = ...,
    idMappingWorkflowProperties: Sequence[IdNamespaceIdMappingWorkflowPropertiesTypeDef] = ...,  # (1)
    inputSourceConfig: Sequence[IdNamespaceInputSourceTypeDef] = ...,  # (2)
    roleArn: str = ...,
) -> UpdateIdNamespaceOutputTypeDef:  # (3)
    ...

1. See IdNamespaceIdMappingWorkflowPropertiesTypeDef
2. See IdNamespaceInputSourceTypeDef
3. See UpdateIdNamespaceOutputTypeDef

# update_id_namespace method usage example with argument unpacking

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

parent.update_id_namespace(**kwargs)

1. See UpdateIdNamespaceInputRequestTypeDef

update_matching_workflow

Updates an existing MatchingWorkflow.

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

# update_matching_workflow method definition

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

update_schema_mapping

Updates a schema mapping.

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

# update_schema_mapping method definition

def update_schema_mapping(
    self,
    *,
    mappedInputFields: Sequence[SchemaInputAttributeTypeDef],  # (1)
    schemaName: str,
    description: str = ...,
) -> UpdateSchemaMappingOutputTypeDef:  # (2)
    ...

1. See SchemaInputAttributeTypeDef
2. See UpdateSchemaMappingOutputTypeDef

# update_schema_mapping method usage example with argument unpacking

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

parent.update_schema_mapping(**kwargs)

1. See UpdateSchemaMappingInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("entityresolution").get_paginator method with overloads.

• client.get_paginator("list_id_mapping_jobs") -> ListIdMappingJobsPaginator
• client.get_paginator("list_id_mapping_workflows") -> ListIdMappingWorkflowsPaginator
• client.get_paginator("list_id_namespaces") -> ListIdNamespacesPaginator
• client.get_paginator("list_matching_jobs") -> ListMatchingJobsPaginator
• client.get_paginator("list_matching_workflows") -> ListMatchingWorkflowsPaginator
• client.get_paginator("list_provider_services") -> ListProviderServicesPaginator
• client.get_paginator("list_schema_mappings") -> ListSchemaMappingsPaginator