Skip to content

aws.entityresolution.get_matching_workflow

Example SQL Queries

SELECT * FROM
aws.entityresolution.get_matching_workflow
WHERE
"workflow_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
workflow_name Required Input Column

The name of the workflow.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

created_at

The timestamp of when the workflow was created.

TIMESTAMP_S
description

A description of the workflow.

VARCHAR
incremental_run_config

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

STRUCT(
"incremental_run_type" VARCHAR
)
Show child fields
incremental_run_config.incremental_run_type

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

input_source_config

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

STRUCT(
"apply_normalization" BOOLEAN,
"input_source_arn" VARCHAR,
"schema_name" VARCHAR
)[]
Show child fields
input_source_config[]
Show child fields
input_source_config[].apply_normalization

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.

input_source_config[].input_source_arn

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

input_source_config[].schema_name

The name of the schema to be retrieved.

output_source_config

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

STRUCT(
"kms_arn" VARCHAR,
"apply_normalization" BOOLEAN,
"output" STRUCT(
"hashed" BOOLEAN,
"name" VARCHAR
)[],
"output_s3_path" VARCHAR
)[]
Show child fields
output_source_config[]
Show child fields
output_source_config[].apply_normalization

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.

output_source_config[].kms_arn

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

output_source_config[].output[]
Show child fields
output_source_config[].output[].hashed

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

output_source_config[].output[].name

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

output_source_config[].output_s3_path

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

resolution_techniques

An object which defines the resolutionType and the ruleBasedProperties.

STRUCT(
"provider_properties" STRUCT(
"intermediate_source_configuration" STRUCT(
"intermediate_s3_path" VARCHAR
),
"provider_configuration" VARCHAR,
"provider_service_arn" VARCHAR
),
"resolution_type" VARCHAR,
"rule_based_properties" STRUCT(
"attribute_matching_model" VARCHAR,
"match_purpose" VARCHAR,
"rules" STRUCT(
"matching_keys" VARCHAR[],
"rule_name" VARCHAR
)[]
)
)
Show child fields
resolution_techniques.provider_properties

The properties of the provider service.

Show child fields
resolution_techniques.provider_properties.intermediate_source_configuration

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

Show child fields
resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path

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

resolution_techniques.provider_properties.provider_configuration

The required configuration fields to use with the provider service.

resolution_techniques.provider_properties.provider_service_arn

The ARN of the provider service.

resolution_techniques.resolution_type

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

resolution_techniques.rule_based_properties

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

Show child fields
resolution_techniques.rule_based_properties.attribute_matching_model

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.

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.

resolution_techniques.rule_based_properties.match_purpose

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.

resolution_techniques.rule_based_properties.rules[]
Show child fields
resolution_techniques.rule_based_properties.rules[].matching_keys[]
resolution_techniques.rule_based_properties.rules[].rule_name

A name for the matching rule.

role_arn

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

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)
updated_at

The timestamp of when the workflow was last updated.

TIMESTAMP_S
workflow_arn

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

VARCHAR