MLTransform
A structure for a machine learning transform.
Contents
- CreatedOn
-
A timestamp. The time and date that this machine learning transform was created.
Type: Timestamp
Required: No
- Description
-
A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- EvaluationMetrics
-
An
EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.Type: EvaluationMetrics object
Required: No
- GlueVersion
-
This value determines which version of AWS 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 AWS Glue Versions in the developer guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^\w+\.\w+$
Required: No
- InputRecordTables
-
A list of AWS Glue table definitions used by the transform.
Type: Array of GlueTable objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- LabelCount
-
A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
Type: Integer
Required: No
- LastModifiedOn
-
A timestamp. The last point in time when this machine learning transform was modified.
Type: Timestamp
Required: No
- MaxCapacity
-
The number of AWS 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 AWS Glue pricing page
. MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.Type: Double
Required: No
-
- MaxRetries
-
The maximum number of times to retry after an
MLTaskRun
of the machine learning transform fails.Type: Integer
Required: No
- Name
-
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- NumberOfWorkers
-
The number of workers of a defined
workerType
that are allocated when a task of the transform runs.If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa).Type: Integer
Required: No
- Parameters
-
A
TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).Type: TransformParameters object
Required: No
- Role
-
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
Type: String
Required: No
-
- Schema
-
A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
Type: Array of SchemaColumn objects
Array Members: Maximum number of 100 items.
Required: No
- Status
-
The current status of the machine learning transform.
Type: String
Valid Values:
NOT_READY | READY | DELETING
Required: No
- Timeout
-
The timeout in minutes of the machine learning transform.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- TransformEncryption
-
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.
Type: TransformEncryption object
Required: No
- TransformId
-
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- WorkerType
-
The type of predefined worker that is allocated when a task of this transform 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.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
Type: String
Valid Values:
Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: