GetMLTransformsCommand

Suggest an Edit

Gets a sortable, filterable list of existing Glue machine learning transforms. 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, and you can retrieve their metadata by calling GetMLTransforms.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetMLTransformsCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetMLTransformsCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetMLTransformsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  Filter: { // TransformFilterCriteria
    Name: "STRING_VALUE",
    TransformType: "FIND_MATCHES",
    Status: "NOT_READY" || "READY" || "DELETING",
    GlueVersion: "STRING_VALUE",
    CreatedBefore: new Date("TIMESTAMP"),
    CreatedAfter: new Date("TIMESTAMP"),
    LastModifiedBefore: new Date("TIMESTAMP"),
    LastModifiedAfter: new Date("TIMESTAMP"),
    Schema: [ // TransformSchema
      { // SchemaColumn
        Name: "STRING_VALUE",
        DataType: "STRING_VALUE",
      },
    ],
  },
  Sort: { // TransformSortCriteria
    Column: "NAME" || "TRANSFORM_TYPE" || "STATUS" || "CREATED" || "LAST_MODIFIED", // required
    SortDirection: "DESCENDING" || "ASCENDING", // required
  },
};
const command = new GetMLTransformsCommand(input);
const response = await client.send(command);
// { // GetMLTransformsResponse
//   Transforms: [ // TransformList // required
//     { // MLTransform
//       TransformId: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       Status: "NOT_READY" || "READY" || "DELETING",
//       CreatedOn: new Date("TIMESTAMP"),
//       LastModifiedOn: new Date("TIMESTAMP"),
//       InputRecordTables: [ // GlueTables
//         { // GlueTable
//           DatabaseName: "STRING_VALUE", // required
//           TableName: "STRING_VALUE", // required
//           CatalogId: "STRING_VALUE",
//           ConnectionName: "STRING_VALUE",
//           AdditionalOptions: { // GlueTableAdditionalOptions
//             "<keys>": "STRING_VALUE",
//           },
//         },
//       ],
//       Parameters: { // TransformParameters
//         TransformType: "FIND_MATCHES", // required
//         FindMatchesParameters: { // FindMatchesParameters
//           PrimaryKeyColumnName: "STRING_VALUE",
//           PrecisionRecallTradeoff: Number("double"),
//           AccuracyCostTradeoff: Number("double"),
//           EnforceProvidedLabels: true || false,
//         },
//       },
//       EvaluationMetrics: { // EvaluationMetrics
//         TransformType: "FIND_MATCHES", // required
//         FindMatchesMetrics: { // FindMatchesMetrics
//           AreaUnderPRCurve: Number("double"),
//           Precision: Number("double"),
//           Recall: Number("double"),
//           F1: Number("double"),
//           ConfusionMatrix: { // ConfusionMatrix
//             NumTruePositives: Number("long"),
//             NumFalsePositives: Number("long"),
//             NumTrueNegatives: Number("long"),
//             NumFalseNegatives: Number("long"),
//           },
//           ColumnImportances: [ // ColumnImportanceList
//             { // ColumnImportance
//               ColumnName: "STRING_VALUE",
//               Importance: Number("double"),
//             },
//           ],
//         },
//       },
//       LabelCount: Number("int"),
//       Schema: [ // TransformSchema
//         { // SchemaColumn
//           Name: "STRING_VALUE",
//           DataType: "STRING_VALUE",
//         },
//       ],
//       Role: "STRING_VALUE",
//       GlueVersion: "STRING_VALUE",
//       MaxCapacity: Number("double"),
//       WorkerType: "Standard" || "G.1X" || "G.2X" || "G.025X" || "G.4X" || "G.8X" || "Z.2X",
//       NumberOfWorkers: Number("int"),
//       Timeout: Number("int"),
//       MaxRetries: Number("int"),
//       TransformEncryption: { // TransformEncryption
//         MlUserDataEncryption: { // MLUserDataEncryption
//           MlUserDataEncryptionMode: "DISABLED" || "SSE-KMS", // required
//           KmsKeyId: "STRING_VALUE",
//         },
//         TaskRunSecurityConfigurationName: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

GetMLTransformsCommand Input

See GetMLTransformsCommandInput for more details

Parameter
Type
Description
Filter
TransformFilterCriteria | undefined

The filter transformation criteria.

MaxResults
number | undefined

The maximum number of results to return.

NextToken
string | undefined

A paginated token to offset the results.

Sort
TransformSortCriteria | undefined

The sorting criteria.

GetMLTransformsCommand Output

See GetMLTransformsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Transforms
Required
MLTransform[] | undefined

A list of machine learning transforms.

NextToken
string | undefined

A pagination token, if more results are available.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.