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

Class: Aws::Glue::Types::Job

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

Overview

Specifies a job definition.

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_capacityInteger

This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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.

Returns:

  • (Integer)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#commandTypes::JobCommand

The JobCommand that executes this job.

Returns:



7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#connectionsTypes::ConnectionsList

The connections used for this job.



7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#created_onTime

The time and date that this job definition was created.

Returns:

  • (Time)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#default_argumentsHash<String,String>

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Returns:

  • (Hash<String,String>)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#descriptionString

A description of the job.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#execution_propertyTypes::ExecutionProperty

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.



7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#glue_versionString

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#last_modified_onTime

The last point in time when this job definition was modified.

Returns:

  • (Time)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#log_uriString

This field is reserved for future use.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#max_capacityFloat

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

Returns:

  • (Float)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#max_retriesInteger

The maximum number of times to retry this job after a JobRun fails.

Returns:

  • (Integer)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#nameString

The name you assign to this job definition.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#notification_propertyTypes::NotificationProperty

Specifies configuration properties of a job notification.



7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#number_of_workersInteger

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

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

Returns:

  • (Integer)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#roleString

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#security_configurationString

The name of the SecurityConfiguration structure to be used with this job.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#timeoutInteger

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Returns:

  • (Integer)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end

#worker_typeString

The type of predefined worker that is allocated when a job 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Returns:

  • (String)


7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7305

class Job < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :created_on,
  :last_modified_on,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :notification_property,
  :glue_version)
  include Aws::Structure
end