Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142021,119944.8 KB

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 <code>GetMLTransform</code>.

post/#X-Amz-Target=AWSGlue.GetMLTransform

Headers

X-Amz-Target'AWSGlue.GetMLTransform' required

Request body

TransformIdstring required

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

Response

Success

TransformIdstring

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

Namestring

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

Descriptionstring

A description of the transform.

Status'NOT_READY' | 'READY' | 'DELETING'

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

CreatedOnstring date-time

The date and time when the transform was created.

LastModifiedOnstring date-time

The date and time when the transform was last modified.

LabelCountinteger

The number of labels available for this transform.

Rolestring

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

GlueVersionstring

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 <a href="https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions">Glue Versions</a> in the developer guide.

MaxCapacitynumber double
<p>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 <a href="https://aws.amazon.com/glue/pricing/">Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>
WorkerType'Standard' | 'G.1X' | 'G.2X' | 'G.025X'
<p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>
NumberOfWorkersinteger

The number of workers of a defined <code>workerType</code> that are allocated when this task runs.

Timeoutinteger

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 <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).

MaxRetriesinteger

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