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	awscc.entityresolution.matching_workflows

Fields

get (all properties)

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
▶incremental_run_config	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
workflow_name	string	The name of the MatchingWorkflow
region	string	AWS region.

For more information, see AWS::EntityResolution::MatchingWorkflow.

Methods

Name	Resource	Accessible by	Required Params
create_resource	matching_workflows	INSERT	WorkflowName, InputSourceConfig, OutputSourceConfig, ResolutionTechniques, RoleArn, region
delete_resource	matching_workflows	DELETE	Identifier, region
update_resource	matching_workflows	UPDATE	Identifier, PatchDocument, region
list_resources	matching_workflows_list_only	SELECT	region
get_resource	matching_workflows	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  incremental_run_config
FROM awscc.entityresolution.matching_workflows
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ workflow_name }}';

list (identifiers only)

Lists all matching_workflows in a region.

SELECT
  region,
  workflow_name
FROM awscc.entityresolution.matching_workflows_list_only
WHERE
  region = '{{ region }}';

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 awscc.entityresolution.matching_workflows (
  WorkflowName,
  InputSourceConfig,
  OutputSourceConfig,
  ResolutionTechniques,
  RoleArn,
  region
)
SELECT
  '{{ workflow_name }}',
  '{{ input_source_config }}',
  '{{ output_source_config }}',
  '{{ resolution_techniques }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.entityresolution.matching_workflows (
  WorkflowName,
  Description,
  InputSourceConfig,
  OutputSourceConfig,
  ResolutionTechniques,
  RoleArn,
  Tags,
  IncrementalRunConfig,
  region
)
SELECT
  '{{ workflow_name }}',
  '{{ description }}',
  '{{ input_source_config }}',
  '{{ output_source_config }}',
  '{{ resolution_techniques }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ incremental_run_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: matching_workflow
  props:
    - name: workflow_name
      value: '{{ workflow_name }}'
    - name: description
      value: '{{ description }}'
    - name: input_source_config
      value:
        - input_source_arn: '{{ input_source_arn }}'
          schema_arn: '{{ schema_arn }}'
          apply_normalization: '{{ apply_normalization }}'
    - name: output_source_config
      value:
        - output_s3_path: '{{ output_s3_path }}'
          output:
            - name: '{{ name }}'
              hashed: '{{ hashed }}'
          kms_arn: '{{ kms_arn }}'
          apply_normalization: '{{ apply_normalization }}'
    - name: resolution_techniques
      value:
        resolution_type: '{{ resolution_type }}'
        rule_based_properties:
          rules:
            - rule_name: '{{ rule_name }}'
              matching_keys:
                - null
          attribute_matching_model: '{{ attribute_matching_model }}'
          match_purpose: '{{ match_purpose }}'
        rule_condition_properties:
          rules:
            - rule_name: null
              condition: '{{ condition }}'
        provider_properties:
          provider_service_arn: '{{ provider_service_arn }}'
          provider_configuration: {}
          intermediate_source_configuration:
            intermediate_s3_path: '{{ intermediate_s3_path }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: incremental_run_config
      value:
        incremental_run_type: '{{ incremental_run_type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.entityresolution.matching_workflows
SET PatchDocument = string('{{ {
    "Description": description,
    "InputSourceConfig": input_source_config,
    "OutputSourceConfig": output_source_config,
    "ResolutionTechniques": resolution_techniques,
    "RoleArn": role_arn,
    "Tags": tags,
    "IncrementalRunConfig": incremental_run_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ workflow_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.entityresolution.matching_workflows
WHERE
  Identifier = '{{ workflow_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
events:PutRule,
events:DeleteRule,
events:PutTargets,
events:ListTargetsByRule

Read

entityresolution:GetMatchingWorkflow,
entityresolution:ListTagsForResource

Delete

entityresolution:DeleteMatchingWorkflow,
entityresolution:GetMatchingWorkflow,
entityresolution:UntagResource,
events:PutRule,
events:DeleteRule,
events:PutTargets,
events:RemoveTargets,
events:ListTargetsByRule

List

entityresolution:ListMatchingWorkflows

Update

entityresolution:GetMatchingWorkflow,
entityresolution:UpdateMatchingWorkflow,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey,
events:PutRule,
events:DeleteRule,
events:PutTargets,
events:RemoveTargets,
events:ListTargetsByRule