AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateJob operation. Creates a new job definition.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Glue.AmazonGlueRequest
      Amazon.Glue.Model.CreateJobRequest

Namespace: Amazon.Glue.Model
Assembly: AWSSDK.Glue.dll
Version: 3.x.y.z

Syntax

C#
public class CreateJobRequest : AmazonGlueRequest
         IAmazonWebServiceRequest

The CreateJobRequest type exposes the following members

Constructors

NameDescription
Public Method CreateJobRequest()

Properties

NameTypeDescription
Public Property AllocatedCapacity System.Int32

Gets and sets the property AllocatedCapacity.

This parameter is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 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.

Public Property CodeGenConfigurationNodes System.Collections.Generic.Dictionary<System.String, Amazon.Glue.Model.CodeGenConfigurationNode>

Gets and sets the property CodeGenConfigurationNodes.

The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

Public Property Command Amazon.Glue.Model.JobCommand

Gets and sets the property Command.

The JobCommand that runs this job.

Public Property Connections Amazon.Glue.Model.ConnectionsList

Gets and sets the property Connections.

The connections used for this job.

Public Property DefaultArguments System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property DefaultArguments.

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

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

Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.

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 arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.

For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.

Public Property Description System.String

Gets and sets the property Description.

Description of the job being defined.

Public Property ExecutionClass Amazon.Glue.ExecutionClass

Gets and sets the property ExecutionClass.

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

Public Property ExecutionProperty Amazon.Glue.Model.ExecutionProperty

Gets and sets the property ExecutionProperty.

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

Public Property GlueVersion System.String

Gets and sets the property GlueVersion.

In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.

Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime parameter of the Job command.

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.

Public Property LogUri System.String

Gets and sets the property LogUri.

This field is reserved for future use.

Public Property MaxCapacity System.Double

Gets and sets the property MaxCapacity.

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.

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

Do not set MaxCapacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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.

Public Property MaxRetries System.Int32

Gets and sets the property MaxRetries.

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

Public Property Name System.String

Gets and sets the property Name.

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

Public Property NonOverridableArguments System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property NonOverridableArguments.

Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.

Public Property NotificationProperty Amazon.Glue.Model.NotificationProperty

Gets and sets the property NotificationProperty.

Specifies configuration properties of a job notification.

Public Property NumberOfWorkers System.Int32

Gets and sets the property NumberOfWorkers.

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

Public Property Role System.String

Gets and sets the property Role.

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

Public Property SecurityConfiguration System.String

Gets and sets the property SecurityConfiguration.

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

Public Property SourceControlDetails Amazon.Glue.Model.SourceControlDetails

Gets and sets the property SourceControlDetails.

The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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.

Public Property Timeout System.Int32

Gets and sets the property Timeout.

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

Public Property WorkerType Amazon.Glue.WorkerType

Gets and sets the property WorkerType.

The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

  • For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

  • For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.

  • For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.

  • For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5