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

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",
  },
  default_arguments: {
    "GenericString" => "GenericString",
  },
  connections: {
    connections: ["GenericString"],
  },
  max_retries: 1,
  allocated_capacity: 1,
  timeout: 1,
  notification_property: {
    notify_delay_after: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_capacityInteger

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


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#commandTypes::JobCommand

The JobCommand that executes this job.

Returns:



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#connectionsTypes::ConnectionsList

The connections used for this job.



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  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 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>)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#descriptionString

Description of the job being defined.

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#execution_propertyTypes::ExecutionProperty

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



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#log_uriString

This field is reserved for future use.

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#max_retriesInteger

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

Returns:

  • (Integer)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#notification_propertyTypes::NotificationProperty

Specifies configuration properties of a job notification.



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#roleString

The name or ARN of the IAM role associated with this job.

Returns:

  • (String)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end

#timeoutInteger

The job timeout in minutes. The default is 2880 minutes (48 hours).

Returns:

  • (Integer)


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1620

class CreateJobRequest < Struct.new(
  :name,
  :description,
  :log_uri,
  :role,
  :execution_property,
  :command,
  :default_arguments,
  :connections,
  :max_retries,
  :allocated_capacity,
  :timeout,
  :notification_property)
  include Aws::Structure
end