id_mapping_workflows

Creates, updates, deletes, gets or lists an id_mapping_workflows resource.

Overview

Name	id_mapping_workflows
Type	Resource
Id	aws.entityresolution.id_mapping_workflows

Fields

The following fields are returned by SELECT queries:

get_id_mapping_workflow

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the workflow was created.
description	string	A description of the workflow.
id_mapping_techniques	object	An object which defines the ID mapping technique and any additional configurations.
incremental_run_config	object	Incremental run configuration for an ID mapping workflow.
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 and KMSArn.
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. (pattern: <code>$|^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
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 IdMappingWorkflow . (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[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_id_mapping_workflows

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the workflow was created.
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 IdMappingWorkflow. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[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_id_mapping_workflow	select	workflow_name, region		Returns the IdMappingWorkflow with a given name, if it exists.
list_id_mapping_workflows	select	region	nextToken, maxResults	Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
create_id_mapping_workflow	insert	region, workflowName, inputSourceConfig, idMappingTechniques		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. Incremental processing is not supported for ID mapping workflows.
update_id_mapping_workflow	update	workflow_name, region, inputSourceConfig, idMappingTechniques		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. Incremental processing is not supported for ID mapping workflows.
delete_id_mapping_workflow	delete	workflow_name, region		Deletes the IdMappingWorkflow 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 deleted.
maxResults	integer	The maximum number of objects returned per page.
nextToken	string	The pagination token from the previous API call.

SELECT examples

get_id_mapping_workflow

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

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

list_id_mapping_workflows

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

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

INSERT examples

create_id_mapping_workflow

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. Incremental processing is not supported for ID mapping workflows.

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

Manifest

# Description fields are for documentation purposes
- name: id_mapping_workflows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the id_mapping_workflows resource.
  - name: workflowName
    value: "{{ workflowName }}"
  - name: description
    value: "{{ description }}"
  - name: inputSourceConfig
    value:
      - inputSourceARN: "{{ inputSourceARN }}"
        schemaName: "{{ schemaName }}"
        type_: "{{ type_ }}"
  - name: outputSourceConfig
    value:
      - KMSArn: "{{ KMSArn }}"
        outputS3Path: "{{ outputS3Path }}"
  - name: idMappingTechniques
    description: |
      An object which defines the ID mapping technique and any additional configurations.
    value:
      idMappingType: "{{ idMappingType }}"
      ruleBasedProperties:
        rules:
          - ruleName: "{{ ruleName }}"
            matchingKeys: "{{ matchingKeys }}"
        ruleDefinitionType: "{{ ruleDefinitionType }}"
        attributeMatchingModel: "{{ attributeMatchingModel }}"
        recordMatchingModel: "{{ recordMatchingModel }}"
      providerProperties:
        providerServiceArn: "{{ providerServiceArn }}"
        providerConfiguration: "{{ providerConfiguration }}"
        intermediateSourceConfiguration:
          intermediateS3Path: "{{ intermediateS3Path }}"
  - name: incrementalRunConfig
    description: |
      Incremental run configuration for an ID mapping workflow.
    value:
      incrementalRunType: "{{ incrementalRunType }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_id_mapping_workflow

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. Incremental processing is not supported for ID mapping workflows.

UPDATE aws.entityresolution.id_mapping_workflows
SET 
description = '{{ description }}',
inputSourceConfig = '{{ inputSourceConfig }}',
outputSourceConfig = '{{ outputSourceConfig }}',
idMappingTechniques = '{{ idMappingTechniques }}',
incrementalRunConfig = '{{ incrementalRunConfig }}',
roleArn = '{{ roleArn }}'
WHERE 
workflow_name = '{{ workflow_name }}' --required
AND region = '{{ region }}' --required
AND inputSourceConfig = '{{ inputSourceConfig }}' --required
AND idMappingTechniques = '{{ idMappingTechniques }}' --required
RETURNING
description,
id_mapping_techniques,
incremental_run_config,
input_source_config,
output_source_config,
role_arn,
workflow_arn,
workflow_name;

DELETE examples

delete_id_mapping_workflow

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

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