Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MLTransform = MLTransform' {
- createdOn :: Maybe POSIX
- description :: Maybe Text
- evaluationMetrics :: Maybe EvaluationMetrics
- glueVersion :: Maybe Text
- inputRecordTables :: Maybe [GlueTable]
- labelCount :: Maybe Int
- lastModifiedOn :: Maybe POSIX
- maxCapacity :: Maybe Double
- maxRetries :: Maybe Int
- name :: Maybe Text
- numberOfWorkers :: Maybe Int
- parameters :: Maybe TransformParameters
- role' :: Maybe Text
- schema :: Maybe [SchemaColumn]
- status :: Maybe TransformStatusType
- timeout :: Maybe Natural
- transformEncryption :: Maybe TransformEncryption
- transformId :: Maybe Text
- workerType :: Maybe WorkerType
- newMLTransform :: MLTransform
- mLTransform_createdOn :: Lens' MLTransform (Maybe UTCTime)
- mLTransform_description :: Lens' MLTransform (Maybe Text)
- mLTransform_evaluationMetrics :: Lens' MLTransform (Maybe EvaluationMetrics)
- mLTransform_glueVersion :: Lens' MLTransform (Maybe Text)
- mLTransform_inputRecordTables :: Lens' MLTransform (Maybe [GlueTable])
- mLTransform_labelCount :: Lens' MLTransform (Maybe Int)
- mLTransform_lastModifiedOn :: Lens' MLTransform (Maybe UTCTime)
- mLTransform_maxCapacity :: Lens' MLTransform (Maybe Double)
- mLTransform_maxRetries :: Lens' MLTransform (Maybe Int)
- mLTransform_name :: Lens' MLTransform (Maybe Text)
- mLTransform_numberOfWorkers :: Lens' MLTransform (Maybe Int)
- mLTransform_parameters :: Lens' MLTransform (Maybe TransformParameters)
- mLTransform_role :: Lens' MLTransform (Maybe Text)
- mLTransform_schema :: Lens' MLTransform (Maybe [SchemaColumn])
- mLTransform_status :: Lens' MLTransform (Maybe TransformStatusType)
- mLTransform_timeout :: Lens' MLTransform (Maybe Natural)
- mLTransform_transformEncryption :: Lens' MLTransform (Maybe TransformEncryption)
- mLTransform_transformId :: Lens' MLTransform (Maybe Text)
- mLTransform_workerType :: Lens' MLTransform (Maybe WorkerType)
Documentation
data MLTransform Source #
A structure for a machine learning transform.
See: newMLTransform
smart constructor.
MLTransform' | |
|
Instances
newMLTransform :: MLTransform Source #
Create a value of MLTransform
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdOn:MLTransform'
, mLTransform_createdOn
- A timestamp. The time and date that this machine learning transform was
created.
$sel:description:MLTransform'
, mLTransform_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.
$sel:evaluationMetrics:MLTransform'
, mLTransform_evaluationMetrics
- An EvaluationMetrics
object. Evaluation metrics provide an estimate of
the quality of your machine learning transform.
$sel:glueVersion:MLTransform'
, mLTransform_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.
$sel:inputRecordTables:MLTransform'
, mLTransform_inputRecordTables
- A list of Glue table definitions used by the transform.
$sel:labelCount:MLTransform'
, mLTransform_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.
$sel:lastModifiedOn:MLTransform'
, mLTransform_lastModifiedOn
- A timestamp. The last point in time when this machine learning transform
was modified.
$sel:maxCapacity:MLTransform'
, mLTransform_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 with NumberOfWorkers
and
WorkerType
.
- 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 than Standard
, the
MaxCapacity
field is set automatically and becomes read-only.
$sel:maxRetries:MLTransform'
, mLTransform_maxRetries
- The maximum number of times to retry after an MLTaskRun
of the machine
learning transform fails.
MLTransform
, mLTransform_name
- A user-defined name for the machine learning transform. Names are not
guaranteed unique and can be changed at any time.
$sel:numberOfWorkers:MLTransform'
, mLTransform_numberOfWorkers
- The number of workers of a defined workerType
that are allocated when
a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice
versa).
$sel:parameters:MLTransform'
, mLTransform_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).
$sel:role':MLTransform'
, mLTransform_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.
$sel:schema:MLTransform'
, mLTransform_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.
$sel:status:MLTransform'
, mLTransform_status
- The current status of the machine learning transform.
$sel:timeout:MLTransform'
, mLTransform_timeout
- The timeout in minutes of the machine learning transform.
$sel:transformEncryption:MLTransform'
, mLTransform_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.
$sel:transformId:MLTransform'
, mLTransform_transformId
- The unique transform ID that is generated for the machine learning
transform. The ID is guaranteed to be unique and does not change.
$sel:workerType:MLTransform'
, mLTransform_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 with NumberOfWorkers
and
WorkerType
.
- 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.
mLTransform_createdOn :: Lens' MLTransform (Maybe UTCTime) Source #
A timestamp. The time and date that this machine learning transform was created.
mLTransform_description :: Lens' MLTransform (Maybe Text) Source #
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.
mLTransform_evaluationMetrics :: Lens' MLTransform (Maybe EvaluationMetrics) Source #
An EvaluationMetrics
object. Evaluation metrics provide an estimate of
the quality of your machine learning transform.
mLTransform_glueVersion :: Lens' MLTransform (Maybe Text) Source #
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.
mLTransform_inputRecordTables :: Lens' MLTransform (Maybe [GlueTable]) Source #
A list of Glue table definitions used by the transform.
mLTransform_labelCount :: Lens' MLTransform (Maybe Int) Source #
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.
mLTransform_lastModifiedOn :: Lens' MLTransform (Maybe UTCTime) Source #
A timestamp. The last point in time when this machine learning transform was modified.
mLTransform_maxCapacity :: Lens' MLTransform (Maybe Double) Source #
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 with NumberOfWorkers
and
WorkerType
.
- 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 than Standard
, the
MaxCapacity
field is set automatically and becomes read-only.
mLTransform_maxRetries :: Lens' MLTransform (Maybe Int) Source #
The maximum number of times to retry after an MLTaskRun
of the machine
learning transform fails.
mLTransform_name :: Lens' MLTransform (Maybe Text) Source #
A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
mLTransform_numberOfWorkers :: Lens' MLTransform (Maybe Int) Source #
The number of workers of a defined workerType
that are allocated when
a task of the transform runs.
If WorkerType
is set, then NumberOfWorkers
is required (and vice
versa).
mLTransform_parameters :: Lens' MLTransform (Maybe TransformParameters) Source #
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).
mLTransform_role :: Lens' MLTransform (Maybe Text) Source #
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.
mLTransform_schema :: Lens' MLTransform (Maybe [SchemaColumn]) Source #
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.
mLTransform_status :: Lens' MLTransform (Maybe TransformStatusType) Source #
The current status of the machine learning transform.
mLTransform_timeout :: Lens' MLTransform (Maybe Natural) Source #
The timeout in minutes of the machine learning transform.
mLTransform_transformEncryption :: Lens' MLTransform (Maybe TransformEncryption) Source #
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.
mLTransform_transformId :: Lens' MLTransform (Maybe Text) Source #
The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
mLTransform_workerType :: Lens' MLTransform (Maybe WorkerType) Source #
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 with NumberOfWorkers
and
WorkerType
.
- 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.