AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::JobUpdate Class Reference

#include <JobUpdate.h>

Public Member Functions

 JobUpdate ()
 
 JobUpdate (Aws::Utils::Json::JsonView jsonValue)
 
JobUpdateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
JobUpdateWithDescription (const Aws::String &value)
 
JobUpdateWithDescription (Aws::String &&value)
 
JobUpdateWithDescription (const char *value)
 
const Aws::StringGetLogUri () const
 
bool LogUriHasBeenSet () const
 
void SetLogUri (const Aws::String &value)
 
void SetLogUri (Aws::String &&value)
 
void SetLogUri (const char *value)
 
JobUpdateWithLogUri (const Aws::String &value)
 
JobUpdateWithLogUri (Aws::String &&value)
 
JobUpdateWithLogUri (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
JobUpdateWithRole (const Aws::String &value)
 
JobUpdateWithRole (Aws::String &&value)
 
JobUpdateWithRole (const char *value)
 
const ExecutionPropertyGetExecutionProperty () const
 
bool ExecutionPropertyHasBeenSet () const
 
void SetExecutionProperty (const ExecutionProperty &value)
 
void SetExecutionProperty (ExecutionProperty &&value)
 
JobUpdateWithExecutionProperty (const ExecutionProperty &value)
 
JobUpdateWithExecutionProperty (ExecutionProperty &&value)
 
const JobCommandGetCommand () const
 
bool CommandHasBeenSet () const
 
void SetCommand (const JobCommand &value)
 
void SetCommand (JobCommand &&value)
 
JobUpdateWithCommand (const JobCommand &value)
 
JobUpdateWithCommand (JobCommand &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetDefaultArguments () const
 
bool DefaultArgumentsHasBeenSet () const
 
void SetDefaultArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDefaultArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
JobUpdateWithDefaultArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
JobUpdateWithDefaultArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
JobUpdateAddDefaultArguments (const Aws::String &key, const Aws::String &value)
 
JobUpdateAddDefaultArguments (Aws::String &&key, const Aws::String &value)
 
JobUpdateAddDefaultArguments (const Aws::String &key, Aws::String &&value)
 
JobUpdateAddDefaultArguments (Aws::String &&key, Aws::String &&value)
 
JobUpdateAddDefaultArguments (const char *key, Aws::String &&value)
 
JobUpdateAddDefaultArguments (Aws::String &&key, const char *value)
 
JobUpdateAddDefaultArguments (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetNonOverridableArguments () const
 
bool NonOverridableArgumentsHasBeenSet () const
 
void SetNonOverridableArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetNonOverridableArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
JobUpdateWithNonOverridableArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
JobUpdateWithNonOverridableArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
JobUpdateAddNonOverridableArguments (const Aws::String &key, const Aws::String &value)
 
JobUpdateAddNonOverridableArguments (Aws::String &&key, const Aws::String &value)
 
JobUpdateAddNonOverridableArguments (const Aws::String &key, Aws::String &&value)
 
JobUpdateAddNonOverridableArguments (Aws::String &&key, Aws::String &&value)
 
JobUpdateAddNonOverridableArguments (const char *key, Aws::String &&value)
 
JobUpdateAddNonOverridableArguments (Aws::String &&key, const char *value)
 
JobUpdateAddNonOverridableArguments (const char *key, const char *value)
 
const ConnectionsListGetConnections () const
 
bool ConnectionsHasBeenSet () const
 
void SetConnections (const ConnectionsList &value)
 
void SetConnections (ConnectionsList &&value)
 
JobUpdateWithConnections (const ConnectionsList &value)
 
JobUpdateWithConnections (ConnectionsList &&value)
 
int GetMaxRetries () const
 
bool MaxRetriesHasBeenSet () const
 
void SetMaxRetries (int value)
 
JobUpdateWithMaxRetries (int value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
JobUpdateWithTimeout (int value)
 
double GetMaxCapacity () const
 
bool MaxCapacityHasBeenSet () const
 
void SetMaxCapacity (double value)
 
JobUpdateWithMaxCapacity (double value)
 
const WorkerTypeGetWorkerType () const
 
bool WorkerTypeHasBeenSet () const
 
void SetWorkerType (const WorkerType &value)
 
void SetWorkerType (WorkerType &&value)
 
JobUpdateWithWorkerType (const WorkerType &value)
 
JobUpdateWithWorkerType (WorkerType &&value)
 
int GetNumberOfWorkers () const
 
bool NumberOfWorkersHasBeenSet () const
 
void SetNumberOfWorkers (int value)
 
JobUpdateWithNumberOfWorkers (int value)
 
const Aws::StringGetSecurityConfiguration () const
 
bool SecurityConfigurationHasBeenSet () const
 
void SetSecurityConfiguration (const Aws::String &value)
 
void SetSecurityConfiguration (Aws::String &&value)
 
void SetSecurityConfiguration (const char *value)
 
JobUpdateWithSecurityConfiguration (const Aws::String &value)
 
JobUpdateWithSecurityConfiguration (Aws::String &&value)
 
JobUpdateWithSecurityConfiguration (const char *value)
 
const NotificationPropertyGetNotificationProperty () const
 
bool NotificationPropertyHasBeenSet () const
 
void SetNotificationProperty (const NotificationProperty &value)
 
void SetNotificationProperty (NotificationProperty &&value)
 
JobUpdateWithNotificationProperty (const NotificationProperty &value)
 
JobUpdateWithNotificationProperty (NotificationProperty &&value)
 
const Aws::StringGetGlueVersion () const
 
bool GlueVersionHasBeenSet () const
 
void SetGlueVersion (const Aws::String &value)
 
void SetGlueVersion (Aws::String &&value)
 
void SetGlueVersion (const char *value)
 
JobUpdateWithGlueVersion (const Aws::String &value)
 
JobUpdateWithGlueVersion (Aws::String &&value)
 
JobUpdateWithGlueVersion (const char *value)
 

Detailed Description

Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.

See Also:

AWS API Reference

Definition at line 39 of file JobUpdate.h.

Constructor & Destructor Documentation

◆ JobUpdate() [1/2]

Aws::Glue::Model::JobUpdate::JobUpdate ( )

◆ JobUpdate() [2/2]

Aws::Glue::Model::JobUpdate::JobUpdate ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDefaultArguments() [1/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 336 of file JobUpdate.h.

◆ AddDefaultArguments() [2/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 349 of file JobUpdate.h.

◆ AddDefaultArguments() [3/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 362 of file JobUpdate.h.

◆ AddDefaultArguments() [4/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 375 of file JobUpdate.h.

◆ AddDefaultArguments() [5/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 388 of file JobUpdate.h.

◆ AddDefaultArguments() [6/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 401 of file JobUpdate.h.

◆ AddDefaultArguments() [7/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddDefaultArguments ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 414 of file JobUpdate.h.

◆ AddNonOverridableArguments() [1/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 450 of file JobUpdate.h.

◆ AddNonOverridableArguments() [2/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 455 of file JobUpdate.h.

◆ AddNonOverridableArguments() [3/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 460 of file JobUpdate.h.

◆ AddNonOverridableArguments() [4/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 465 of file JobUpdate.h.

◆ AddNonOverridableArguments() [5/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 470 of file JobUpdate.h.

◆ AddNonOverridableArguments() [6/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 475 of file JobUpdate.h.

◆ AddNonOverridableArguments() [7/7]

JobUpdate& Aws::Glue::Model::JobUpdate::AddNonOverridableArguments ( const char *  key,
const char *  value 
)
inline

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

Definition at line 480 of file JobUpdate.h.

◆ CommandHasBeenSet()

bool Aws::Glue::Model::JobUpdate::CommandHasBeenSet ( ) const
inline

The JobCommand that executes this job (required).

Definition at line 224 of file JobUpdate.h.

◆ ConnectionsHasBeenSet()

bool Aws::Glue::Model::JobUpdate::ConnectionsHasBeenSet ( ) const
inline

The connections used for this job.

Definition at line 491 of file JobUpdate.h.

◆ DefaultArgumentsHasBeenSet()

bool Aws::Glue::Model::JobUpdate::DefaultArgumentsHasBeenSet ( ) const
inline

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.

Definition at line 271 of file JobUpdate.h.

◆ DescriptionHasBeenSet()

bool Aws::Glue::Model::JobUpdate::DescriptionHasBeenSet ( ) const
inline

Description of the job being defined.

Definition at line 56 of file JobUpdate.h.

◆ ExecutionPropertyHasBeenSet()

bool Aws::Glue::Model::JobUpdate::ExecutionPropertyHasBeenSet ( ) const
inline

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

Definition at line 189 of file JobUpdate.h.

◆ GetCommand()

const JobCommand& Aws::Glue::Model::JobUpdate::GetCommand ( ) const
inline

The JobCommand that executes this job (required).

Definition at line 219 of file JobUpdate.h.

◆ GetConnections()

const ConnectionsList& Aws::Glue::Model::JobUpdate::GetConnections ( ) const
inline

The connections used for this job.

Definition at line 486 of file JobUpdate.h.

◆ GetDefaultArguments()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::JobUpdate::GetDefaultArguments ( ) const
inline

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.

Definition at line 258 of file JobUpdate.h.

◆ GetDescription()

const Aws::String& Aws::Glue::Model::JobUpdate::GetDescription ( ) const
inline

Description of the job being defined.

Definition at line 51 of file JobUpdate.h.

◆ GetExecutionProperty()

const ExecutionProperty& Aws::Glue::Model::JobUpdate::GetExecutionProperty ( ) const
inline

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

Definition at line 183 of file JobUpdate.h.

◆ GetGlueVersion()

const Aws::String& Aws::Glue::Model::JobUpdate::GetGlueVersion ( ) const
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 837 of file JobUpdate.h.

◆ GetLogUri()

const Aws::String& Aws::Glue::Model::JobUpdate::GetLogUri ( ) const
inline

This field is reserved for future use.

Definition at line 92 of file JobUpdate.h.

◆ GetMaxCapacity()

double Aws::Glue::Model::JobUpdate::GetMaxCapacity ( ) const
inline

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

Definition at line 581 of file JobUpdate.h.

◆ GetMaxRetries()

int Aws::Glue::Model::JobUpdate::GetMaxRetries ( ) const
inline

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

Definition at line 517 of file JobUpdate.h.

◆ GetNonOverridableArguments()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::JobUpdate::GetNonOverridableArguments ( ) const
inline

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

Definition at line 420 of file JobUpdate.h.

◆ GetNotificationProperty()

const NotificationProperty& Aws::Glue::Model::JobUpdate::GetNotificationProperty ( ) const
inline

Specifies the configuration properties of a job notification.

Definition at line 801 of file JobUpdate.h.

◆ GetNumberOfWorkers()

int Aws::Glue::Model::JobUpdate::GetNumberOfWorkers ( ) const
inline

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.

Definition at line 725 of file JobUpdate.h.

◆ GetRole()

const Aws::String& Aws::Glue::Model::JobUpdate::GetRole ( ) const
inline

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

Definition at line 134 of file JobUpdate.h.

◆ GetSecurityConfiguration()

const Aws::String& Aws::Glue::Model::JobUpdate::GetSecurityConfiguration ( ) const
inline

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

Definition at line 753 of file JobUpdate.h.

◆ GetTimeout()

int Aws::Glue::Model::JobUpdate::GetTimeout ( ) const
inline

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

Definition at line 540 of file JobUpdate.h.

◆ GetWorkerType()

const WorkerType& Aws::Glue::Model::JobUpdate::GetWorkerType ( ) const
inline

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.

Definition at line 652 of file JobUpdate.h.

◆ GlueVersionHasBeenSet()

bool Aws::Glue::Model::JobUpdate::GlueVersionHasBeenSet ( ) const
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 847 of file JobUpdate.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glue::Model::JobUpdate::Jsonize ( ) const

◆ LogUriHasBeenSet()

bool Aws::Glue::Model::JobUpdate::LogUriHasBeenSet ( ) const
inline

This field is reserved for future use.

Definition at line 97 of file JobUpdate.h.

◆ MaxCapacityHasBeenSet()

bool Aws::Glue::Model::JobUpdate::MaxCapacityHasBeenSet ( ) const
inline

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

Definition at line 600 of file JobUpdate.h.

◆ MaxRetriesHasBeenSet()

bool Aws::Glue::Model::JobUpdate::MaxRetriesHasBeenSet ( ) const
inline

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

Definition at line 522 of file JobUpdate.h.

◆ NonOverridableArgumentsHasBeenSet()

bool Aws::Glue::Model::JobUpdate::NonOverridableArgumentsHasBeenSet ( ) const
inline

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

Definition at line 425 of file JobUpdate.h.

◆ NotificationPropertyHasBeenSet()

bool Aws::Glue::Model::JobUpdate::NotificationPropertyHasBeenSet ( ) const
inline

Specifies the configuration properties of a job notification.

Definition at line 806 of file JobUpdate.h.

◆ NumberOfWorkersHasBeenSet()

bool Aws::Glue::Model::JobUpdate::NumberOfWorkersHasBeenSet ( ) const
inline

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.

Definition at line 732 of file JobUpdate.h.

◆ operator=()

JobUpdate& Aws::Glue::Model::JobUpdate::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleHasBeenSet()

bool Aws::Glue::Model::JobUpdate::RoleHasBeenSet ( ) const
inline

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

Definition at line 140 of file JobUpdate.h.

◆ SecurityConfigurationHasBeenSet()

bool Aws::Glue::Model::JobUpdate::SecurityConfigurationHasBeenSet ( ) const
inline

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

Definition at line 759 of file JobUpdate.h.

◆ SetCommand() [1/2]

void Aws::Glue::Model::JobUpdate::SetCommand ( const JobCommand value)
inline

The JobCommand that executes this job (required).

Definition at line 229 of file JobUpdate.h.

◆ SetCommand() [2/2]

void Aws::Glue::Model::JobUpdate::SetCommand ( JobCommand &&  value)
inline

The JobCommand that executes this job (required).

Definition at line 234 of file JobUpdate.h.

◆ SetConnections() [1/2]

void Aws::Glue::Model::JobUpdate::SetConnections ( const ConnectionsList value)
inline

The connections used for this job.

Definition at line 496 of file JobUpdate.h.

◆ SetConnections() [2/2]

void Aws::Glue::Model::JobUpdate::SetConnections ( ConnectionsList &&  value)
inline

The connections used for this job.

Definition at line 501 of file JobUpdate.h.

◆ SetDefaultArguments() [1/2]

void Aws::Glue::Model::JobUpdate::SetDefaultArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 284 of file JobUpdate.h.

◆ SetDefaultArguments() [2/2]

void Aws::Glue::Model::JobUpdate::SetDefaultArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 297 of file JobUpdate.h.

◆ SetDescription() [1/3]

void Aws::Glue::Model::JobUpdate::SetDescription ( const Aws::String value)
inline

Description of the job being defined.

Definition at line 61 of file JobUpdate.h.

◆ SetDescription() [2/3]

void Aws::Glue::Model::JobUpdate::SetDescription ( Aws::String &&  value)
inline

Description of the job being defined.

Definition at line 66 of file JobUpdate.h.

◆ SetDescription() [3/3]

void Aws::Glue::Model::JobUpdate::SetDescription ( const char *  value)
inline

Description of the job being defined.

Definition at line 71 of file JobUpdate.h.

◆ SetExecutionProperty() [1/2]

void Aws::Glue::Model::JobUpdate::SetExecutionProperty ( const ExecutionProperty value)
inline

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

Definition at line 195 of file JobUpdate.h.

◆ SetExecutionProperty() [2/2]

void Aws::Glue::Model::JobUpdate::SetExecutionProperty ( ExecutionProperty &&  value)
inline

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

Definition at line 201 of file JobUpdate.h.

◆ SetGlueVersion() [1/3]

void Aws::Glue::Model::JobUpdate::SetGlueVersion ( const Aws::String value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 857 of file JobUpdate.h.

◆ SetGlueVersion() [2/3]

void Aws::Glue::Model::JobUpdate::SetGlueVersion ( Aws::String &&  value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 867 of file JobUpdate.h.

◆ SetGlueVersion() [3/3]

void Aws::Glue::Model::JobUpdate::SetGlueVersion ( const char *  value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 877 of file JobUpdate.h.

◆ SetLogUri() [1/3]

void Aws::Glue::Model::JobUpdate::SetLogUri ( const Aws::String value)
inline

This field is reserved for future use.

Definition at line 102 of file JobUpdate.h.

◆ SetLogUri() [2/3]

void Aws::Glue::Model::JobUpdate::SetLogUri ( Aws::String &&  value)
inline

This field is reserved for future use.

Definition at line 107 of file JobUpdate.h.

◆ SetLogUri() [3/3]

void Aws::Glue::Model::JobUpdate::SetLogUri ( const char *  value)
inline

This field is reserved for future use.

Definition at line 112 of file JobUpdate.h.

◆ SetMaxCapacity()

void Aws::Glue::Model::JobUpdate::SetMaxCapacity ( double  value)
inline

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

Definition at line 619 of file JobUpdate.h.

◆ SetMaxRetries()

void Aws::Glue::Model::JobUpdate::SetMaxRetries ( int  value)
inline

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

Definition at line 527 of file JobUpdate.h.

◆ SetNonOverridableArguments() [1/2]

void Aws::Glue::Model::JobUpdate::SetNonOverridableArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 430 of file JobUpdate.h.

◆ SetNonOverridableArguments() [2/2]

void Aws::Glue::Model::JobUpdate::SetNonOverridableArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 435 of file JobUpdate.h.

◆ SetNotificationProperty() [1/2]

void Aws::Glue::Model::JobUpdate::SetNotificationProperty ( const NotificationProperty value)
inline

Specifies the configuration properties of a job notification.

Definition at line 811 of file JobUpdate.h.

◆ SetNotificationProperty() [2/2]

void Aws::Glue::Model::JobUpdate::SetNotificationProperty ( NotificationProperty &&  value)
inline

Specifies the configuration properties of a job notification.

Definition at line 816 of file JobUpdate.h.

◆ SetNumberOfWorkers()

void Aws::Glue::Model::JobUpdate::SetNumberOfWorkers ( int  value)
inline

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.

Definition at line 739 of file JobUpdate.h.

◆ SetRole() [1/3]

void Aws::Glue::Model::JobUpdate::SetRole ( const Aws::String value)
inline

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

Definition at line 146 of file JobUpdate.h.

◆ SetRole() [2/3]

void Aws::Glue::Model::JobUpdate::SetRole ( Aws::String &&  value)
inline

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

Definition at line 152 of file JobUpdate.h.

◆ SetRole() [3/3]

void Aws::Glue::Model::JobUpdate::SetRole ( const char *  value)
inline

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

Definition at line 158 of file JobUpdate.h.

◆ SetSecurityConfiguration() [1/3]

void Aws::Glue::Model::JobUpdate::SetSecurityConfiguration ( const Aws::String value)
inline

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

Definition at line 765 of file JobUpdate.h.

◆ SetSecurityConfiguration() [2/3]

void Aws::Glue::Model::JobUpdate::SetSecurityConfiguration ( Aws::String &&  value)
inline

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

Definition at line 771 of file JobUpdate.h.

◆ SetSecurityConfiguration() [3/3]

void Aws::Glue::Model::JobUpdate::SetSecurityConfiguration ( const char *  value)
inline

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

Definition at line 777 of file JobUpdate.h.

◆ SetTimeout()

void Aws::Glue::Model::JobUpdate::SetTimeout ( int  value)
inline

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

Definition at line 554 of file JobUpdate.h.

◆ SetWorkerType() [1/2]

void Aws::Glue::Model::JobUpdate::SetWorkerType ( const WorkerType value)
inline

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.

Definition at line 678 of file JobUpdate.h.

◆ SetWorkerType() [2/2]

void Aws::Glue::Model::JobUpdate::SetWorkerType ( WorkerType &&  value)
inline

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.

Definition at line 691 of file JobUpdate.h.

◆ TimeoutHasBeenSet()

bool Aws::Glue::Model::JobUpdate::TimeoutHasBeenSet ( ) const
inline

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

Definition at line 547 of file JobUpdate.h.

◆ WithCommand() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithCommand ( const JobCommand value)
inline

The JobCommand that executes this job (required).

Definition at line 239 of file JobUpdate.h.

◆ WithCommand() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithCommand ( JobCommand &&  value)
inline

The JobCommand that executes this job (required).

Definition at line 244 of file JobUpdate.h.

◆ WithConnections() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithConnections ( const ConnectionsList value)
inline

The connections used for this job.

Definition at line 506 of file JobUpdate.h.

◆ WithConnections() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithConnections ( ConnectionsList &&  value)
inline

The connections used for this job.

Definition at line 511 of file JobUpdate.h.

◆ WithDefaultArguments() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithDefaultArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 310 of file JobUpdate.h.

◆ WithDefaultArguments() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithDefaultArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 323 of file JobUpdate.h.

◆ WithDescription() [1/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithDescription ( const Aws::String value)
inline

Description of the job being defined.

Definition at line 76 of file JobUpdate.h.

◆ WithDescription() [2/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithDescription ( Aws::String &&  value)
inline

Description of the job being defined.

Definition at line 81 of file JobUpdate.h.

◆ WithDescription() [3/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithDescription ( const char *  value)
inline

Description of the job being defined.

Definition at line 86 of file JobUpdate.h.

◆ WithExecutionProperty() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithExecutionProperty ( const ExecutionProperty value)
inline

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

Definition at line 207 of file JobUpdate.h.

◆ WithExecutionProperty() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithExecutionProperty ( ExecutionProperty &&  value)
inline

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

Definition at line 213 of file JobUpdate.h.

◆ WithGlueVersion() [1/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithGlueVersion ( const Aws::String value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 887 of file JobUpdate.h.

◆ WithGlueVersion() [2/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithGlueVersion ( Aws::String &&  value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 897 of file JobUpdate.h.

◆ WithGlueVersion() [3/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithGlueVersion ( const char *  value)
inline

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

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Definition at line 907 of file JobUpdate.h.

◆ WithLogUri() [1/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithLogUri ( const Aws::String value)
inline

This field is reserved for future use.

Definition at line 117 of file JobUpdate.h.

◆ WithLogUri() [2/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithLogUri ( Aws::String &&  value)
inline

This field is reserved for future use.

Definition at line 122 of file JobUpdate.h.

◆ WithLogUri() [3/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithLogUri ( const char *  value)
inline

This field is reserved for future use.

Definition at line 127 of file JobUpdate.h.

◆ WithMaxCapacity()

JobUpdate& Aws::Glue::Model::JobUpdate::WithMaxCapacity ( double  value)
inline

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

Definition at line 638 of file JobUpdate.h.

◆ WithMaxRetries()

JobUpdate& Aws::Glue::Model::JobUpdate::WithMaxRetries ( int  value)
inline

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

Definition at line 532 of file JobUpdate.h.

◆ WithNonOverridableArguments() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithNonOverridableArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 440 of file JobUpdate.h.

◆ WithNonOverridableArguments() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithNonOverridableArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 445 of file JobUpdate.h.

◆ WithNotificationProperty() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithNotificationProperty ( const NotificationProperty value)
inline

Specifies the configuration properties of a job notification.

Definition at line 821 of file JobUpdate.h.

◆ WithNotificationProperty() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithNotificationProperty ( NotificationProperty &&  value)
inline

Specifies the configuration properties of a job notification.

Definition at line 826 of file JobUpdate.h.

◆ WithNumberOfWorkers()

JobUpdate& Aws::Glue::Model::JobUpdate::WithNumberOfWorkers ( int  value)
inline

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.

Definition at line 746 of file JobUpdate.h.

◆ WithRole() [1/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithRole ( const Aws::String value)
inline

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

Definition at line 164 of file JobUpdate.h.

◆ WithRole() [2/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithRole ( Aws::String &&  value)
inline

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

Definition at line 170 of file JobUpdate.h.

◆ WithRole() [3/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithRole ( const char *  value)
inline

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

Definition at line 176 of file JobUpdate.h.

◆ WithSecurityConfiguration() [1/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithSecurityConfiguration ( const Aws::String value)
inline

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

Definition at line 783 of file JobUpdate.h.

◆ WithSecurityConfiguration() [2/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithSecurityConfiguration ( Aws::String &&  value)
inline

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

Definition at line 789 of file JobUpdate.h.

◆ WithSecurityConfiguration() [3/3]

JobUpdate& Aws::Glue::Model::JobUpdate::WithSecurityConfiguration ( const char *  value)
inline

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

Definition at line 795 of file JobUpdate.h.

◆ WithTimeout()

JobUpdate& Aws::Glue::Model::JobUpdate::WithTimeout ( int  value)
inline

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

Definition at line 561 of file JobUpdate.h.

◆ WithWorkerType() [1/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithWorkerType ( const WorkerType value)
inline

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.

Definition at line 704 of file JobUpdate.h.

◆ WithWorkerType() [2/2]

JobUpdate& Aws::Glue::Model::JobUpdate::WithWorkerType ( WorkerType &&  value)
inline

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.

Definition at line 717 of file JobUpdate.h.

◆ WorkerTypeHasBeenSet()

bool Aws::Glue::Model::JobUpdate::WorkerTypeHasBeenSet ( ) const
inline

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.

Definition at line 665 of file JobUpdate.h.


The documentation for this class was generated from the following file: