Skip to content

GetMLTransformResponse

Source code in docs_src/capo_glue/types/get_ml_transform_response.py
class GetMLTransformResponse(TypedDict, closed=True):
    transform_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The unique identifier of the transform, generated at the time that the transform was created.</p>"""
    name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The unique name given to the transform when it was created.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>A description of the transform.</p>"""
    status: NotRequired["capo_glue.types.transform_status_type.TransformStatusType"]
    """<p>The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".</p>"""
    created_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when the transform was created.</p>"""
    last_modified_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when the transform was last modified.</p>"""
    input_record_tables: NotRequired["capo_glue.types.glue_tables.GlueTables"]
    """<p>A list of Glue table definitions used by the transform.</p>"""
    parameters: NotRequired["capo_glue.types.transform_parameters.TransformParameters"]
    """<p>The configuration parameters that are specific to the algorithm used.</p>"""
    evaluation_metrics: NotRequired[
        "capo_glue.types.evaluation_metrics.EvaluationMetrics"
    ]
    """<p>The latest evaluation metrics.</p>"""
    label_count: "capo_glue.types.label_count.LabelCount"
    """<p>The number of labels available for this transform.</p>"""
    schema: NotRequired["capo_glue.types.transform_schema.TransformSchema"]
    """<p>The <code>Map<Column, Type></code> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.</p>"""
    role: NotRequired["capo_glue.types.role_string.RoleString"]
    """<p>The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.</p>"""
    glue_version: NotRequired["capo_glue.types.glue_version_string.GlueVersionString"]
    """<p>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 <a href="https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions">Glue Versions</a> in the developer guide.</p>"""
    max_capacity: NotRequired["capo_glue.types.nullable_double.NullableDouble"]
    """<p>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 <a href="https://aws.amazon.com/glue/pricing/">Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>"""
    worker_type: NotRequired["capo_glue.types.worker_type.WorkerType"]
    """<p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>"""
    number_of_workers: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>The number of workers of a defined <code>workerType</code> that are allocated when this task runs.</p>"""
    timeout: NotRequired["capo_glue.types.timeout.Timeout"]
    """<p>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 <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"""
    max_retries: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>The maximum number of times to retry a task for this transform after a task run fails.</p>"""
    transform_encryption: NotRequired[
        "capo_glue.types.transform_encryption.TransformEncryption"
    ]
    """<p>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.</p>"""

created_on instance-attribute

created_on: NotRequired[Timestamp]

The date and time when the transform was created.

description instance-attribute

description: NotRequired[DescriptionString]

A description of the transform.

evaluation_metrics instance-attribute

evaluation_metrics: NotRequired[EvaluationMetrics]

The latest evaluation metrics.

glue_version instance-attribute

glue_version: NotRequired[GlueVersionString]

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.

input_record_tables instance-attribute

input_record_tables: NotRequired[GlueTables]

A list of Glue table definitions used by the transform.

label_count instance-attribute

label_count: LabelCount

The number of labels available for this transform.

last_modified_on instance-attribute

last_modified_on: NotRequired[Timestamp]

The date and time when the transform was last modified.

max_capacity instance-attribute

max_capacity: NotRequired[NullableDouble]

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.

max_retries instance-attribute

max_retries: NotRequired[NullableInteger]

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

name instance-attribute

name: NotRequired[NameString]

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

number_of_workers instance-attribute

number_of_workers: NotRequired[NullableInteger]

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

parameters instance-attribute

parameters: NotRequired[TransformParameters]

The configuration parameters that are specific to the algorithm used.

role instance-attribute

role: NotRequired[RoleString]

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

schema instance-attribute

schema: NotRequired[TransformSchema]

The Map object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

status instance-attribute

status: NotRequired[TransformStatusType]

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

timeout instance-attribute

timeout: NotRequired[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).

transform_encryption instance-attribute

transform_encryption: NotRequired[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.

transform_id instance-attribute

transform_id: NotRequired[HashString]

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

worker_type instance-attribute

worker_type: NotRequired[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.