Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glue.GetMLTransform

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data GetMLTransform Source #

See: newGetMLTransform smart constructor.

Constructors

GetMLTransform'
Fields transformId :: Text The unique identifier of the transform, generated at the time that the transform was created.

Instances

Instances details

Eq GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods (==) :: GetMLTransform -> GetMLTransform -> Bool # (/=) :: GetMLTransform -> GetMLTransform -> Bool #
Read GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods readsPrec :: Int -> ReadS GetMLTransform # readList :: ReadS [GetMLTransform] # readPrec :: ReadPrec GetMLTransform # readListPrec :: ReadPrec [GetMLTransform] #
Show GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods showsPrec :: Int -> GetMLTransform -> ShowS # show :: GetMLTransform -> String # showList :: [GetMLTransform] -> ShowS #
Generic GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Associated Types type Rep GetMLTransform :: Type -> Type # Methods from :: GetMLTransform -> Rep GetMLTransform x # to :: Rep GetMLTransform x -> GetMLTransform #
NFData GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods rnf :: GetMLTransform -> () #
Hashable GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods hashWithSalt :: Int -> GetMLTransform -> Int # hash :: GetMLTransform -> Int #
ToJSON GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods toJSON :: GetMLTransform -> Value # toEncoding :: GetMLTransform -> Encoding # toJSONList :: [GetMLTransform] -> Value # toEncodingList :: [GetMLTransform] -> Encoding #
AWSRequest GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Associated Types type AWSResponse GetMLTransform # Methods request :: GetMLTransform -> Request GetMLTransform # response :: MonadResource m => Logger -> Service -> Proxy GetMLTransform -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMLTransform))) #
ToHeaders GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods toHeaders :: GetMLTransform -> [Header] #
ToPath GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods toPath :: GetMLTransform -> ByteString #
ToQuery GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods toQuery :: GetMLTransform -> QueryString #
type Rep GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform type Rep GetMLTransform = D1 ('MetaData "GetMLTransform" "Amazonka.Glue.GetMLTransform" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "GetMLTransform'" 'PrefixI 'True) (S1 ('MetaSel ('Just "transformId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetMLTransform Source #
Instance details Defined in Amazonka.Glue.GetMLTransform type AWSResponse GetMLTransform = GetMLTransformResponse

newGetMLTransform Source #

Arguments

:: Text	`$sel:transformId:GetMLTransform'`
-> GetMLTransform

Create a value of GetMLTransform 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:transformId:GetMLTransform', getMLTransform_transformId - The unique identifier of the transform, generated at the time that the transform was created.

Request Lenses

getMLTransform_transformId :: Lens' GetMLTransform Text Source #

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

Destructuring the Response

data GetMLTransformResponse Source #

See: newGetMLTransformResponse smart constructor.

Constructors

GetMLTransformResponse'

Fields

status :: Maybe TransformStatusType
The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
numberOfWorkers :: Maybe Int
The number of workers of a defined workerType that are allocated when this task runs.
lastModifiedOn :: Maybe POSIX
The date and time when the transform was last modified.
labelCount :: Maybe Int
The number of labels available for this transform.
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.
inputRecordTables :: Maybe [GlueTable]
A list of Glue table definitions used by the transform.
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.
evaluationMetrics :: Maybe EvaluationMetrics
The latest evaluation metrics.
schema :: Maybe [SchemaColumn]
The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
role' :: Maybe Text
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
name :: Maybe Text
The unique name given to the transform when it was created.
parameters :: Maybe TransformParameters
The configuration parameters that are specific to the algorithm used.
maxRetries :: Maybe Int
The maximum number of times to retry a task for this transform after a task run fails.
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.
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).
transformEncryption :: Maybe 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.
description :: Maybe Text
A description of the transform.
createdOn :: Maybe POSIX
The date and time when the transform was created.
transformId :: Maybe Text
The unique identifier of the transform, generated at the time that the transform was created.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods (==) :: GetMLTransformResponse -> GetMLTransformResponse -> Bool # (/=) :: GetMLTransformResponse -> GetMLTransformResponse -> Bool #
Read GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods readsPrec :: Int -> ReadS GetMLTransformResponse # readList :: ReadS [GetMLTransformResponse] # readPrec :: ReadPrec GetMLTransformResponse # readListPrec :: ReadPrec [GetMLTransformResponse] #
Show GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods showsPrec :: Int -> GetMLTransformResponse -> ShowS # show :: GetMLTransformResponse -> String # showList :: [GetMLTransformResponse] -> ShowS #
Generic GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Associated Types type Rep GetMLTransformResponse :: Type -> Type # Methods from :: GetMLTransformResponse -> Rep GetMLTransformResponse x # to :: Rep GetMLTransformResponse x -> GetMLTransformResponse #
NFData GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform Methods rnf :: GetMLTransformResponse -> () #
type Rep GetMLTransformResponse Source #
Instance details Defined in Amazonka.Glue.GetMLTransform type Rep GetMLTransformResponse = D1 ('MetaData "GetMLTransformResponse" "Amazonka.Glue.GetMLTransform" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "GetMLTransformResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformStatusType)) :: S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "lastModifiedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "labelCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType))))) :: ((S1 ('MetaSel ('Just "inputRecordTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlueTable])) :: S1 ('MetaSel ('Just "glueVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "evaluationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationMetrics)) :: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchemaColumn])) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformParameters))) :: (S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "transformEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransformEncryption)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "transformId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetMLTransformResponse Source #

Arguments

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

Create a value of GetMLTransformResponse 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:status:GetMLTransformResponse', getMLTransformResponse_status - The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".

$sel:numberOfWorkers:GetMLTransformResponse', getMLTransformResponse_numberOfWorkers - The number of workers of a defined workerType that are allocated when this task runs.

$sel:lastModifiedOn:GetMLTransformResponse', getMLTransformResponse_lastModifiedOn - The date and time when the transform was last modified.

$sel:labelCount:GetMLTransformResponse', getMLTransformResponse_labelCount - The number of labels available for this transform.

$sel:workerType:GetMLTransformResponse', getMLTransformResponse_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.

$sel:inputRecordTables:GetMLTransformResponse', getMLTransformResponse_inputRecordTables - A list of Glue table definitions used by the transform.

$sel:glueVersion:GetMLTransformResponse', getMLTransformResponse_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:evaluationMetrics:GetMLTransformResponse', getMLTransformResponse_evaluationMetrics - The latest evaluation metrics.

$sel:schema:GetMLTransformResponse', getMLTransformResponse_schema - The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

$sel:role':GetMLTransformResponse', getMLTransformResponse_role - The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

$sel:name:GetMLTransformResponse', getMLTransformResponse_name - The unique name given to the transform when it was created.

$sel:parameters:GetMLTransformResponse', getMLTransformResponse_parameters - The configuration parameters that are specific to the algorithm used.

$sel:maxRetries:GetMLTransformResponse', getMLTransformResponse_maxRetries - The maximum number of times to retry a task for this transform after a task run fails.

$sel:maxCapacity:GetMLTransformResponse', getMLTransformResponse_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.

$sel:timeout:GetMLTransformResponse', getMLTransformResponse_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).

$sel:transformEncryption:GetMLTransformResponse', getMLTransformResponse_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:description:GetMLTransformResponse', getMLTransformResponse_description - A description of the transform.

$sel:createdOn:GetMLTransformResponse', getMLTransformResponse_createdOn - The date and time when the transform was created.

$sel:transformId:GetMLTransform', getMLTransformResponse_transformId - The unique identifier of the transform, generated at the time that the transform was created.

$sel:httpStatus:GetMLTransformResponse', getMLTransformResponse_httpStatus - The response's http status code.

Response Lenses

getMLTransformResponse_status :: Lens' GetMLTransformResponse (Maybe TransformStatusType) Source #

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

getMLTransformResponse_numberOfWorkers :: Lens' GetMLTransformResponse (Maybe Int) Source #

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

getMLTransformResponse_lastModifiedOn :: Lens' GetMLTransformResponse (Maybe UTCTime) Source #

The date and time when the transform was last modified.

getMLTransformResponse_labelCount :: Lens' GetMLTransformResponse (Maybe Int) Source #

The number of labels available for this transform.

getMLTransformResponse_workerType :: Lens' GetMLTransformResponse (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.

getMLTransformResponse_inputRecordTables :: Lens' GetMLTransformResponse (Maybe [GlueTable]) Source #

A list of Glue table definitions used by the transform.

getMLTransformResponse_glueVersion :: Lens' GetMLTransformResponse (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.

getMLTransformResponse_evaluationMetrics :: Lens' GetMLTransformResponse (Maybe EvaluationMetrics) Source #

The latest evaluation metrics.

getMLTransformResponse_schema :: Lens' GetMLTransformResponse (Maybe [SchemaColumn]) Source #

The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

getMLTransformResponse_role :: Lens' GetMLTransformResponse (Maybe Text) Source #

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

getMLTransformResponse_name :: Lens' GetMLTransformResponse (Maybe Text) Source #

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

getMLTransformResponse_parameters :: Lens' GetMLTransformResponse (Maybe TransformParameters) Source #

The configuration parameters that are specific to the algorithm used.

getMLTransformResponse_maxRetries :: Lens' GetMLTransformResponse (Maybe Int) Source #

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

getMLTransformResponse_maxCapacity :: Lens' GetMLTransformResponse (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.

getMLTransformResponse_timeout :: Lens' GetMLTransformResponse (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).

getMLTransformResponse_transformEncryption :: Lens' GetMLTransformResponse (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.

getMLTransformResponse_description :: Lens' GetMLTransformResponse (Maybe Text) Source #

A description of the transform.

getMLTransformResponse_createdOn :: Lens' GetMLTransformResponse (Maybe UTCTime) Source #

The date and time when the transform was created.

getMLTransformResponse_transformId :: Lens' GetMLTransformResponse (Maybe Text) Source #

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

getMLTransformResponse_httpStatus :: Lens' GetMLTransformResponse Int Source #

The response's http status code.