AWS SDK for PHP 3.x

Client: Aws\EntityResolution\EntityResolutionClient

Service ID: entityresolution

Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS EntityResolution (2018-05-10), and shows how to use the Aws\EntityResolution\EntityResolutionClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddPolicyStatement ( array $params = [] ): Adds a policy statement object.
BatchDeleteUniqueId ( array $params = [] ): Deletes multiple unique IDs in a matching workflow.
CreateIdMappingWorkflow ( array $params = [] ): Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.
CreateIdNamespace ( array $params = [] ): Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.
CreateMatchingWorkflow ( array $params = [] ): Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run.
CreateSchemaMapping ( array $params = [] ): Creates a schema mapping, which defines the schema of the input customer records table.
DeleteIdMappingWorkflow ( array $params = [] ): Deletes the IdMappingWorkflow with a given name.
DeleteIdNamespace ( array $params = [] ): Deletes the IdNamespace with a given name.
DeleteMatchingWorkflow ( array $params = [] ): Deletes the MatchingWorkflow with a given name.
DeletePolicyStatement ( array $params = [] ): Deletes the policy statement.
DeleteSchemaMapping ( array $params = [] ): Deletes the SchemaMapping with a given name.
GetIdMappingJob ( array $params = [] ): Gets the status, metrics, and errors (if there are any) that are associated with a job.
GetIdMappingWorkflow ( array $params = [] ): Returns the IdMappingWorkflow with a given name, if it exists.
GetIdNamespace ( array $params = [] ): Returns the IdNamespace with a given name, if it exists.
GetMatchId ( array $params = [] ): Returns the corresponding Match ID of a customer record if the record has been processed.
GetMatchingJob ( array $params = [] ): Gets the status, metrics, and errors (if there are any) that are associated with a job.
GetMatchingWorkflow ( array $params = [] ): Returns the MatchingWorkflow with a given name, if it exists.
GetPolicy ( array $params = [] ): Returns the resource-based policy.
GetProviderService ( array $params = [] ): Returns the ProviderService of a given name.
GetSchemaMapping ( array $params = [] ): Returns the SchemaMapping of a given name.
ListIdMappingJobs ( array $params = [] ): Lists all ID mapping jobs for a given workflow.
ListIdMappingWorkflows ( array $params = [] ): Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
ListIdNamespaces ( array $params = [] ): Returns a list of all ID namespaces.
ListMatchingJobs ( array $params = [] ): Lists all jobs for a given workflow.
ListMatchingWorkflows ( array $params = [] ): Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
ListProviderServices ( array $params = [] ): Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
ListSchemaMappings ( array $params = [] ): Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
ListTagsForResource ( array $params = [] ): Displays the tags associated with an Entity Resolution resource.
PutPolicy ( array $params = [] ): Updates the resource-based policy.
StartIdMappingJob ( array $params = [] ): Starts the IdMappingJob of a workflow.
StartMatchingJob ( array $params = [] ): Starts the MatchingJob of a workflow.
TagResource ( array $params = [] ): Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.
UntagResource ( array $params = [] ): Removes one or more tags from the specified Entity Resolution resource.
UpdateIdMappingWorkflow ( array $params = [] ): Updates an existing IdMappingWorkflow.
UpdateIdNamespace ( array $params = [] ): Updates an existing ID namespace.
UpdateMatchingWorkflow ( array $params = [] ): Updates an existing MatchingWorkflow.
UpdateSchemaMapping ( array $params = [] ): Updates a schema mapping.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListIdMappingJobs
ListIdMappingWorkflows
ListIdNamespaces
ListMatchingJobs
ListMatchingWorkflows
ListProviderServices
ListSchemaMappings

Operations

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

Members

action

: Required: Yes
: Type: Array of strings

The action that the principal can use on the resource.

For example, entityresolution:GetIdMappingJob, entityresolution:GetMatchingJob.

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.

condition

: Type: string

A set of condition keys that you can use in key policies.

effect

: Required: Yes
: Type: string

Determines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny).

If you set the value of the effect parameter to Deny for the AddPolicyStatement operation, you must also set the value of the effect parameter in the policy to Deny for the PutPolicy operation.

principal

: Required: Yes
: Type: Array of strings

The Amazon Web Services service or Amazon Web Services account that can access the resource defined as ARN.

statementId

: Required: Yes
: Type: string

A statement identifier that differentiates the statement from others in the same policy.

Result Syntax

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

Result Details

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.

policy

: Type: string

The resource-based policy.

token

: Required: Yes
: Type: string

A unique identifier for the current revision of the policy.

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 could not be found.
AccessDeniedException:: You do not have sufficient access to perform this action.
ConflictException:: The request could not 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

Members

inputSource

: Type: string

The input source for the batch delete unique ID operation.

uniqueIds

: Required: Yes
: Type: Array of strings

The unique IDs to delete.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

Result Syntax

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

Result Details

Members

deleted

: Required: Yes
: Type: Array of DeletedUniqueId structures

The unique IDs that were deleted.

disconnectedUniqueIds

: Required: Yes
: Type: Array of strings

The unique IDs that were disconnected.

errors

: Required: Yes
: Type: Array of DeleteUniqueIdError structures

The errors from deleting multiple unique IDs.

status

: Required: Yes
: Type: string

The status of the batch delete unique ID operation.

Errors

InternalServerException:: This exception occurs when there is an internal failure in the Entity Resolution service.
ResourceNotFoundException:: The resource could not 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
                ],
                // ...
            ],
        ],
    ],
    '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

Members

description

: Type: string

A description of the workflow.

idMappingTechniques

: Required: Yes
: Type: IdMappingTechniques structure

An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

: Required: Yes
: Type: Array of IdMappingWorkflowInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Type: Array of IdMappingWorkflowOutputSource structures

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

workflowName

: Required: Yes
: Type: string

The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.

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>',
                ],
                // ...
            ],
        ],
    ],
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Members

description

: Type: string

A description of the workflow.

idMappingTechniques

: Required: Yes
: Type: IdMappingTechniques structure

An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

: Required: Yes
: Type: Array of IdMappingWorkflowInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Type: Array of IdMappingWorkflowOutputSource structures

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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

Members

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowProperties structures

Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

inputSourceConfig

: Type: Array of IdNamespaceInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

type

: Required: Yes
: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

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

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was created.

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowProperties structures

Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

idNamespaceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the ID namespace.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

inputSourceConfig

: Type: Array of IdNamespaceInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

type

: Required: Yes
: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was last updated.

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 could not 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 MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.

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
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

A description of the workflow.

incrementalRunConfig

: Type: IncrementalRunConfig structure

An object which defines an incremental run type and has only incrementalRunType as a field.

inputSourceConfig

: Required: Yes
: Type: Array of InputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Required: Yes
: Type: Array of OutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

resolutionTechniques

: Required: Yes
: Type: ResolutionTechniques structure

An object which defines the resolutionType and the ruleBasedProperties.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

workflowName

: Required: Yes
: Type: string

The name of the workflow. There can't be multiple MatchingWorkflows with the same name.

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>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Members

description

: Type: string

A description of the workflow.

incrementalRunConfig

: Type: IncrementalRunConfig structure

An object which defines an incremental run type and has only incrementalRunType as a field.

inputSourceConfig

: Required: Yes
: Type: Array of InputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Required: Yes
: Type: Array of OutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

resolutionTechniques

: Required: Yes
: Type: ResolutionTechniques structure

An object which defines the resolutionType and the ruleBasedProperties.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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', // REQUIRED
        ],
        // ...
    ],
    'schemaName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

description

: Type: string

A description of the schema.

mappedInputFields

: Required: Yes
: Type: Array of SchemaInputAttribute structures

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

schemaName

: Required: Yes
: Type: string

The name of the schema. There can't be multiple SchemaMappings with the same name.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

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',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
]

Result Details

Members

description

: Required: Yes
: Type: string

A description of the schema.

mappedInputFields

: Required: Yes
: Type: Array of SchemaInputAttribute structures

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

schemaArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

schemaName

: Required: Yes
: Type: string

The name of the schema.

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 could not 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

Members

workflowName

: Required: Yes
: Type: string

The name of the workflow to be deleted.

Result Syntax

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

Result Details

Members

message

: Required: Yes
: Type: string

A successful operation message.

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 could not 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

Members

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

Result Syntax

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

Result Details

Members

message

: Required: Yes
: Type: string

A successful operation message.

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

Members

workflowName

: Required: Yes
: Type: string

The name of the workflow to be retrieved.

Result Syntax

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

Result Details

Members

message

: Required: Yes
: Type: string

A successful operation message.

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 could not 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

Members

arn

: Required: Yes
: Type: string

The ARN of the resource for which the policy need to be deleted.

statementId

: Required: Yes
: Type: string

A statement identifier that differentiates the statement from others in the same policy.

Result Syntax

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

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the resource for which the policy need to be deleted.

policy

: Type: string

The resource-based policy.

token

: Required: Yes
: Type: string

A unique identifier for the deleted policy.

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 could not be found.
AccessDeniedException:: You do not have sufficient access to perform this action.
ConflictException:: The request could not 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

Members

schemaName

: Required: Yes
: Type: string

The name of the schema to delete.

Result Syntax

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

Result Details

Members

message

: Required: Yes
: Type: string

A successful operation message.

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 could not 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.

GetIdMappingJob

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

Gets 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

Members

jobId

: Required: Yes
: Type: string

The ID of the job.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

Result Syntax

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

Result Details

Members

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job has finished.

errorDetails

: Type: ErrorDetails structure

An object containing an error message, if there was an error.

jobId

: Required: Yes
: Type: string

The ID of the job.

metrics

: Type: IdMappingJobMetrics structure

Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

outputSourceConfig

: Type: Array of IdMappingJobOutputSource structures

A list of OutputSource objects.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job was started.

status

: Required: Yes
: Type: string

The current status of the job.

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 could not 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

Members

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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>',
                ],
                // ...
            ],
        ],
    ],
    '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

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was created.

description

: Type: string

A description of the workflow.

idMappingTechniques

: Required: Yes
: Type: IdMappingTechniques structure

An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

: Required: Yes
: Type: Array of IdMappingWorkflowInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Type: Array of IdMappingWorkflowOutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was last updated.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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

Members

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

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

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was created.

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowProperties structures

Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

idNamespaceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the ID namespace.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

inputSourceConfig

: Type: Array of IdNamespaceInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

type

: Required: Yes
: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was last updated.

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 could not 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.

Parameter Syntax

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

Parameter Details

Members

applyNormalization

: Type: boolean

Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

record

: Required: Yes
: Type: Associative array of custom strings keys (RecordAttributeMapKeyString) to strings

The record to fetch the Match ID for.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

Result Syntax

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

Result Details

Members

matchId

: Type: string

The unique identifiers for this group of match records.

matchRule

: Type: string

The rule the record matched on.

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 could not 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([/* ... */]);

Gets 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

Members

jobId

: Required: Yes
: Type: string

The ID of the job.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

Result Syntax

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

Result Details

Members

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job has finished.

errorDetails

: Type: ErrorDetails structure

An object containing an error message, if there was an error.

jobId

: Required: Yes
: Type: string

The ID of the job.

metrics

: Type: JobMetrics structure

Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

outputSourceConfig

: Type: Array of JobOutputSource structures

A list of OutputSource objects.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job was started.

status

: Required: Yes
: Type: string

The current status of the job.

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 could not 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

Members

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was created.

description

: Type: string

A description of the workflow.

incrementalRunConfig

: Type: IncrementalRunConfig structure

An object which defines an incremental run type and has only incrementalRunType as a field.

inputSourceConfig

: Required: Yes
: Type: Array of InputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Required: Yes
: Type: Array of OutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

resolutionTechniques

: Required: Yes
: Type: ResolutionTechniques structure

An object which defines the resolutionType and the ruleBasedProperties.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was last updated.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which the policy need to be returned.

Result Syntax

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

Result Details

Members

arn

: Required: Yes
: Type: string

The Entity Resolution resource ARN.

policy

: Type: string

The resource-based policy.

token

: Required: Yes
: Type: string

A unique identifier for the current revision of the policy.

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 could not 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

Members

providerName

: Required: Yes
: Type: string

The name of the provider. This name is typically the company name.

providerServiceName

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) of the product that the provider service provides.

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',
            ],
            // ...
        ],
        '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

Members

anonymizedOutput

: Required: Yes
: Type: boolean

Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.

providerComponentSchema

: Type: ProviderComponentSchema structure

Input schema for the provider service.

providerConfigurationDefinition

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The definition of the provider configuration.

providerEndpointConfiguration

: Required: Yes
: Type: ProviderEndpointConfiguration structure

The required configuration fields to use with the provider service.

providerEntityOutputDefinition

: Required: Yes
: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The definition of the provider entity output.

providerIdNameSpaceConfiguration

: Type: ProviderIdNameSpaceConfiguration structure

The provider configuration required for different ID namespace types.

providerIntermediateDataAccessConfiguration

: Type: ProviderIntermediateDataAccessConfiguration structure

The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.

providerJobConfiguration

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Provider service job configurations.

providerName

: Required: Yes
: Type: string

The name of the provider. This name is typically the company name.

providerServiceArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.

providerServiceDisplayName

: Required: Yes
: Type: string

The display name of the provider service.

providerServiceName

: Required: Yes
: Type: string

The name of the product that the provider service provides.

providerServiceType

: Required: Yes
: Type: string

The type of provider service.

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 could not 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

Members

schemaName

: Required: Yes
: Type: string

The name of the schema to be retrieved.

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',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the SchemaMapping was created.

description

: Type: string

A description of the schema.

hasWorkflows

: Required: Yes
: Type: boolean

Specifies whether the schema mapping has been applied to a workflow.

mappedInputFields

: Required: Yes
: Type: Array of SchemaInputAttribute structures

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.

schemaArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

schemaName

: Required: Yes
: Type: string

The name of the schema.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the SchemaMapping was last updated.

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 could not 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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

workflowName

: Required: Yes
: Type: string

The name of the workflow to be retrieved.

Result Syntax

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

Result Details

Members

jobs

: Type: Array of JobSummary structures

A list of JobSummary objects.

nextToken

: Type: string

The pagination token from the previous API call.

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 could not 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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

Result Syntax

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

Result Details

Members

nextToken

: Type: string

The pagination token from the previous API call.

workflowSummaries

: Type: Array of IdMappingWorkflowSummary structures

A list of IdMappingWorkflowSummary objects.

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

Members

maxResults

: Type: int

The maximum number of IdNamespace objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

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

Members

idNamespaceSummaries

: Type: Array of IdNamespaceSummary structures

A list of IdNamespaceSummaries objects.

nextToken

: Type: string

The pagination token from the previous API call.

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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

workflowName

: Required: Yes
: Type: string

The name of the workflow to be retrieved.

Result Syntax

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

Result Details

Members

jobs

: Type: Array of JobSummary structures

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

nextToken

: Type: string

The pagination token from the previous API call.

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 could not 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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

Result Syntax

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

Result Details

Members

nextToken

: Type: string

The pagination token from the previous API call.

workflowSummaries

: Type: Array of MatchingWorkflowSummary structures

A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

providerName

: Type: string

The name of the provider. This name is typically the company name.

Result Syntax

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

Result Details

Members

nextToken

: Type: string

The pagination token from the previous API call.

providerServiceSummaries

: Type: Array of ProviderServiceSummary structures

A list of ProviderServices objects.

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

Members

maxResults

: Type: int

The maximum number of objects returned per page.

nextToken

: Type: string

The pagination token from the previous API call.

Result Syntax

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

Result Details

Members

nextToken

: Type: string

The pagination token from the previous API call.

schemaList

: Type: Array of SchemaMappingSummary structures

A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.

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

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource for which you want to view tags.

Result Syntax

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

Result Details

Members

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

Errors

InternalServerException:: This exception occurs when there is an internal failure in the Entity Resolution service.
ResourceNotFoundException:: The resource could not 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

Members

arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which the policy needs to be updated.

policy

: Required: Yes
: Type: string

The resource-based policy.

If you set the value of the effect parameter in the policy to Deny for the PutPolicy operation, you must also set the value of the effect parameter to Deny for the AddPolicyStatement operation.

token

: Type: string

A unique identifier for the current revision of the policy.

Result Syntax

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

Result Details

Members

arn

: Required: Yes
: Type: string

The Entity Resolution resource ARN.

policy

: Type: string

The resource-based policy.

token

: Required: Yes
: Type: string

A unique identifier for the current revision of the policy.

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 could not be found.
AccessDeniedException:: You do not have sufficient access to perform this action.
ConflictException:: The request could not 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([
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Members

outputSourceConfig

: Type: Array of IdMappingJobOutputSource structures

A list of OutputSource objects.

workflowName

: Required: Yes
: Type: string

The name of the ID mapping job to be retrieved.

Result Syntax

[
    'jobId' => '<string>',
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
            'roleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

jobId

: Required: Yes
: Type: string

The ID of the job.

outputSourceConfig

: Type: Array of IdMappingJobOutputSource structures

A list of OutputSource objects.

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 could not 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 could not 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

Members

workflowName

: Required: Yes
: Type: string

The name of the matching job to be retrieved.

Result Syntax

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

Result Details

Members

jobId

: Required: Yes
: Type: string

The ID of the job.

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 could not 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 could not 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

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource for which you want to view tags.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags used to organize, track, or control access for this resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: This exception occurs when there is an internal failure in the Entity Resolution service.
ResourceNotFoundException:: The resource could not 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

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource for which you want to untag.

tagKeys

: Required: Yes
: Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: This exception occurs when there is an internal failure in the Entity Resolution service.
ResourceNotFoundException:: The resource could not 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
                ],
                // ...
            ],
        ],
    ],
    'inputSourceConfig' => [ // REQUIRED
        [
            'inputSourceARN' => '<string>', // REQUIRED
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

A description of the workflow.

idMappingTechniques

: Required: Yes
: Type: IdMappingTechniques structure

An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

: Required: Yes
: Type: Array of IdMappingWorkflowInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Type: Array of IdMappingWorkflowOutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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>',
                ],
                // ...
            ],
        ],
    ],
    'inputSourceConfig' => [
        [
            'inputSourceARN' => '<string>',
            'schemaName' => '<string>',
            'type' => 'SOURCE|TARGET',
        ],
        // ...
    ],
    'outputSourceConfig' => [
        [
            'KMSArn' => '<string>',
            'outputS3Path' => '<string>',
        ],
        // ...
    ],
    'roleArn' => '<string>',
    'workflowArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Members

description

: Type: string

A description of the workflow.

idMappingTechniques

: Required: Yes
: Type: IdMappingTechniques structure

An object which defines the ID mapping technique and any additional configurations.

inputSourceConfig

: Required: Yes
: Type: Array of IdMappingWorkflowInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Type: Array of IdMappingWorkflowOutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

workflowArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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

Members

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowProperties structures

Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

inputSourceConfig

: Type: Array of IdNamespaceInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

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

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was created.

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowProperties structures

Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

idNamespaceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the ID namespace.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

inputSourceConfig

: Type: Array of IdNamespaceInputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

roleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

type

: Required: Yes
: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was last updated.

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 could not 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 MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method 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
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'workflowName' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

A description of the workflow.

incrementalRunConfig

: Type: IncrementalRunConfig structure

An object which defines an incremental run type and has only incrementalRunType as a field.

inputSourceConfig

: Required: Yes
: Type: Array of InputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Required: Yes
: Type: Array of OutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

resolutionTechniques

: Required: Yes
: Type: ResolutionTechniques structure

An object which defines the resolutionType and the ruleBasedProperties.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

workflowName

: Required: Yes
: Type: string

The name of the workflow to be retrieved.

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>',
                ],
                // ...
            ],
        ],
    ],
    'roleArn' => '<string>',
    'workflowName' => '<string>',
]

Result Details

Members

description

: Type: string

A description of the workflow.

incrementalRunConfig

: Type: IncrementalRunConfig structure

An object which defines an incremental run type and has only incrementalRunType as a field.

inputSourceConfig

: Required: Yes
: Type: Array of InputSource structures

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

outputSourceConfig

: Required: Yes
: Type: Array of OutputSource structures

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

resolutionTechniques

: Required: Yes
: Type: ResolutionTechniques structure

An object which defines the resolutionType and the ruleBasedProperties

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

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 could not 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.

A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.

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', // REQUIRED
        ],
        // ...
    ],
    'schemaName' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

A description of the schema.

mappedInputFields

: Required: Yes
: Type: Array of SchemaInputAttribute structures

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

schemaName

: Required: Yes
: Type: string

The name of the schema. There can't be multiple SchemaMappings with the same name.

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',
        ],
        // ...
    ],
    'schemaArn' => '<string>',
    'schemaName' => '<string>',
]

Result Details

Members

description

: Type: string

A description of the schema.

mappedInputFields

: Required: Yes
: Type: Array of SchemaInputAttribute structures

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

schemaArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

schemaName

: Required: Yes
: Type: string

The name of the schema.

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 could not be found.
AccessDeniedException:: You do not have sufficient access to perform this action.
ConflictException:: The request could not 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.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Type: string

ConflictException

Description

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

Members

message

: Type: string

DeleteUniqueIdError

Description

The Delete Unique Id error.

Members

errorType

: Required: Yes
: Type: string

The error type for the batch delete unique ID operation.

uniqueId

: Required: Yes
: Type: string

The unique ID that could not be deleted.

DeletedUniqueId

Description

The deleted unique ID.

Members

uniqueId

: Required: Yes
: Type: string

The unique ID of the deleted item.

Document

Members

ErrorDetails

Description

An object containing an error message, if there was an error.

Members

errorMessage

: Type: string

The error message from the job, if there is one.

ExceedsLimitException

Description

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

Members

message

: Type: string

quotaName

: Type: string

The name of the quota that has been breached.

quotaValue

: Type: int

The current quota value for the customers.

IdMappingJobMetrics

Description

An object containing InputRecords, RecordsNotProcessed, TotalRecordsProcessed, TotalMappedRecords, TotalMappedSourceRecords, and TotalMappedTargetRecords.

Members

inputRecords

: Type: int

The total number of records that were input for processing.

recordsNotProcessed

: Type: int

The total number of records that did not get processed.

totalMappedRecords

: Type: int

The total number of records that were mapped.

totalMappedSourceRecords

: Type: int

The total number of mapped source records.

totalMappedTargetRecords

: Type: int

The total number of distinct mapped target records.

totalRecordsProcessed

: Type: int

The total number of records that were processed.

IdMappingJobOutputSource

Description

An object containing KMSArn, OutputS3Path, and RoleARN.

Members

KMSArn

: Type: string

Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

outputS3Path

: Required: Yes
: Type: string

The S3 path to which Entity Resolution will write the output table.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.

IdMappingRuleBasedProperties

Description

An object that defines the list of matching rules to run in an ID mapping workflow.

Members

attributeMatchingModel

: Required: Yes
: Type: string

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

recordMatchingModel

: Required: Yes
: Type: string

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.

ruleDefinitionType

: Required: Yes
: Type: string

The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

rules

: Type: Array of Rule structures

The rules that can be used for ID mapping.

IdMappingTechniques

Description

An object which defines the ID mapping technique and any additional configurations.

Members

idMappingType

: Required: Yes
: Type: string

The type of ID mapping.

providerProperties

: Type: ProviderProperties structure

An object which defines any additional configurations required by the provider service.

ruleBasedProperties

: Type: IdMappingRuleBasedProperties structure

An object which defines any additional configurations required by rule-based matching.

IdMappingWorkflowInputSource

Description

An object containing InputSourceARN, SchemaName, and Type.

Members

inputSourceARN

: Required: Yes
: Type: string

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

schemaName

: Type: string

The name of the schema to be retrieved.

type

: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId which all sourceIds will resolve to.

IdMappingWorkflowOutputSource

Description

The output source for the ID mapping workflow.

Members

KMSArn

: Type: string

Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

outputS3Path

: Required: Yes
: Type: string

The S3 path to which Entity Resolution will write the output table.

IdMappingWorkflowSummary

Description

A list of IdMappingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was created.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was last updated.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

IdNamespaceIdMappingWorkflowMetadata

Description

The settings for the ID namespace for the ID mapping workflow job.

Members

idMappingType

: Required: Yes
: Type: string

The type of ID mapping.

IdNamespaceIdMappingWorkflowProperties

Description

An object containing IdMappingType, ProviderProperties, and RuleBasedProperties.

Members

idMappingType

: Required: Yes
: Type: string

The type of ID mapping.

providerProperties

: Type: NamespaceProviderProperties structure

An object which defines any additional configurations required by the provider service.

ruleBasedProperties

: Type: NamespaceRuleBasedProperties structure

An object which defines any additional configurations required by rule-based matching.

IdNamespaceInputSource

Description

An object containing InputSourceARN and SchemaName.

Members

inputSourceARN

: Required: Yes
: Type: string

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

schemaName

: Type: string

The name of the schema.

IdNamespaceSummary

Description

A summary of ID namespaces.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was created.

description

: Type: string

The description of the ID namespace.

idMappingWorkflowProperties

: Type: Array of IdNamespaceIdMappingWorkflowMetadata structures

An object which defines any additional configurations required by the ID mapping workflow.

idNamespaceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the ID namespace.

idNamespaceName

: Required: Yes
: Type: string

The name of the ID namespace.

type

: Required: Yes
: Type: string

The type of ID namespace. There are two types: SOURCE and TARGET.

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId which all sourceIds will resolve to.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the ID namespace was last updated.

IncrementalRunConfig

Description

An object which defines an incremental run type and has only incrementalRunType as a field.

Members

incrementalRunType

: Type: string

The type of incremental run. It takes only one value: IMMEDIATE.

InputSource

Description

An object containing InputSourceARN, SchemaName, and ApplyNormalization.

Members

applyNormalization

: Type: boolean

inputSourceARN

: Required: Yes
: Type: string

An Glue table Amazon Resource Name (ARN) for the input source table.

schemaName

: Required: Yes
: Type: string

The name of the schema to be retrieved.

IntermediateSourceConfiguration

Description

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

Members

intermediateS3Path

: Required: Yes
: Type: string

The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET

InternalServerException

Description

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

Members

message

: Type: string

JobMetrics

Description

An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.

Members

inputRecords

: Type: int

The total number of input records.

matchIDs

: Type: int

The total number of matchIDs generated.

recordsNotProcessed

: Type: int

The total number of records that did not get processed.

totalRecordsProcessed

: Type: int

The total number of records processed.

JobOutputSource

Description

An object containing KMSArn, OutputS3Path, and RoleArn.

Members

KMSArn

: Type: string

Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

outputS3Path

: Required: Yes
: Type: string

The S3 path to which Entity Resolution will write the output table.

roleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.

JobSummary

Description

An object containing the JobId, Status, StartTime, and EndTime of a job.

Members

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job has finished.

jobId

: Required: Yes
: Type: string

The ID of the job.

startTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the job was started.

status

: Required: Yes
: Type: string

The current status of the job.

MatchingWorkflowSummary

Description

A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was created.

resolutionType

: Required: Yes
: Type: string

The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the workflow was last updated.

workflowArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.

workflowName

: Required: Yes
: Type: string

The name of the workflow.

NamespaceProviderProperties

Description

An object containing ProviderConfiguration and ProviderServiceArn.

Members

providerConfiguration

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

An object which defines any additional configurations required by the provider service.

providerServiceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the provider service.

NamespaceRuleBasedProperties

Description

The rule-based properties of an ID namespace. These properties define how the ID namespace can be used in an ID mapping workflow.

Members

attributeMatchingModel

: Type: string

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

recordMatchingModels

: Type: Array of strings

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source is matched to one record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

ruleDefinitionTypes

: Type: Array of strings

The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

rules

: Type: Array of Rule structures

The rules for the ID namespace.

OutputAttribute

Description

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

Members

hashed

: Type: boolean

Enables the ability to hash the column values in the output.

name

: Required: Yes
: Type: string

A name of a column to be written to the output. This must be an InputField name in the schema mapping.

OutputSource

Description

Members

KMSArn

: Type: string

Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

applyNormalization

: Type: boolean

output

: Required: Yes
: Type: Array of OutputAttribute structures

outputS3Path

: Required: Yes
: Type: string

The S3 path to which Entity Resolution will write the output table.

ProviderComponentSchema

Description

The input schema supported by provider service.

Members

providerSchemaAttributes

: Type: Array of ProviderSchemaAttribute structures

The provider schema attributes.

schemas

: Type: Array of stringss

Input schema for the provider service.

ProviderEndpointConfiguration

Description

The required configuration fields to use with the provider service.

Members

marketplaceConfiguration

: Type: ProviderMarketplaceConfiguration structure

The identifiers of the provider service, from Data Exchange.

ProviderIdNameSpaceConfiguration

Description

The provider configuration required for different ID namespace types.

Members

description

: Type: string

The description of the ID namespace.

providerSourceConfigurationDefinition

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Configurations required for the source ID namespace.

providerTargetConfigurationDefinition

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

Configurations required for the target ID namespace.

ProviderIntermediateDataAccessConfiguration

Description

The required configuration fields to give intermediate access to a provider service.

Members

awsAccountIds

: Type: Array of strings

The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.

requiredBucketActions

: Type: Array of strings

The S3 bucket actions that the provider requires permission for.

ProviderMarketplaceConfiguration

Description

The identifiers of the provider service, from Data Exchange.

Members

assetId

: Required: Yes
: Type: string

The asset ID on Data Exchange.

dataSetId

: Required: Yes
: Type: string

The dataset ID on Data Exchange.

listingId

: Required: Yes
: Type: string

The listing ID on Data Exchange.

revisionId

: Required: Yes
: Type: string

The revision ID on Data Exchange.

ProviderProperties

Description

An object containing the providerServiceARN, intermediateSourceConfiguration, and providerConfiguration.

Members

intermediateSourceConfiguration

: Type: IntermediateSourceConfiguration structure

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

providerConfiguration

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The required configuration fields to use with the provider service.

providerServiceArn

: Required: Yes
: Type: string

The ARN of the provider service.

ProviderSchemaAttribute

Description

The provider schema attribute.

Members

fieldName

: Required: Yes
: Type: string

The field name.

hashing

: Type: boolean

The hashing attribute of the provider schema.

subType

: Type: string

The sub type of the provider schema attribute.

type

: Required: Yes
: Type: string

The type of the provider schema attribute.

ProviderServiceSummary

Description

A list of ProviderService objects, each of which contain the fields providerName, providerServiceArn, providerServiceName, and providerServiceType.

Members

providerName

: Required: Yes
: Type: string

The name of the provider. This name is typically the company name.

providerServiceArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the providerService.

providerServiceDisplayName

: Required: Yes
: Type: string

The display name of the provider service.

providerServiceName

: Required: Yes
: Type: string

The name of the product that the provider service provides.

providerServiceType

: Required: Yes
: Type: string

The type of provider service.

ResolutionTechniques

Description

An object which defines the resolutionType and the ruleBasedProperties.

Members

providerProperties

: Type: ProviderProperties structure

The properties of the provider service.

resolutionType

: Required: Yes
: Type: string

The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

ruleBasedProperties

: Type: RuleBasedProperties structure

An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

ResourceNotFoundException

Description

The resource could not be found.

Members

message

: Type: string

Rule

Description

An object containing RuleName, and MatchingKeys.

Members

matchingKeys

: Required: Yes
: Type: Array of strings

A list of MatchingKeys. The MatchingKeys must have been defined in the SchemaMapping. Two records are considered to match according to this rule if all of the MatchingKeys match.

ruleName

: Required: Yes
: Type: string

A name for the matching rule.

RuleBasedProperties

Description

An object which defines the list of matching rules to run in a matching workflow. RuleBasedProperties contain a Rules field, which is a list of rule objects.

Members

attributeMatchingModel

: Required: Yes
: Type: string

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

matchPurpose

: Type: string

An indicator of whether to generate IDs and index the data or not.

If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

If you choose INDEXING, the process indexes the data without generating IDs.

rules

: Required: Yes
: Type: Array of Rule structures

A list of Rule objects, each of which have fields RuleName and MatchingKeys.

SchemaInputAttribute

Description

An object containing FieldName, Type, GroupName, MatchKey, Hashing, and SubType.

Members

fieldName

: Required: Yes
: Type: string

A string containing the field name.

groupName

: Type: string

A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.

hashed

: Type: boolean

Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column values are hashed. If the value is set to FALSE, the column values are cleartext.

matchKey

: Type: string

A key that allows grouping of multiple input attributes into a unified matching group.

For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.

If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

subType

: Type: string

The subtype of the attribute, selected from a list of values.

type

: Required: Yes
: Type: string

The type of the attribute, selected from a list of values.

SchemaMappingSummary

Description

An object containing SchemaName, SchemaArn, CreatedAt, andUpdatedAt.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the SchemaMapping was created.

hasWorkflows

: Required: Yes
: Type: boolean

Specifies whether the schema mapping has been applied to a workflow.

schemaArn

: Required: Yes
: Type: string

The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

schemaName

: Required: Yes
: Type: string

The name of the schema.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the SchemaMapping was last updated.

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Type: string

ValidationException

Description

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

Members

message

: Type: string

AWS EntityResolution 2018-05-10

Operation Summary

Paginators

Operations

AddPolicyStatement

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchDeleteUniqueId

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateIdMappingWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateIdNamespace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMatchingWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSchemaMapping

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteIdMappingWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteIdNamespace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteMatchingWorkflow

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeletePolicyStatement

Parameter Syntax

Parameter Details

Members