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

Class: Aws::Glue::Types::StartJobRunRequest

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 StartJobRunRequest data as a hash:

{
  job_name: "NameString", # required
  job_run_id: "IdString",
  arguments: {
    "GenericString" => "GenericString",
  },
  allocated_capacity: 1,
  timeout: 1,
  max_capacity: 1.0,
  security_configuration: "NameString",
  notification_property: {
    notify_delay_after: 1,
  },
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
  number_of_workers: 1,
}

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) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; 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)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#argumentsHash<String,String>

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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>)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#job_nameString

The name of the job definition to use.

Returns:

  • (String)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#job_run_idString

The ID of a previous JobRun to retry.

Returns:

  • (String)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  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)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#notification_propertyTypes::NotificationProperty

Specifies configuration properties of a job run notification.



9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  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)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#security_configurationString

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

Returns:

  • (String)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end

#timeoutInteger

The JobRun 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). This overrides the timeout value set in the parent job.

Returns:

  • (Integer)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  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 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)


9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 9747

class StartJobRunRequest < Struct.new(
  :job_name,
  :job_run_id,
  :arguments,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :notification_property,
  :worker_type,
  :number_of_workers)
  include Aws::Structure
end