Class: Aws::Glue::Types::CreateJobRequest

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

{
  name: "NameString", # required
  description: "DescriptionString",
  log_uri: "UriString",
  role: "RoleString", # required
  execution_property: {
    max_concurrent_runs: 1,
  },
  command: { # required
    name: "GenericString",
    script_location: "ScriptLocationString",
    python_version: "PythonVersionString",
  },
  default_arguments: {
    "GenericString" => "GenericString",
  },
  non_overridable_arguments: {
    "GenericString" => "GenericString",
  },
  connections: {
    connections: ["GenericString"],
  },
  max_retries: 1,
  allocated_capacity: 1,
  timeout: 1,
  max_capacity: 1.0,
  security_configuration: "NameString",
  tags: {
    "TagKey" => "TagValue",
  },
  notification_property: {
    notify_delay_after: 1,
  },
  glue_version: "GlueVersionString",
  number_of_workers: 1,
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_capacityInteger

This parameter is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate to 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 Glue pricing page.

Returns:

  • (Integer)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#commandTypes::JobCommand

The JobCommand that runs this job.

Returns:



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#connectionsTypes::ConnectionsList

The connections used for this job.



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#default_argumentsHash<String,String>

The default arguments for this job.

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

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

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

Returns:

  • (Hash<String,String>)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Description of the job being defined.

Returns:

  • (String)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#execution_propertyTypes::ExecutionProperty

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



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#glue_versionString

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

For more information about the available 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)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#log_uriString

This field is reserved for future use.

Returns:

  • (String)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacityFloat

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 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") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

Returns:

  • (Float)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_retriesInteger

The maximum number of times to retry this job if it fails.

Returns:

  • (Integer)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name you assign to this job definition. It must be unique in your account.

Returns:

  • (String)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#non_overridable_argumentsHash<String,String>

Non-overridable arguments for this job, specified as name-value pairs.

Returns:

  • (Hash<String,String>)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#notification_propertyTypes::NotificationProperty

Specifies configuration properties of a job notification.



3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  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)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

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

Returns:

  • (String)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_configurationString

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

Returns:

  • (String)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

Returns:

  • (Hash<String,String>)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  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)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  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)


3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3792

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :non_overridable_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :max_capacity,
  :security_configuration,
  :tags,
  :notification_property,
  :glue_version,
  :number_of_workers,
  :worker_type)
  SENSITIVE = []
  include Aws::Structure
end