AddPolicyStatement

$result = $client->addPolicyStatement([/* ... */]);
$promise = $client->addPolicyStatementAsync([/* ... */]);

Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.

Parameter Syntax

$result = $client->addPolicyStatement([
    'action' => ['<string>', ...], // REQUIRED
    'arn' => '<string>', // REQUIRED
    'condition' => '<string>',
    'effect' => 'Allow|Deny', // REQUIRED
    'principal' => ['<string>', ...], // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'policy' => '<string>',
    'token' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

BatchDeleteUniqueId

$result = $client->batchDeleteUniqueId([/* ... */]);
$promise = $client->batchDeleteUniqueIdAsync([/* ... */]);

Deletes multiple unique IDs in a matching workflow.

Parameter Syntax

$result = $client->batchDeleteUniqueId([
    'inputSource' => '<string>',
    'uniqueIds' => ['<string>', ...], // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deleted' => [
        [
            'uniqueId' => '<string>',
        ],
        // ...
    ],
    'disconnectedUniqueIds' => ['<string>', ...],
    'errors' => [
        [
            'errorType' => 'SERVICE_ERROR|VALIDATION_ERROR',
            'uniqueId' => '<string>',
        ],
        // ...
    ],
    'status' => 'COMPLETED|ACCEPTED',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

CreateIdMappingWorkflow

$result = $client->createIdMappingWorkflow([/* ... */]);
$promise = $client->createIdMappingWorkflowAsync([/* ... */]);

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

Parameter Syntax

$result = $client->createIdMappingWorkflow([
    'description' => '<string>',
    'idMappingTechniques' => [ // REQUIRED
        'idMappingType' => 'PROVIDER|RULE_BASED', // REQUIRED
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>', // REQUIRED
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>', // REQUIRED
        ],
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'recordMatchingModel' => 'ONE_SOURCE_TO_ONE_TARGET|MANY_SOURCE_TO_ONE_TARGET', // REQUIRED
            'ruleDefinitionType' => 'SOURCE|TARGET', // REQUIRED
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...], // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'incrementalRunConfig' => [
        'incrementalRunType' => 'ON_DEMAND',
    ],
    'inputSourceConfig' => [ // REQUIRED
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'idMappingTechniques' => [
        'idMappingType' => 'PROVIDER|RULE_BASED',
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'recordMatchingModel' => 'ONE_SOURCE_TO_ONE_TARGET|MANY_SOURCE_TO_ONE_TARGET',
            'ruleDefinitionType' => 'SOURCE|TARGET',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'incrementalRunConfig' => [
        'incrementalRunType' => 'ON_DEMAND',
    ],
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

CreateIdNamespace

$result = $client->createIdNamespace([/* ... */]);
$promise = $client->createIdNamespaceAsync([/* ... */]);

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

Parameter Syntax

$result = $client->createIdNamespace([
    'description' => '<string>',
    'idMappingWorkflowProperties' => [
        [
            'idMappingType' => 'PROVIDER|RULE_BASED', // REQUIRED
            'providerProperties' => [
                'providerConfiguration' => [
                ],
                'providerServiceArn' => '<string>', // REQUIRED
            ],
            'ruleBasedProperties' => [
                'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
                'recordMatchingModels' => ['<string>', ...],
                'ruleDefinitionTypes' => ['<string>', ...],
                'rules' => [
                    [
                        'matchingKeys' => ['<string>', ...], // REQUIRED
                        'ruleName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idNamespaceName' => '<string>', // REQUIRED
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'SOURCE|TARGET', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'idMappingWorkflowProperties' => [
        [
            'idMappingType' => 'PROVIDER|RULE_BASED',
            'providerProperties' => [
                'providerConfiguration' => [
                ],
                'providerServiceArn' => '<string>',
            ],
            'ruleBasedProperties' => [
                'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
                'recordMatchingModels' => ['<string>', ...],
                'ruleDefinitionTypes' => ['<string>', ...],
                'rules' => [
                    [
                        'matchingKeys' => ['<string>', ...],
                        'ruleName' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idNamespaceArn' => '<string>',
    'idNamespaceName' => '<string>',
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'SOURCE|TARGET',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

CreateMatchingWorkflow

$result = $client->createMatchingWorkflow([/* ... */]);
$promise = $client->createMatchingWorkflowAsync([/* ... */]);

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow.

Parameter Syntax

$result = $client->createMatchingWorkflow([
    'description' => '<string>',
    'incrementalRunConfig' => [
        'incrementalRunType' => 'IMMEDIATE',
    ],
    'inputSourceConfig' => [ // REQUIRED
        [
            'applyNormalization' => true || false,
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputSourceConfig' => [ // REQUIRED
        [
            'KMSArn' => '<string>',
            'applyNormalization' => true || false,
            'output' => [ // REQUIRED
                [
                    'hashed' => true || false,
                    'name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'outputS3Path' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'resolutionTechniques' => [ // REQUIRED
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>', // REQUIRED
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>', // REQUIRED
        ],
        'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER', // REQUIRED
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'matchPurpose' => 'IDENTIFIER_GENERATION|INDEXING',
            'rules' => [ // REQUIRED
                [
                    'matchingKeys' => ['<string>', ...], // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'ruleConditionProperties' => [
            'rules' => [ // REQUIRED
                [
                    'condition' => '<string>', // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'incrementalRunConfig' => [
        'incrementalRunType' => 'IMMEDIATE',
    ],
    'inputSourceConfig' => [
        [
            'applyNormalization' => true || false,
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'applyNormalization' => true || false,
            'output' => [
                [
                    'hashed' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'resolutionTechniques' => [
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER',
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'matchPurpose' => 'IDENTIFIER_GENERATION|INDEXING',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
        'ruleConditionProperties' => [
            'rules' => [
                [
                    'condition' => '<string>',
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

CreateSchemaMapping

$result = $client->createSchemaMapping([/* ... */]);
$promise = $client->createSchemaMappingAsync([/* ... */]);

Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

Parameter Syntax

$result = $client->createSchemaMapping([
    'description' => '<string>',
    'mappedInputFields' => [ // REQUIRED
        [
            'fieldName' => '<string>', // REQUIRED
            'groupName' => '<string>',
            'hashed' => true || false,
            'matchKey' => '<string>',
            'subType' => '<string>',
            'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID', // REQUIRED
        ],
        // ...
    ],
    'schemaName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'mappedInputFields' => [
        [
            'fieldName' => '<string>',
            'groupName' => '<string>',
            'hashed' => true || false,
            'matchKey' => '<string>',
            'subType' => '<string>',
            'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

DeleteIdMappingWorkflow

$result = $client->deleteIdMappingWorkflow([/* ... */]);
$promise = $client->deleteIdMappingWorkflowAsync([/* ... */]);

Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Parameter Syntax

$result = $client->deleteIdMappingWorkflow([
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

DeleteIdNamespace

$result = $client->deleteIdNamespace([/* ... */]);
$promise = $client->deleteIdNamespaceAsync([/* ... */]);

Deletes the IdNamespace with a given name.

Parameter Syntax

$result = $client->deleteIdNamespace([
    'idNamespaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

DeleteMatchingWorkflow

$result = $client->deleteMatchingWorkflow([/* ... */]);
$promise = $client->deleteMatchingWorkflowAsync([/* ... */]);

Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Parameter Syntax

$result = $client->deleteMatchingWorkflow([
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

DeletePolicyStatement

$result = $client->deletePolicyStatement([/* ... */]);
$promise = $client->deletePolicyStatementAsync([/* ... */]);

Deletes the policy statement.

Parameter Syntax

$result = $client->deletePolicyStatement([
    'arn' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'policy' => '<string>',
    'token' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

DeleteSchemaMapping

$result = $client->deleteSchemaMapping([/* ... */]);
$promise = $client->deleteSchemaMappingAsync([/* ... */]);

Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

Parameter Syntax

$result = $client->deleteSchemaMapping([
    'schemaName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GenerateMatchId

$result = $client->generateMatchId([/* ... */]);
$promise = $client->generateMatchIdAsync([/* ... */]);

Generates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3.

The processing type (processingType) you choose affects both the accuracy and response time of the operation. Additional charges apply for each API call, whether made through the Entity Resolution console or directly via the API. The rule-based matching workflow must exist and be active before calling this operation.

Parameter Syntax

$result = $client->generateMatchId([
    'processingType' => 'CONSISTENT|EVENTUAL|EVENTUAL_NO_LOOKUP',
    'records' => [ // REQUIRED
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'recordAttributeMap' => ['<string>', ...], // REQUIRED
            'uniqueId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failedRecords' => [
        [
            'errorMessage' => '<string>',
            'inputSourceARN' => '<string>',
            'uniqueId' => '<string>',
        ],
        // ...
    ],
    'matchGroups' => [
        [
            'matchId' => '<string>',
            'matchRule' => '<string>',
            'records' => [
                [
                    'inputSourceARN' => '<string>',
                    'recordId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetIdMappingJob

$result = $client->getIdMappingJob([/* ... */]);
$promise = $client->getIdMappingJobAsync([/* ... */]);

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Parameter Syntax

$result = $client->getIdMappingJob([
    'jobId' => '<string>', // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'endTime' => <DateTime>,
    'errorDetails' => [
        'errorMessage' => '<string>',
    ],
    'jobId' => '<string>',
    'jobType' => 'BATCH|INCREMENTAL|DELETE_ONLY',
    'metrics' => [
        'deleteRecordsProcessed' => <integer>,
        'inputRecords' => <integer>,
        'mappedRecordsRemoved' => <integer>,
        'mappedSourceRecordsRemoved' => <integer>,
        'mappedTargetRecordsRemoved' => <integer>,
        'newMappedRecords' => <integer>,
        'newMappedSourceRecords' => <integer>,
        'newMappedTargetRecords' => <integer>,
        'newUniqueRecordsLoaded' => <integer>,
        'recordsNotProcessed' => <integer>,
        'totalMappedRecords' => <integer>,
        'totalMappedSourceRecords' => <integer>,
        'totalMappedTargetRecords' => <integer>,
        'totalRecordsProcessed' => <integer>,
        'uniqueRecordsLoaded' => <integer>,
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
    'startTime' => <DateTime>,
    'status' => 'RUNNING|SUCCEEDED|FAILED|QUEUED',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetIdMappingWorkflow

$result = $client->getIdMappingWorkflow([/* ... */]);
$promise = $client->getIdMappingWorkflowAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getIdMappingWorkflow([
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'idMappingTechniques' => [
        'idMappingType' => 'PROVIDER|RULE_BASED',
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'recordMatchingModel' => 'ONE_SOURCE_TO_ONE_TARGET|MANY_SOURCE_TO_ONE_TARGET',
            'ruleDefinitionType' => 'SOURCE|TARGET',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'incrementalRunConfig' => [
        'incrementalRunType' => 'ON_DEMAND',
    ],
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetIdNamespace

$result = $client->getIdNamespace([/* ... */]);
$promise = $client->getIdNamespaceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getIdNamespace([
    'idNamespaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'idMappingWorkflowProperties' => [
        [
            'idMappingType' => 'PROVIDER|RULE_BASED',
            'providerProperties' => [
                'providerConfiguration' => [
                ],
                'providerServiceArn' => '<string>',
            ],
            'ruleBasedProperties' => [
                'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
                'recordMatchingModels' => ['<string>', ...],
                'ruleDefinitionTypes' => ['<string>', ...],
                'rules' => [
                    [
                        'matchingKeys' => ['<string>', ...],
                        'ruleName' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idNamespaceArn' => '<string>',
    'idNamespaceName' => '<string>',
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'SOURCE|TARGET',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetMatchId

$result = $client->getMatchId([/* ... */]);
$promise = $client->getMatchIdAsync([/* ... */]);

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow.

You can call this API as a dry run of an incremental load on the rule-based matching workflow.

Parameter Syntax

$result = $client->getMatchId([
    'applyNormalization' => true || false,
    'record' => ['<string>', ...], // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'matchId' => '<string>',
    'matchRule' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetMatchingJob

$result = $client->getMatchingJob([/* ... */]);
$promise = $client->getMatchingJobAsync([/* ... */]);

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Parameter Syntax

$result = $client->getMatchingJob([
    'jobId' => '<string>', // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'endTime' => <DateTime>,
    'errorDetails' => [
        'errorMessage' => '<string>',
    ],
    'jobId' => '<string>',
    'metrics' => [
        'deleteRecordsProcessed' => <integer>,
        'inputRecords' => <integer>,
        'matchIDs' => <integer>,
        'recordsNotProcessed' => <integer>,
        'totalRecordsProcessed' => <integer>,
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
    'startTime' => <DateTime>,
    'status' => 'RUNNING|SUCCEEDED|FAILED|QUEUED',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetMatchingWorkflow

$result = $client->getMatchingWorkflow([/* ... */]);
$promise = $client->getMatchingWorkflowAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMatchingWorkflow([
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'incrementalRunConfig' => [
        'incrementalRunType' => 'IMMEDIATE',
    ],
    'inputSourceConfig' => [
        [
            'applyNormalization' => true || false,
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'applyNormalization' => true || false,
            'output' => [
                [
                    'hashed' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'resolutionTechniques' => [
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER',
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'matchPurpose' => 'IDENTIFIER_GENERATION|INDEXING',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
        'ruleConditionProperties' => [
            'rules' => [
                [
                    'condition' => '<string>',
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Returns the resource-based policy.

Parameter Syntax

$result = $client->getPolicy([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'policy' => '<string>',
    'token' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetProviderService

$result = $client->getProviderService([/* ... */]);
$promise = $client->getProviderServiceAsync([/* ... */]);

Returns the ProviderService of a given name.

Parameter Syntax

$result = $client->getProviderService([
    'providerName' => '<string>', // REQUIRED
    'providerServiceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'anonymizedOutput' => true || false,
    'providerComponentSchema' => [
        'providerSchemaAttributes' => [
            [
                'fieldName' => '<string>',
                'hashing' => true || false,
                'subType' => '<string>',
                'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID',
            ],
            // ...
        ],
        'schemas' => [
            ['<string>', ...],
            // ...
        ],
    ],
    'providerConfigurationDefinition' => [
    ],
    'providerEndpointConfiguration' => [
        'marketplaceConfiguration' => [
            'assetId' => '<string>',
            'dataSetId' => '<string>',
            'listingId' => '<string>',
            'revisionId' => '<string>',
        ],
    ],
    'providerEntityOutputDefinition' => [
    ],
    'providerIdNameSpaceConfiguration' => [
        'description' => '<string>',
        'providerSourceConfigurationDefinition' => [
        ],
        'providerTargetConfigurationDefinition' => [
        ],
    ],
    'providerIntermediateDataAccessConfiguration' => [
        'awsAccountIds' => ['<string>', ...],
        'requiredBucketActions' => ['<string>', ...],
    ],
    'providerJobConfiguration' => [
    ],
    'providerName' => '<string>',
    'providerServiceArn' => '<string>',
    'providerServiceDisplayName' => '<string>',
    'providerServiceName' => '<string>',
    'providerServiceType' => 'ASSIGNMENT|ID_MAPPING',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

GetSchemaMapping

$result = $client->getSchemaMapping([/* ... */]);
$promise = $client->getSchemaMappingAsync([/* ... */]);

Returns the SchemaMapping of a given name.

Parameter Syntax

$result = $client->getSchemaMapping([
    'schemaName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'hasWorkflows' => true || false,
    'mappedInputFields' => [
        [
            'fieldName' => '<string>',
            'groupName' => '<string>',
            'hashed' => true || false,
            'matchKey' => '<string>',
            'subType' => '<string>',
            'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListIdMappingJobs

$result = $client->listIdMappingJobs([/* ... */]);
$promise = $client->listIdMappingJobsAsync([/* ... */]);

Lists all ID mapping jobs for a given workflow.

Parameter Syntax

$result = $client->listIdMappingJobs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobs' => [
        [
            'endTime' => <DateTime>,
            'jobId' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'RUNNING|SUCCEEDED|FAILED|QUEUED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListIdMappingWorkflows

$result = $client->listIdMappingWorkflows([/* ... */]);
$promise = $client->listIdMappingWorkflowsAsync([/* ... */]);

Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.

Parameter Syntax

$result = $client->listIdMappingWorkflows([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'workflowSummaries' => [
        [
            'createdAt' => <DateTime>,
            'updatedAt' => <DateTime>,
            'workflowArn' => '<string>',
            'workflowName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListIdNamespaces

$result = $client->listIdNamespaces([/* ... */]);
$promise = $client->listIdNamespacesAsync([/* ... */]);

Returns a list of all ID namespaces.

Parameter Syntax

$result = $client->listIdNamespaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'idNamespaceSummaries' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'idMappingWorkflowProperties' => [
                [
                    'idMappingType' => 'PROVIDER|RULE_BASED',
                ],
                // ...
            ],
            'idNamespaceArn' => '<string>',
            'idNamespaceName' => '<string>',
            'type' => 'SOURCE|TARGET',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListMatchingJobs

$result = $client->listMatchingJobs([/* ... */]);
$promise = $client->listMatchingJobsAsync([/* ... */]);

Lists all jobs for a given workflow.

Parameter Syntax

$result = $client->listMatchingJobs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobs' => [
        [
            'endTime' => <DateTime>,
            'jobId' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'RUNNING|SUCCEEDED|FAILED|QUEUED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListMatchingWorkflows

$result = $client->listMatchingWorkflows([/* ... */]);
$promise = $client->listMatchingWorkflowsAsync([/* ... */]);

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

Parameter Syntax

$result = $client->listMatchingWorkflows([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'workflowSummaries' => [
        [
            'createdAt' => <DateTime>,
            'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER',
            'updatedAt' => <DateTime>,
            'workflowArn' => '<string>',
            'workflowName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListProviderServices

$result = $client->listProviderServices([/* ... */]);
$promise = $client->listProviderServicesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProviderServices([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'providerName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'providerServiceSummaries' => [
        [
            'providerName' => '<string>',
            'providerServiceArn' => '<string>',
            'providerServiceDisplayName' => '<string>',
            'providerServiceName' => '<string>',
            'providerServiceType' => 'ASSIGNMENT|ID_MAPPING',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListSchemaMappings

$result = $client->listSchemaMappings([/* ... */]);
$promise = $client->listSchemaMappingsAsync([/* ... */]);

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

Parameter Syntax

$result = $client->listSchemaMappings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'schemaList' => [
        [
            'createdAt' => <DateTime>,
            'hasWorkflows' => true || false,
            'schemaArn' => '<string>',
            'schemaName' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

PutPolicy

$result = $client->putPolicy([/* ... */]);
$promise = $client->putPolicyAsync([/* ... */]);

Updates the resource-based policy.

Parameter Syntax

$result = $client->putPolicy([
    'arn' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
    'token' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'policy' => '<string>',
    'token' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

StartIdMappingJob

$result = $client->startIdMappingJob([/* ... */]);
$promise = $client->startIdMappingJobAsync([/* ... */]);

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

Parameter Syntax

$result = $client->startIdMappingJob([
    'jobType' => 'BATCH|INCREMENTAL|DELETE_ONLY',
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'jobType' => 'BATCH|INCREMENTAL|DELETE_ONLY',
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

StartMatchingJob

$result = $client->startMatchingJob([/* ... */]);
$promise = $client->startMatchingJobAsync([/* ... */]);

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

Parameter Syntax

$result = $client->startMatchingJob([
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ExceedsLimitException:

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

UpdateIdMappingWorkflow

$result = $client->updateIdMappingWorkflow([/* ... */]);
$promise = $client->updateIdMappingWorkflowAsync([/* ... */]);

Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

Parameter Syntax

$result = $client->updateIdMappingWorkflow([
    'description' => '<string>',
    'idMappingTechniques' => [ // REQUIRED
        'idMappingType' => 'PROVIDER|RULE_BASED', // REQUIRED
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>', // REQUIRED
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>', // REQUIRED
        ],
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'recordMatchingModel' => 'ONE_SOURCE_TO_ONE_TARGET|MANY_SOURCE_TO_ONE_TARGET', // REQUIRED
            'ruleDefinitionType' => 'SOURCE|TARGET', // REQUIRED
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...], // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'incrementalRunConfig' => [
        'incrementalRunType' => 'ON_DEMAND',
    ],
    'inputSourceConfig' => [ // REQUIRED
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'idMappingTechniques' => [
        'idMappingType' => 'PROVIDER|RULE_BASED',
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'recordMatchingModel' => 'ONE_SOURCE_TO_ONE_TARGET|MANY_SOURCE_TO_ONE_TARGET',
            'ruleDefinitionType' => 'SOURCE|TARGET',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'incrementalRunConfig' => [
        'incrementalRunType' => 'ON_DEMAND',
    ],
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

UpdateIdNamespace

$result = $client->updateIdNamespace([/* ... */]);
$promise = $client->updateIdNamespaceAsync([/* ... */]);

Updates an existing ID namespace.

Parameter Syntax

$result = $client->updateIdNamespace([
    'description' => '<string>',
    'idMappingWorkflowProperties' => [
        [
            'idMappingType' => 'PROVIDER|RULE_BASED', // REQUIRED
            'providerProperties' => [
                'providerConfiguration' => [
                ],
                'providerServiceArn' => '<string>', // REQUIRED
            ],
            'ruleBasedProperties' => [
                'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
                'recordMatchingModels' => ['<string>', ...],
                'ruleDefinitionTypes' => ['<string>', ...],
                'rules' => [
                    [
                        'matchingKeys' => ['<string>', ...], // REQUIRED
                        'ruleName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idNamespaceName' => '<string>', // REQUIRED
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'idMappingWorkflowProperties' => [
        [
            'idMappingType' => 'PROVIDER|RULE_BASED',
            'providerProperties' => [
                'providerConfiguration' => [
                ],
                'providerServiceArn' => '<string>',
            ],
            'ruleBasedProperties' => [
                'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
                'recordMatchingModels' => ['<string>', ...],
                'ruleDefinitionTypes' => ['<string>', ...],
                'rules' => [
                    [
                        'matchingKeys' => ['<string>', ...],
                        'ruleName' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idNamespaceArn' => '<string>',
    'idNamespaceName' => '<string>',
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'type' => 'SOURCE|TARGET',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

UpdateMatchingWorkflow

$result = $client->updateMatchingWorkflow([/* ... */]);
$promise = $client->updateMatchingWorkflowAsync([/* ... */]);

Updates an existing matching workflow. The workflow must already exist for this operation to succeed.

Parameter Syntax

$result = $client->updateMatchingWorkflow([
    'description' => '<string>',
    'incrementalRunConfig' => [
        'incrementalRunType' => 'IMMEDIATE',
    ],
    'inputSourceConfig' => [ // REQUIRED
        [
            'applyNormalization' => true || false,
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'outputSourceConfig' => [ // REQUIRED
        [
            'KMSArn' => '<string>',
            'applyNormalization' => true || false,
            'output' => [ // REQUIRED
                [
                    'hashed' => true || false,
                    'name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'outputS3Path' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'resolutionTechniques' => [ // REQUIRED
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>', // REQUIRED
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>', // REQUIRED
        ],
        'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER', // REQUIRED
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY', // REQUIRED
            'matchPurpose' => 'IDENTIFIER_GENERATION|INDEXING',
            'rules' => [ // REQUIRED
                [
                    'matchingKeys' => ['<string>', ...], // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'ruleConditionProperties' => [
            'rules' => [ // REQUIRED
                [
                    'condition' => '<string>', // REQUIRED
                    'ruleName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'incrementalRunConfig' => [
        'incrementalRunType' => 'IMMEDIATE',
    ],
    'inputSourceConfig' => [
        [
            'applyNormalization' => true || false,
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'applyNormalization' => true || false,
            'output' => [
                [
                    'hashed' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'resolutionTechniques' => [
        'providerProperties' => [
            'intermediateSourceConfiguration' => [
                'intermediateS3Path' => '<string>',
            ],
            'providerConfiguration' => [
            ],
            'providerServiceArn' => '<string>',
        ],
        'resolutionType' => 'RULE_MATCHING|ML_MATCHING|PROVIDER',
        'ruleBasedProperties' => [
            'attributeMatchingModel' => 'ONE_TO_ONE|MANY_TO_MANY',
            'matchPurpose' => 'IDENTIFIER_GENERATION|INDEXING',
            'rules' => [
                [
                    'matchingKeys' => ['<string>', ...],
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
        'ruleConditionProperties' => [
            'rules' => [
                [
                    'condition' => '<string>',
                    'ruleName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.

UpdateSchemaMapping

$result = $client->updateSchemaMapping([/* ... */]);
$promise = $client->updateSchemaMappingAsync([/* ... */]);

Updates a schema mapping.

Parameter Syntax

$result = $client->updateSchemaMapping([
    'description' => '<string>',
    'mappedInputFields' => [ // REQUIRED
        [
            'fieldName' => '<string>', // REQUIRED
            'groupName' => '<string>',
            'hashed' => true || false,
            'matchKey' => '<string>',
            'subType' => '<string>',
            'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID', // REQUIRED
        ],
        // ...
    ],
    'schemaName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'mappedInputFields' => [
        [
            'fieldName' => '<string>',
            'groupName' => '<string>',
            'hashed' => true || false,
            'matchKey' => '<string>',
            'subType' => '<string>',
            'type' => 'NAME|NAME_FIRST|NAME_MIDDLE|NAME_LAST|ADDRESS|ADDRESS_STREET1|ADDRESS_STREET2|ADDRESS_STREET3|ADDRESS_CITY|ADDRESS_STATE|ADDRESS_COUNTRY|ADDRESS_POSTALCODE|PHONE|PHONE_NUMBER|PHONE_COUNTRYCODE|EMAIL_ADDRESS|UNIQUE_ID|DATE|STRING|PROVIDER_ID|IPV4|IPV6|MAID',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

ValidationException:

The input fails to satisfy the constraints specified by Entity Resolution.