AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

list-ml-transforms

Description

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.

See also: AWS API Documentation

Synopsis

  list-ml-transforms
[--next-token <value>]
[--max-results <value>]
[--filter <value>]
[--sort <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--next-token (string)

A continuation token, if this is a continuation request.

--max-results (integer)

The maximum size of a list to return.

--filter (structure)

A TransformFilterCriteria used to filter the machine learning transforms.

Name -> (string)

A unique transform name that is used to filter the machine learning transforms.

TransformType -> (string)

The type of machine learning transform that is used to filter the machine learning transforms.

Status -> (string)

Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".

GlueVersion -> (string)

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.

CreatedBefore -> (timestamp)

The time and date before which the transforms were created.

CreatedAfter -> (timestamp)

The time and date after which the transforms were created.

LastModifiedBefore -> (timestamp)

Filter on transforms last modified before this date.

LastModifiedAfter -> (timestamp)

Filter on transforms last modified after this date.

Schema -> (list)

Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.

(structure)

A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.

Name -> (string)

The name of the column.

DataType -> (string)

The type of data in the column.

Shorthand Syntax:

Name=string,TransformType=string,Status=string,GlueVersion=string,CreatedBefore=timestamp,CreatedAfter=timestamp,LastModifiedBefore=timestamp,LastModifiedAfter=timestamp,Schema=[{Name=string,DataType=string},{Name=string,DataType=string}]

JSON Syntax:

{
  "Name": "string",
  "TransformType": "FIND_MATCHES",
  "Status": "NOT_READY"|"READY"|"DELETING",
  "GlueVersion": "string",
  "CreatedBefore": timestamp,
  "CreatedAfter": timestamp,
  "LastModifiedBefore": timestamp,
  "LastModifiedAfter": timestamp,
  "Schema": [
    {
      "Name": "string",
      "DataType": "string"
    }
    ...
  ]
}

--sort (structure)

A TransformSortCriteria used to sort the machine learning transforms.

Column -> (string)

The column to be used in the sorting criteria that are associated with the machine learning transform.

SortDirection -> (string)

The sort direction to be used in the sorting criteria that are associated with the machine learning transform.

Shorthand Syntax:

Column=string,SortDirection=string

JSON Syntax:

{
  "Column": "NAME"|"TRANSFORM_TYPE"|"STATUS"|"CREATED"|"LAST_MODIFIED",
  "SortDirection": "DESCENDING"|"ASCENDING"
}

--tags (map)

Specifies to return only these tagged resources.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

TransformIds -> (list)

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

(string)

NextToken -> (string)

A continuation token, if the returned list does not contain the last metric available.