matching_workflows

Creates, updates, deletes, gets or lists a matching_workflows resource.

Overview

Name	matching_workflows
Type	Resource
Id	aws.entityresolution.matching_workflows

Fields

The following fields are returned by SELECT queries:

get_matching_workflow

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the workflow was created.
description	string	A description of the workflow.
incremental_run_config	object	Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console. For workflows where resolutionType is PROVIDER, incremental processing is not supported.
input_source_config	array	A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
output_source_config	array	A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.
resolution_techniques	object	An object which defines the resolutionType and the ruleBasedProperties.
role_arn	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	object	The tags used to organize, track, or control access for this resource.
updated_at	string (date-time)	The timestamp of when the workflow was last updated.
workflow_arn	string	The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})</code>)
workflow_name	string	The name of the workflow. (pattern: <code>[a-zA-Z_0-9-]*</code>)

list_matching_workflows

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the workflow was created.
resolution_type	string	The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service. (RULE_MATCHING, ML_MATCHING, PROVIDER)
updated_at	string (date-time)	The timestamp of when the workflow was last updated.
workflow_arn	string	The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})</code>)
workflow_name	string	The name of the workflow. (pattern: <code>[a-zA-Z_0-9-]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_matching_workflow	select	workflow_name, region		Returns the MatchingWorkflow with a given name, if it exists.
list_matching_workflows	select	region	nextToken, maxResults	Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
create_matching_workflow	insert	region, workflowName, inputSourceConfig, outputSourceConfig, resolutionTechniques, roleArn		Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is PROVIDER, incremental processing is not supported.
update_matching_workflow	update	workflow_name, region, inputSourceConfig, outputSourceConfig, resolutionTechniques, roleArn		Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is PROVIDER, incremental processing is not supported.
delete_matching_workflow	delete	workflow_name, region		Deletes the MatchingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
workflow_name	string	The name of the workflow to be retrieved.
maxResults	integer	The maximum number of objects returned per page.
nextToken	string	The pagination token from the previous API call.

SELECT examples

get_matching_workflow

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

SELECT
created_at,
description,
incremental_run_config,
input_source_config,
output_source_config,
resolution_techniques,
role_arn,
tags,
updated_at,
workflow_arn,
workflow_name
FROM aws.entityresolution.matching_workflows
WHERE workflow_name = '{{ workflow_name }}' -- required
AND region = '{{ region }}' -- required
;

list_matching_workflows

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

SELECT
created_at,
resolution_type,
updated_at,
workflow_arn,
workflow_name
FROM aws.entityresolution.matching_workflows
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_matching_workflow

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is PROVIDER, incremental processing is not supported.

INSERT INTO aws.entityresolution.matching_workflows (
workflowName,
description,
inputSourceConfig,
outputSourceConfig,
resolutionTechniques,
incrementalRunConfig,
roleArn,
tags,
region
)
SELECT 
'{{ workflowName }}' /* required */,
'{{ description }}',
'{{ inputSourceConfig }}' /* required */,
'{{ outputSourceConfig }}' /* required */,
'{{ resolutionTechniques }}' /* required */,
'{{ incrementalRunConfig }}',
'{{ roleArn }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
description,
incremental_run_config,
input_source_config,
output_source_config,
resolution_techniques,
role_arn,
workflow_arn,
workflow_name
;

Manifest

# Description fields are for documentation purposes
- name: matching_workflows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the matching_workflows resource.
  - name: workflowName
    value: "{{ workflowName }}"
  - name: description
    value: "{{ description }}"
  - name: inputSourceConfig
    value:
      - inputSourceARN: "{{ inputSourceARN }}"
        schemaName: "{{ schemaName }}"
        applyNormalization: {{ applyNormalization }}
  - name: outputSourceConfig
    value:
      - KMSArn: "{{ KMSArn }}"
        outputS3Path: "{{ outputS3Path }}"
        output: "{{ output }}"
        applyNormalization: {{ applyNormalization }}
        customerProfilesIntegrationConfig:
          domainArn: "{{ domainArn }}"
          objectTypeArn: "{{ objectTypeArn }}"
  - name: resolutionTechniques
    description: |
      An object which defines the resolutionType and the ruleBasedProperties.
    value:
      resolutionType: "{{ resolutionType }}"
      ruleBasedProperties:
        rules:
          - ruleName: "{{ ruleName }}"
            matchingKeys: "{{ matchingKeys }}"
        attributeMatchingModel: "{{ attributeMatchingModel }}"
        matchPurpose: "{{ matchPurpose }}"
      ruleConditionProperties:
        rules:
          - ruleName: "{{ ruleName }}"
            condition: "{{ condition }}"
        matchingConfig:
          enableTransitiveMatching: {{ enableTransitiveMatching }}
      enableRealTimeMatching: {{ enableRealTimeMatching }}
      providerProperties:
        providerServiceArn: "{{ providerServiceArn }}"
        providerConfiguration: "{{ providerConfiguration }}"
        intermediateSourceConfiguration:
          intermediateS3Path: "{{ intermediateS3Path }}"
  - name: incrementalRunConfig
    description: |
      Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console. For workflows where resolutionType is PROVIDER, incremental processing is not supported.
    value:
      incrementalRunType: "{{ incrementalRunType }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_matching_workflow

Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is PROVIDER, incremental processing is not supported.

UPDATE aws.entityresolution.matching_workflows
SET 
description = '{{ description }}',
inputSourceConfig = '{{ inputSourceConfig }}',
outputSourceConfig = '{{ outputSourceConfig }}',
resolutionTechniques = '{{ resolutionTechniques }}',
incrementalRunConfig = '{{ incrementalRunConfig }}',
roleArn = '{{ roleArn }}'
WHERE 
workflow_name = '{{ workflow_name }}' --required
AND region = '{{ region }}' --required
AND inputSourceConfig = '{{ inputSourceConfig }}' --required
AND outputSourceConfig = '{{ outputSourceConfig }}' --required
AND resolutionTechniques = '{{ resolutionTechniques }}' --required
AND roleArn = '{{ roleArn }}' --required
RETURNING
description,
incremental_run_config,
input_source_config,
output_source_config,
resolution_techniques,
role_arn,
workflow_name;

DELETE examples

delete_matching_workflow

Deletes the MatchingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist.

DELETE FROM aws.entityresolution.matching_workflows
WHERE workflow_name = '{{ workflow_name }}' --required
AND region = '{{ region }}' --required
;