You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::CreateMLTransformRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass CreateMLTransformRequest data as a hash:

{
  name: "NameString", # required
  description: "DescriptionString",
  input_record_tables: [ # required
    {
      database_name: "NameString", # required
      table_name: "NameString", # required
      catalog_id: "NameString",
      connection_name: "NameString",
    },
  ],
  parameters: { # required
    transform_type: "FIND_MATCHES", # required, accepts FIND_MATCHES
    find_matches_parameters: {
      primary_key_column_name: "ColumnNameString",
      precision_recall_tradeoff: 1.0,
      accuracy_cost_tradeoff: 1.0,
      enforce_provided_labels: false,
    },
  },
  role: "RoleString", # required
  max_capacity: 1.0,
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
  number_of_workers: 1,
  timeout: 1,
  max_retries: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the machine learning transform that is being defined. The default is an empty string.

Returns:

  • (String)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#input_record_tablesArray<Types::GlueTable>

A list of AWS Glue table definitions used by the transform.

Returns:



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#max_capacityFloat

The number of AWS 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 AWS 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.

Returns:

  • (Float)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#max_retriesInteger

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

Returns:

  • (Integer)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#nameString

The unique name that you give the transform when you create it.

Returns:

  • (String)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#number_of_workersInteger

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

Returns:

  • (Integer)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#parametersTypes::TransformParameters

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#roleString

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.

Returns:

  • (String)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#timeoutInteger

The timeout of the 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).

Returns:

  • (Integer)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end

#worker_typeString

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.

Returns:

  • (String)


2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2809

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries)
  include Aws::Structure
end