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

Amazonka.Glue.UpdateMLTransform

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).

Synopsis

data UpdateMLTransform = UpdateMLTransform' {
- description :: Maybe Text
- glueVersion :: Maybe Text
- maxCapacity :: Maybe Double
- maxRetries :: Maybe Int
- name :: Maybe Text
- numberOfWorkers :: Maybe Int
- parameters :: Maybe TransformParameters
- role' :: Maybe Text
- timeout :: Maybe Natural
- workerType :: Maybe WorkerType
- transformId :: Text
}
newUpdateMLTransform :: Text -> UpdateMLTransform
updateMLTransform_description :: Lens' UpdateMLTransform (Maybe Text)
updateMLTransform_glueVersion :: Lens' UpdateMLTransform (Maybe Text)
updateMLTransform_maxCapacity :: Lens' UpdateMLTransform (Maybe Double)
updateMLTransform_maxRetries :: Lens' UpdateMLTransform (Maybe Int)
updateMLTransform_name :: Lens' UpdateMLTransform (Maybe Text)
updateMLTransform_numberOfWorkers :: Lens' UpdateMLTransform (Maybe Int)
updateMLTransform_parameters :: Lens' UpdateMLTransform (Maybe TransformParameters)
updateMLTransform_role :: Lens' UpdateMLTransform (Maybe Text)
updateMLTransform_timeout :: Lens' UpdateMLTransform (Maybe Natural)
updateMLTransform_workerType :: Lens' UpdateMLTransform (Maybe WorkerType)
updateMLTransform_transformId :: Lens' UpdateMLTransform Text
data UpdateMLTransformResponse = UpdateMLTransformResponse' {
- transformId :: Maybe Text
- httpStatus :: Int
}
newUpdateMLTransformResponse :: Int -> UpdateMLTransformResponse
updateMLTransformResponse_transformId :: Lens' UpdateMLTransformResponse (Maybe Text)
updateMLTransformResponse_httpStatus :: Lens' UpdateMLTransformResponse Int

Creating a Request

data UpdateMLTransform Source #

See: newUpdateMLTransform smart constructor.

Constructors

UpdateMLTransform'

Fields

description :: Maybe Text
A description of the transform. The default is an empty string.
glueVersion :: Maybe Text
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.
maxCapacity :: Maybe Double
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.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.
maxRetries :: Maybe Int
The maximum number of times to retry a task for this transform after a task run fails.
name :: Maybe Text
The unique name that you gave the transform when you created it.
numberOfWorkers :: Maybe Int
The number of workers of a defined workerType that are allocated when this task runs.
parameters :: Maybe TransformParameters
The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
role' :: Maybe Text
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
timeout :: Maybe Natural
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 TIMEOUT status. The default is 2,880 minutes (48 hours).
workerType :: Maybe WorkerType
The type of predefined worker that is allocated when this task 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.
transformId :: Text
A unique identifier that was generated when the transform was created.

Instances

Instances details

ToJSON UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods toJSON :: UpdateMLTransform -> Value # toEncoding :: UpdateMLTransform -> Encoding # toJSONList :: [UpdateMLTransform] -> Value # toEncodingList :: [UpdateMLTransform] -> Encoding #
ToHeaders UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods toHeaders :: UpdateMLTransform -> [Header] #
ToPath UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods toPath :: UpdateMLTransform -> ByteString #
ToQuery UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods toQuery :: UpdateMLTransform -> QueryString #
AWSRequest UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Associated Types type AWSResponse UpdateMLTransform # Methods request :: (Service -> Service) -> UpdateMLTransform -> Request UpdateMLTransform # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateMLTransform -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateMLTransform))) #
Generic UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Associated Types type Rep UpdateMLTransform :: Type -> Type # Methods from :: UpdateMLTransform -> Rep UpdateMLTransform x # to :: Rep UpdateMLTransform x -> UpdateMLTransform #
Read UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods readsPrec :: Int -> ReadS UpdateMLTransform # readList :: ReadS [UpdateMLTransform] # readPrec :: ReadPrec UpdateMLTransform # readListPrec :: ReadPrec [UpdateMLTransform] #
Show UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods showsPrec :: Int -> UpdateMLTransform -> ShowS # show :: UpdateMLTransform -> String # showList :: [UpdateMLTransform] -> ShowS #
NFData UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods rnf :: UpdateMLTransform -> () #
Eq UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods (==) :: UpdateMLTransform -> UpdateMLTransform -> Bool # (/=) :: UpdateMLTransform -> UpdateMLTransform -> Bool #
Hashable UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods hashWithSalt :: Int -> UpdateMLTransform -> Int # hash :: UpdateMLTransform -> Int #
type AWSResponse UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform type AWSResponse UpdateMLTransform = UpdateMLTransformResponse
type Rep UpdateMLTransform Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform type Rep UpdateMLTransform = D1 ('MetaData "UpdateMLTransform" "Amazonka.Glue.UpdateMLTransform" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "UpdateMLTransform'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "glueVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformParameters)) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType)) :: S1 ('MetaSel ('Just "transformId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateMLTransform Source #

Arguments

:: Text	`UpdateMLTransform`
-> UpdateMLTransform

Create a value of UpdateMLTransform 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:

UpdateMLTransform, updateMLTransform_description - A description of the transform. The default is an empty string.

UpdateMLTransform, updateMLTransform_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.

UpdateMLTransform, updateMLTransform_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.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

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

UpdateMLTransform, updateMLTransform_name - The unique name that you gave the transform when you created it.

UpdateMLTransform, updateMLTransform_numberOfWorkers - The number of workers of a defined workerType that are allocated when this task runs.

UpdateMLTransform, updateMLTransform_parameters - The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.

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

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

UpdateMLTransform, updateMLTransform_workerType - The type of predefined worker that is allocated when this task 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.

UpdateMLTransform, updateMLTransform_transformId - A unique identifier that was generated when the transform was created.

Request Lenses

updateMLTransform_description :: Lens' UpdateMLTransform (Maybe Text) Source #

A description of the transform. The default is an empty string.

updateMLTransform_glueVersion :: Lens' UpdateMLTransform (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.

updateMLTransform_maxCapacity :: Lens' UpdateMLTransform (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.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

updateMLTransform_maxRetries :: Lens' UpdateMLTransform (Maybe Int) Source #

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

updateMLTransform_name :: Lens' UpdateMLTransform (Maybe Text) Source #

The unique name that you gave the transform when you created it.

updateMLTransform_numberOfWorkers :: Lens' UpdateMLTransform (Maybe Int) Source #

The number of workers of a defined workerType that are allocated when this task runs.

updateMLTransform_parameters :: Lens' UpdateMLTransform (Maybe TransformParameters) Source #

The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.

updateMLTransform_role :: Lens' UpdateMLTransform (Maybe Text) Source #

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

updateMLTransform_timeout :: Lens' UpdateMLTransform (Maybe Natural) Source #

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

updateMLTransform_workerType :: Lens' UpdateMLTransform (Maybe WorkerType) Source #

The type of predefined worker that is allocated when this task 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.

updateMLTransform_transformId :: Lens' UpdateMLTransform Text Source #

A unique identifier that was generated when the transform was created.

Destructuring the Response

data UpdateMLTransformResponse Source #

See: newUpdateMLTransformResponse smart constructor.

Constructors

UpdateMLTransformResponse'
Fields transformId :: Maybe Text The unique identifier for the transform that was updated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Associated Types type Rep UpdateMLTransformResponse :: Type -> Type # Methods from :: UpdateMLTransformResponse -> Rep UpdateMLTransformResponse x # to :: Rep UpdateMLTransformResponse x -> UpdateMLTransformResponse #
Read UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods readsPrec :: Int -> ReadS UpdateMLTransformResponse # readList :: ReadS [UpdateMLTransformResponse] # readPrec :: ReadPrec UpdateMLTransformResponse # readListPrec :: ReadPrec [UpdateMLTransformResponse] #
Show UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods showsPrec :: Int -> UpdateMLTransformResponse -> ShowS # show :: UpdateMLTransformResponse -> String # showList :: [UpdateMLTransformResponse] -> ShowS #
NFData UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods rnf :: UpdateMLTransformResponse -> () #
Eq UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform Methods (==) :: UpdateMLTransformResponse -> UpdateMLTransformResponse -> Bool # (/=) :: UpdateMLTransformResponse -> UpdateMLTransformResponse -> Bool #
type Rep UpdateMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.UpdateMLTransform type Rep UpdateMLTransformResponse = D1 ('MetaData "UpdateMLTransformResponse" "Amazonka.Glue.UpdateMLTransform" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "UpdateMLTransformResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "transformId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateMLTransformResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateMLTransformResponse'`
-> UpdateMLTransformResponse

Create a value of UpdateMLTransformResponse 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:

UpdateMLTransform, updateMLTransformResponse_transformId - The unique identifier for the transform that was updated.

$sel:httpStatus:UpdateMLTransformResponse', updateMLTransformResponse_httpStatus - The response's http status code.

Response Lenses

updateMLTransformResponse_transformId :: Lens' UpdateMLTransformResponse (Maybe Text) Source #

The unique identifier for the transform that was updated.

updateMLTransformResponse_httpStatus :: Lens' UpdateMLTransformResponse Int Source #

The response's http status code.