Struct aws_sdk_glue::client::fluent_builders::CreateJob

pub struct CreateJob { /* private fields */ }

Fluent builder constructing a request to CreateJob.

Creates a new job definition.

Implementations

impl CreateJob

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateJob, AwsResponseRetryClassifier>, SdkError<CreateJobError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<CreateJobOutput, SdkError<CreateJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn description(self, input: impl Into<String>) -> Self

Description of the job being defined.

pub fn set_description(self, input: Option<String>) -> Self

Description of the job being defined.

pub fn log_uri(self, input: impl Into<String>) -> Self

This field is reserved for future use.

pub fn set_log_uri(self, input: Option<String>) -> Self

This field is reserved for future use.

pub fn role(self, input: impl Into<String>) -> Self

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

pub fn set_role(self, input: Option<String>) -> Self

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

pub fn execution_property(self, input: ExecutionProperty) -> Self

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

pub fn set_execution_property(self, input: Option<ExecutionProperty>) -> Self

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

pub fn command(self, input: JobCommand) -> Self

The JobCommand that runs this job.

pub fn set_command(self, input: Option<JobCommand>) -> Self

The JobCommand that runs this job.

pub fn default_arguments(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to DefaultArguments.

To override the contents of this collection use set_default_arguments.

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.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

pub fn set_default_arguments(
    self,
    input: Option<HashMap<String, String>>
) -> Self

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.

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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

pub fn non_overridable_arguments(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to NonOverridableArguments.

To override the contents of this collection use set_non_overridable_arguments.

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

pub fn set_non_overridable_arguments(
    self,
    input: Option<HashMap<String, String>>
) -> Self

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

pub fn connections(self, input: ConnectionsList) -> Self

The connections used for this job.

pub fn set_connections(self, input: Option<ConnectionsList>) -> Self

The connections used for this job.

pub fn max_retries(self, input: i32) -> Self

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

pub fn set_max_retries(self, input: Option<i32>) -> Self

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

pub fn allocated_capacity(self, input: i32) -> Self

👎Deprecated:

This property is deprecated, use MaxCapacity instead.

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.

pub fn set_allocated_capacity(self, input: Option<i32>) -> Self

👎Deprecated:

This property is deprecated, use MaxCapacity instead.

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.

pub fn timeout(self, input: i32) -> Self

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

pub fn set_timeout(self, input: Option<i32>) -> Self

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

pub fn max_capacity(self, input: f64) -> Self

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 a minimum of 2 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.

pub fn set_max_capacity(self, input: Option<f64>) -> Self

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 a minimum of 2 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.

pub fn security_configuration(self, input: impl Into<String>) -> Self

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

pub fn set_security_configuration(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn notification_property(self, input: NotificationProperty) -> Self

Specifies configuration properties of a job notification.

pub fn set_notification_property(
    self,
    input: Option<NotificationProperty>
) -> Self

Specifies configuration properties of a job notification.

pub fn glue_version(self, input: impl Into<String>) -> Self

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.

pub fn set_glue_version(self, input: Option<String>) -> Self

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.

pub fn number_of_workers(self, input: i32) -> Self

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

pub fn set_number_of_workers(self, input: Option<i32>) -> Self

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

pub fn worker_type(self, input: WorkerType) -> Self

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

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

• For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), 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.

pub fn set_worker_type(self, input: Option<WorkerType>) -> Self

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

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

• For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), 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.

pub fn code_gen_configuration_nodes(
    self,
    k: impl Into<String>,
    v: CodeGenConfigurationNode
) -> Self

Adds a key-value pair to CodeGenConfigurationNodes.

To override the contents of this collection use set_code_gen_configuration_nodes.

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

pub fn set_code_gen_configuration_nodes(
    self,
    input: Option<HashMap<String, CodeGenConfigurationNode>>
) -> Self

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

pub fn execution_class(self, input: ExecutionClass) -> Self

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.

pub fn set_execution_class(self, input: Option<ExecutionClass>) -> Self

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.

Trait Implementations

impl Clone for CreateJob

fn clone(&self) -> CreateJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.