ListMLTransformsCommand

Suggest an Edit

Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.

Example Syntax

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

import { GlueClient, ListMLTransformsCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, ListMLTransformsCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // ListMLTransformsRequest
  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
  },
  Tags: { // TagsMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new ListMLTransformsCommand(input);
const response = await client.send(command);
// { // ListMLTransformsResponse
//   TransformIds: [ // TransformIdList // required
//     "STRING_VALUE",
//   ],
//   NextToken: "STRING_VALUE",
// };

ListMLTransformsCommand Input

See ListMLTransformsCommandInput for more details

Parameter
Type
Description
Filter
TransformFilterCriteria | undefined

A TransformFilterCriteria used to filter the machine learning transforms.

MaxResults
number | undefined

The maximum size of a list to return.

NextToken
string | undefined

A continuation token, if this is a continuation request.

Sort
TransformSortCriteria | undefined

A TransformSortCriteria used to sort the machine learning transforms.

Tags
Record<string, string> | undefined

Specifies to return only these tagged resources.

ListMLTransformsCommand Output

See ListMLTransformsCommandOutput for details

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

The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.

NextToken
string | undefined

A continuation token, if the returned list does not contain the last metric 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.