Interface MLTransform.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MLTransform.Builder,
,MLTransform> SdkBuilder<MLTransform.Builder,
,MLTransform> SdkPojo
- Enclosing class:
MLTransform
-
Method Summary
Modifier and TypeMethodDescriptionA timestamp.description
(String description) A user-defined, long-form description text for the machine learning transform.default MLTransform.Builder
evaluationMetrics
(Consumer<EvaluationMetrics.Builder> evaluationMetrics) AnEvaluationMetrics
object.evaluationMetrics
(EvaluationMetrics evaluationMetrics) AnEvaluationMetrics
object.glueVersion
(String glueVersion) This value determines which version of Glue this machine learning transform is compatible with.inputRecordTables
(Collection<GlueTable> inputRecordTables) A list of Glue table definitions used by the transform.inputRecordTables
(Consumer<GlueTable.Builder>... inputRecordTables) A list of Glue table definitions used by the transform.inputRecordTables
(GlueTable... inputRecordTables) A list of Glue table definitions used by the transform.labelCount
(Integer labelCount) A count identifier for the labeling files generated by Glue for this transform.lastModifiedOn
(Instant lastModifiedOn) A timestamp.maxCapacity
(Double maxCapacity) The number of Glue data processing units (DPUs) that are allocated to task runs for this transform.maxRetries
(Integer maxRetries) The maximum number of times to retry after anMLTaskRun
of the machine learning transform fails.A user-defined name for the machine learning transform.numberOfWorkers
(Integer numberOfWorkers) The number of workers of a definedworkerType
that are allocated when a task of the transform runs.default MLTransform.Builder
parameters
(Consumer<TransformParameters.Builder> parameters) ATransformParameters
object.parameters
(TransformParameters parameters) ATransformParameters
object.The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.schema
(Collection<SchemaColumn> schema) A map of key-value pairs representing the columns and data types that this transform can run against.schema
(Consumer<SchemaColumn.Builder>... schema) A map of key-value pairs representing the columns and data types that this transform can run against.schema
(SchemaColumn... schema) A map of key-value pairs representing the columns and data types that this transform can run against.The current status of the machine learning transform.status
(TransformStatusType status) The current status of the machine learning transform.The timeout in minutes of the machine learning transform.default MLTransform.Builder
transformEncryption
(Consumer<TransformEncryption.Builder> transformEncryption) The encryption-at-rest settings of the transform that apply to accessing user data.transformEncryption
(TransformEncryption transformEncryption) The encryption-at-rest settings of the transform that apply to accessing user data.transformId
(String transformId) The unique transform ID that is generated for the machine learning transform.workerType
(String workerType) The type of predefined worker that is allocated when a task of this transform runs.workerType
(WorkerType workerType) The type of predefined worker that is allocated when a task of this transform runs.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
transformId
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
- Parameters:
transformId
- The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
- Parameters:
name
- A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The current status of the machine learning transform.
- Parameters:
status
- The current status of the machine learning transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the machine learning transform.
- Parameters:
status
- The current status of the machine learning transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdOn
A timestamp. The time and date that this machine learning transform was created.
- Parameters:
createdOn
- A timestamp. The time and date that this machine learning transform was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedOn
A timestamp. The last point in time when this machine learning transform was modified.
- Parameters:
lastModifiedOn
- A timestamp. The last point in time when this machine learning transform was modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputRecordTables
A list of Glue table definitions used by the transform.
- Parameters:
inputRecordTables
- A list of Glue table definitions used by the transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputRecordTables
A list of Glue table definitions used by the transform.
- Parameters:
inputRecordTables
- A list of Glue table definitions used by the transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputRecordTables
A list of Glue table definitions used by the transform.
This is a convenience method that creates an instance of theGlueTable.Builder
avoiding the need to create one manually viaGlueTable.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputRecordTables(List<GlueTable>)
.- Parameters:
inputRecordTables
- a consumer that will call methods onGlueTable.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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).- Parameters:
parameters
- ATransformParameters
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
A
This is a convenience method that creates an instance of theTransformParameters
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).TransformParameters.Builder
avoiding the need to create one manually viaTransformParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(TransformParameters)
.- Parameters:
parameters
- a consumer that will call methods onTransformParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
evaluationMetrics
An
EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.- Parameters:
evaluationMetrics
- AnEvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationMetrics
default MLTransform.Builder evaluationMetrics(Consumer<EvaluationMetrics.Builder> evaluationMetrics) An
This is a convenience method that creates an instance of theEvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.EvaluationMetrics.Builder
avoiding the need to create one manually viaEvaluationMetrics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toevaluationMetrics(EvaluationMetrics)
.- Parameters:
evaluationMetrics
- a consumer that will call methods onEvaluationMetrics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
labelCount
A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
- Parameters:
labelCount
- A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theSchemaColumn.Builder
avoiding the need to create one manually viaSchemaColumn.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschema(List<SchemaColumn>)
.- Parameters:
schema
- a consumer that will call methods onSchemaColumn.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
role
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access 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.
- Parameters:
role
- The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
glueVersion
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.
- Parameters:
glueVersion
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxCapacity
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 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.- Parameters:
maxCapacity
- 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 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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).- Parameters:
numberOfWorkers
- The number of workers of a definedworkerType
that are allocated when a task of the transform runs.If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeout
The timeout in minutes of the machine learning transform.
- Parameters:
timeout
- The timeout in minutes of the machine learning transform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxRetries
The maximum number of times to retry after an
MLTaskRun
of the machine learning transform fails.- Parameters:
maxRetries
- The maximum number of times to retry after anMLTaskRun
of the machine learning transform fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transformEncryption
default MLTransform.Builder transformEncryption(Consumer<TransformEncryption.Builder> 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.
This is a convenience method that creates an instance of theTransformEncryption.Builder
avoiding the need to create one manually viaTransformEncryption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totransformEncryption(TransformEncryption)
.- Parameters:
transformEncryption
- a consumer that will call methods onTransformEncryption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-