Skip to content
AWS for Query.Farm

aws.glue.get_ml_transform

Example SQL Queries

SELECT * FROM
aws.glue.get_ml_transform
WHERE
"transform_id" = 'VALUE';

Description

Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform.

Table Definition

Column NameColumn Data Type
transform_id Required Input Column

The unique identifier of the transform, generated at the time that the transform was created.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
created_on

The date and time when the transform was created.

TIMESTAMP_S
description

A description of the transform.

VARCHAR
evaluation_metrics

The latest evaluation metrics.

STRUCT(
    "transform_type" VARCHAR,
    "find_matches_metrics" STRUCT(
        "area_under_pr_curve" DOUBLE,
        "precision" DOUBLE,
        "recall" DOUBLE,
        "f1" DOUBLE,
        "confusion_matrix" STRUCT(
            "num_true_positives" BIGINT,
            "num_false_positives" BIGINT,
            "num_true_negatives" BIGINT,
            "num_false_negatives" BIGINT
        ),
        "column_importances" STRUCT(
            "column_name" VARCHAR,
            "importance" DOUBLE
        )[]
    )
)
Show child fields
evaluation_metrics.find_matches_metrics

The evaluation metrics for the find matches algorithm.

Show child fields
evaluation_metrics.find_matches_metrics.area_under_pr_curve

The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.

For more information, see Precision and recall in Wikipedia.

evaluation_metrics.find_matches_metrics.column_importances[]
Show child fields
evaluation_metrics.find_matches_metrics.column_importances[].column_name

The name of a column.

evaluation_metrics.find_matches_metrics.column_importances[].importance

The column importance score for the column, as a decimal.

evaluation_metrics.find_matches_metrics.confusion_matrix

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

For more information, see Confusion matrix in Wikipedia.

Show child fields
evaluation_metrics.find_matches_metrics.confusion_matrix.num_false_negatives

The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.

evaluation_metrics.find_matches_metrics.confusion_matrix.num_false_positives

The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.

evaluation_metrics.find_matches_metrics.confusion_matrix.num_true_negatives

The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.

evaluation_metrics.find_matches_metrics.confusion_matrix.num_true_positives

The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.

evaluation_metrics.find_matches_metrics.f1

The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.

For more information, see F1 score in Wikipedia.

evaluation_metrics.find_matches_metrics.precision

The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

For more information, see Precision and recall in Wikipedia.

evaluation_metrics.find_matches_metrics.recall

The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.

For more information, see Precision and recall in Wikipedia.

evaluation_metrics.transform_type

The type of machine learning transform.

glue_version

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

VARCHAR
input_record_tables

A list of Glue table definitions used by the transform.

STRUCT(
    "database_name" VARCHAR,
    "table_name" VARCHAR,
    "catalog_id" VARCHAR,
    "connection_name" VARCHAR,
    "additional_options" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
input_record_tables[]
Show child fields
input_record_tables[].additional_options

Additional options for the table. Currently there are two keys supported:

  • pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset.

  • catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.

input_record_tables[].catalog_id

A unique identifier for the Glue Data Catalog.

input_record_tables[].connection_name

The name of the connection to the Glue Data Catalog.

input_record_tables[].database_name

A database name in the Glue Data Catalog.

input_record_tables[].table_name

A table name in the Glue Data Catalog.

label_count

The number of labels available for this transform.

BIGINT
last_modified_on

The date and time when the transform was last modified.

TIMESTAMP_S
max_capacity

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

DOUBLE
max_retries

The maximum number of times to retry a task for this transform after a task run fails.

BIGINT
name

The unique name given to the transform when it was created.

VARCHAR
number_of_workers

The number of workers of a defined workerType that are allocated when this task runs.

BIGINT
parameters

The configuration parameters that are specific to the algorithm used.

STRUCT(
    "transform_type" VARCHAR,
    "find_matches_parameters" STRUCT(
        "primary_key_column_name" VARCHAR,
        "precision_recall_tradeoff" DOUBLE,
        "accuracy_cost_tradeoff" DOUBLE,
        "enforce_provided_labels" BOOLEAN
    )
)
Show child fields
parameters.find_matches_parameters

The parameters for the find matches algorithm.

Show child fields
parameters.find_matches_parameters.accuracy_cost_tradeoff

The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

Cost measures how many compute resources, and thus money, are consumed to run the transform.

parameters.find_matches_parameters.enforce_provided_labels

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

Note that setting this value to true may increase the conflation execution time.

parameters.find_matches_parameters.precision_recall_tradeoff

The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.

The precision metric indicates how often your model is correct when it predicts a match.

The recall metric indicates that for an actual match, how often your model predicts the match.

parameters.find_matches_parameters.primary_key_column_name

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

parameters.transform_type

The type of machine learning transform.

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

role

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

VARCHAR
schema

The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

STRUCT(
    "name" VARCHAR,
    "data_type" VARCHAR
)[]
Show child fields
schema[]
Show child fields
schema[].data_type

The type of data in the column.

schema[].name

The name of the column.

status

The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".

VARCHAR
timeout

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

BIGINT
transform_encryption

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

STRUCT(
    "ml_user_data_encryption" STRUCT(
        "ml_user_data_encryption_mode" VARCHAR,
        "kms_key_id" VARCHAR
    ),
    "task_run_security_configuration_name" VARCHAR
)
Show child fields
transform_encryption.ml_user_data_encryption

An MLUserDataEncryption object containing the encryption mode and customer-provided KMS key ID.

Show child fields
transform_encryption.ml_user_data_encryption.kms_key_id

The ID for the customer-provided KMS key.

transform_encryption.ml_user_data_encryption.ml_user_data_encryption_mode

The encryption mode applied to user data. Valid values are:

  • DISABLED: encryption is disabled

  • SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.

transform_encryption.task_run_security_configuration_name

The name of the security configuration.

worker_type

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

VARCHAR