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

Inherits:

Struct

Object
Struct
Aws::Glue::Types::CreateMLTransformRequest

show all

Includes:: Structure

Defined in:: 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
  glue_version: "GlueVersionString",
  max_capacity: 1.0,
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
  number_of_workers: 1,
  timeout: 1,
  max_retries: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  transform_encryption: {
    ml_user_data_encryption: {
      ml_user_data_encryption_mode: "DISABLED", # required, accepts DISABLED, SSE-KMS
      kms_key_id: "NameString",
    },
    task_run_security_configuration_name: "NameString",
  },
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#description ⇒ String

A description of the machine learning transform that is being defined.
#glue_version ⇒ String

This value determines which version of AWS Glue this machine learning transform is compatible with.
#input_record_tables ⇒ Array<Types::GlueTable>

A list of AWS Glue table definitions used by the transform.
#max_capacity ⇒ Float

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
#max_retries ⇒ Integer

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

The unique name that you give the transform when you create it.
#number_of_workers ⇒ Integer

The number of workers of a defined ‘workerType` that are allocated when this task runs.
#parameters ⇒ Types::TransformParameters

The algorithmic parameters that are specific to the transform type used.
#role ⇒ String

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
#tags ⇒ Hash<String,String>

The tags to use with this machine learning transform.
#timeout ⇒ Integer

The timeout of the task run for this transform in minutes.
#transform_encryption ⇒ Types::TransformEncryption

The encryption-at-rest settings of the transform that apply to accessing user data.
#worker_type ⇒ String

The type of predefined worker that is allocated when this task runs.

Instance Attribute Details

#description ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#glue_version ⇒ `String`

This value determines which version of AWS 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 [AWS Glue Versions] in the developer guide.

[1]: docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#input_record_tables ⇒ `Array<Types::GlueTable>`

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

Returns:

(Array<Types::GlueTable>)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ `Float`

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

‘MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType`.

If either ‘NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.
If ‘MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.
If ‘WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).
‘MaxCapacity` and `NumberOfWorkers` 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.

[1]: aws.amazon.com/glue/pricing/

Returns:

(Float)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#max_retries ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_workers ⇒ `Integer`

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

If ‘WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ `Types::TransformParameters`

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

Returns:

(Types::TransformParameters)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See [Attach a Policy to IAM Users That Access AWS 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.

[1]: docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see [AWS Tags in AWS Glue] in the developer guide.

[1]: docs.aws.amazon.com/glue/latest/dg/monitor-tags.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ `Integer`

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)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#transform_encryption ⇒ `Types::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.

Returns:

(Types::TransformEncryption)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

#worker_type ⇒ `String`

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.

‘MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType`.

If either ‘NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set.
If ‘MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set.
If ‘WorkerType` is set, then `NumberOfWorkers` is required (and vice versa).
‘MaxCapacity` and `NumberOfWorkers` must both be at least 1.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 3752

class CreateMLTransformRequest < Struct.new(
  :name,
  :description,
  :input_record_tables,
  :parameters,
  :role,
  :glue_version,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :timeout,
  :max_retries,
  :tags,
  :transform_encryption)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

#glue_version ⇒ String

#input_record_tables ⇒ Array<Types::GlueTable>

#max_capacity ⇒ Float

#max_retries ⇒ Integer

#name ⇒ String

#number_of_workers ⇒ Integer

#parameters ⇒ Types::TransformParameters

#role ⇒ String

#tags ⇒ Hash<String,String>

#timeout ⇒ Integer

#transform_encryption ⇒ Types::TransformEncryption

#worker_type ⇒ String

#description ⇒ `String`

#glue_version ⇒ `String`

#input_record_tables ⇒ `Array<Types::GlueTable>`

#max_capacity ⇒ `Float`

#max_retries ⇒ `Integer`

#name ⇒ `String`

#number_of_workers ⇒ `Integer`

#parameters ⇒ `Types::TransformParameters`

#role ⇒ `String`

#tags ⇒ `Hash<String,String>`

#timeout ⇒ `Integer`

#transform_encryption ⇒ `Types::TransformEncryption`

#worker_type ⇒ `String`