matching_workflows

Creates, updates, deletes or gets a matching_workflow resource or lists matching_workflows in a region

Overview

Name	matching_workflows
Type	Resource
Description	MatchingWorkflow defined in AWS Entity Resolution service
Id	aws.entityresolution.matching_workflows

Fields

Name	Datatype	Description
workflow_name	string	The name of the MatchingWorkflow
description	string	The description of the MatchingWorkflow
input_source_config	array
output_source_config	array
resolution_techniques	object
role_arn	string
tags	array
workflow_arn	string	The default MatchingWorkflow arn
created_at	string	The time of this SchemaMapping got created
updated_at	string	The time of this SchemaMapping got last updated at
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	WorkflowName, InputSourceConfig, OutputSourceConfig, ResolutionTechniques, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all matching_workflows in a region.

SELECT
region,
workflow_name,
description,
input_source_config,
output_source_config,
resolution_techniques,
role_arn,
tags,
workflow_arn,
created_at,
updated_at
FROM aws.entityresolution.matching_workflows
WHERE region = 'us-east-1';

Gets all properties from an individual matching_workflow.

SELECT
region,
workflow_name,
description,
input_source_config,
output_source_config,
resolution_techniques,
role_arn,
tags,
workflow_arn,
created_at,
updated_at
FROM aws.entityresolution.matching_workflows
WHERE region = 'us-east-1' AND data__Identifier = '<WorkflowName>';

INSERT example

Use the following StackQL query and manifest file to create a new matching_workflow resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.entityresolution.matching_workflows (
 WorkflowName,
 InputSourceConfig,
 OutputSourceConfig,
 ResolutionTechniques,
 RoleArn,
 region
)
SELECT 
'{{ WorkflowName }}',
 '{{ InputSourceConfig }}',
 '{{ OutputSourceConfig }}',
 '{{ ResolutionTechniques }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.entityresolution.matching_workflows (
 WorkflowName,
 Description,
 InputSourceConfig,
 OutputSourceConfig,
 ResolutionTechniques,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ WorkflowName }}',
 '{{ Description }}',
 '{{ InputSourceConfig }}',
 '{{ OutputSourceConfig }}',
 '{{ ResolutionTechniques }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: matching_workflow
    props:
      - name: WorkflowName
        value: '{{ WorkflowName }}'
      - name: Description
        value: '{{ Description }}'
      - name: InputSourceConfig
        value:
          - InputSourceARN: '{{ InputSourceARN }}'
            SchemaArn: '{{ SchemaArn }}'
            ApplyNormalization: '{{ ApplyNormalization }}'
      - name: OutputSourceConfig
        value:
          - OutputS3Path: '{{ OutputS3Path }}'
            Output:
              - Name: '{{ Name }}'
                Hashed: '{{ Hashed }}'
            KMSArn: '{{ KMSArn }}'
            ApplyNormalization: '{{ ApplyNormalization }}'
      - name: ResolutionTechniques
        value:
          ResolutionType: '{{ ResolutionType }}'
          RuleBasedProperties:
            Rules:
              - RuleName: '{{ RuleName }}'
                MatchingKeys:
                  - null
            AttributeMatchingModel: '{{ AttributeMatchingModel }}'
          ProviderProperties:
            ProviderServiceArn: '{{ ProviderServiceArn }}'
            ProviderConfiguration: {}
            IntermediateSourceConfiguration:
              IntermediateS3Path: '{{ IntermediateS3Path }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.entityresolution.matching_workflows
WHERE data__Identifier = '<WorkflowName>'
AND region = 'us-east-1';

Permissions

To operate on the matching_workflows resource, the following permissions are required:

Create

entityresolution:CreateMatchingWorkflow,
entityresolution:GetMatchingWorkflow,
entityresolution:TagResource,
kms:CreateGrant,
kms:DescribeKey,
iam:PassRole

Read

entityresolution:GetMatchingWorkflow,
entityresolution:ListTagsForResource

Delete

entityresolution:DeleteMatchingWorkflow,
entityresolution:GetMatchingWorkflow,
entityresolution:UntagResource

List

entityresolution:ListMatchingWorkflows

Update

entityresolution:GetMatchingWorkflow,
entityresolution:UpdateMatchingWorkflow,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey