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

#include <StartJobRunRequest.h>

+ Inheritance diagram for Aws::Glue::Model::StartJobRunRequest:

Public Member Functions

 StartJobRunRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
StartJobRunRequestWithJobName (const Aws::String &value)
 
StartJobRunRequestWithJobName (Aws::String &&value)
 
StartJobRunRequestWithJobName (const char *value)
 
const Aws::StringGetJobRunId () const
 
bool JobRunIdHasBeenSet () const
 
void SetJobRunId (const Aws::String &value)
 
void SetJobRunId (Aws::String &&value)
 
void SetJobRunId (const char *value)
 
StartJobRunRequestWithJobRunId (const Aws::String &value)
 
StartJobRunRequestWithJobRunId (Aws::String &&value)
 
StartJobRunRequestWithJobRunId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetArguments () const
 
bool ArgumentsHasBeenSet () const
 
void SetArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
StartJobRunRequestWithArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
StartJobRunRequestWithArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
StartJobRunRequestAddArguments (const Aws::String &key, const Aws::String &value)
 
StartJobRunRequestAddArguments (Aws::String &&key, const Aws::String &value)
 
StartJobRunRequestAddArguments (const Aws::String &key, Aws::String &&value)
 
StartJobRunRequestAddArguments (Aws::String &&key, Aws::String &&value)
 
StartJobRunRequestAddArguments (const char *key, Aws::String &&value)
 
StartJobRunRequestAddArguments (Aws::String &&key, const char *value)
 
StartJobRunRequestAddArguments (const char *key, const char *value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
StartJobRunRequestWithTimeout (int value)
 
double GetMaxCapacity () const
 
bool MaxCapacityHasBeenSet () const
 
void SetMaxCapacity (double value)
 
StartJobRunRequestWithMaxCapacity (double value)
 
const Aws::StringGetSecurityConfiguration () const
 
bool SecurityConfigurationHasBeenSet () const
 
void SetSecurityConfiguration (const Aws::String &value)
 
void SetSecurityConfiguration (Aws::String &&value)
 
void SetSecurityConfiguration (const char *value)
 
StartJobRunRequestWithSecurityConfiguration (const Aws::String &value)
 
StartJobRunRequestWithSecurityConfiguration (Aws::String &&value)
 
StartJobRunRequestWithSecurityConfiguration (const char *value)
 
const NotificationPropertyGetNotificationProperty () const
 
bool NotificationPropertyHasBeenSet () const
 
void SetNotificationProperty (const NotificationProperty &value)
 
void SetNotificationProperty (NotificationProperty &&value)
 
StartJobRunRequestWithNotificationProperty (const NotificationProperty &value)
 
StartJobRunRequestWithNotificationProperty (NotificationProperty &&value)
 
const WorkerTypeGetWorkerType () const
 
bool WorkerTypeHasBeenSet () const
 
void SetWorkerType (const WorkerType &value)
 
void SetWorkerType (WorkerType &&value)
 
StartJobRunRequestWithWorkerType (const WorkerType &value)
 
StartJobRunRequestWithWorkerType (WorkerType &&value)
 
int GetNumberOfWorkers () const
 
bool NumberOfWorkersHasBeenSet () const
 
void SetNumberOfWorkers (int value)
 
StartJobRunRequestWithNumberOfWorkers (int value)
 
- Public Member Functions inherited from Aws::Glue::GlueRequest
virtual ~GlueRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file StartJobRunRequest.h.

Constructor & Destructor Documentation

◆ StartJobRunRequest()

Aws::Glue::Model::StartJobRunRequest::StartJobRunRequest ( )

Member Function Documentation

◆ AddArguments() [1/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( const Aws::String key,
const Aws::String value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 218 of file StartJobRunRequest.h.

◆ AddArguments() [2/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( Aws::String &&  key,
const Aws::String value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 232 of file StartJobRunRequest.h.

◆ AddArguments() [3/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( const Aws::String key,
Aws::String &&  value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 246 of file StartJobRunRequest.h.

◆ AddArguments() [4/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 260 of file StartJobRunRequest.h.

◆ AddArguments() [5/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( const char *  key,
Aws::String &&  value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 274 of file StartJobRunRequest.h.

◆ AddArguments() [6/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( Aws::String &&  key,
const char *  value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 288 of file StartJobRunRequest.h.

◆ AddArguments() [7/7]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::AddArguments ( const char *  key,
const char *  value 
)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 302 of file StartJobRunRequest.h.

◆ ArgumentsHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::ArgumentsHasBeenSet ( ) const
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 148 of file StartJobRunRequest.h.

◆ GetArguments()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::StartJobRunRequest::GetArguments ( ) const
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 134 of file StartJobRunRequest.h.

◆ GetJobName()

const Aws::String& Aws::Glue::Model::StartJobRunRequest::GetJobName ( ) const
inline

The name of the job definition to use.

Definition at line 43 of file StartJobRunRequest.h.

◆ GetJobRunId()

const Aws::String& Aws::Glue::Model::StartJobRunRequest::GetJobRunId ( ) const
inline

The ID of a previous JobRun to retry.

Definition at line 84 of file StartJobRunRequest.h.

◆ GetMaxCapacity()

double Aws::Glue::Model::StartJobRunRequest::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"), 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 355 of file StartJobRunRequest.h.

◆ GetNotificationProperty()

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

Specifies configuration properties of a job run notification.

Definition at line 467 of file StartJobRunRequest.h.

◆ GetNumberOfWorkers()

int Aws::Glue::Model::StartJobRunRequest::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 573 of file StartJobRunRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Glue::Model::StartJobRunRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Glue::GlueRequest.

◆ GetSecurityConfiguration()

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

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

Definition at line 419 of file StartJobRunRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Glue::Model::StartJobRunRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartJobRunRequest.h.

◆ GetTimeout()

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

The JobRun 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). This overrides the timeout value set in the parent job.

Definition at line 311 of file StartJobRunRequest.h.

◆ GetWorkerType()

const WorkerType& Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 505 of file StartJobRunRequest.h.

◆ JobNameHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::JobNameHasBeenSet ( ) const
inline

The name of the job definition to use.

Definition at line 48 of file StartJobRunRequest.h.

◆ JobRunIdHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::JobRunIdHasBeenSet ( ) const
inline

The ID of a previous JobRun to retry.

Definition at line 89 of file StartJobRunRequest.h.

◆ MaxCapacityHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::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"), 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 374 of file StartJobRunRequest.h.

◆ NotificationPropertyHasBeenSet()

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

Specifies configuration properties of a job run notification.

Definition at line 472 of file StartJobRunRequest.h.

◆ NumberOfWorkersHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::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 580 of file StartJobRunRequest.h.

◆ SecurityConfigurationHasBeenSet()

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

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

Definition at line 425 of file StartJobRunRequest.h.

◆ SerializePayload()

Aws::String Aws::Glue::Model::StartJobRunRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArguments() [1/2]

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

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 162 of file StartJobRunRequest.h.

◆ SetArguments() [2/2]

void Aws::Glue::Model::StartJobRunRequest::SetArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 176 of file StartJobRunRequest.h.

◆ SetJobName() [1/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobName ( const Aws::String value)
inline

The name of the job definition to use.

Definition at line 53 of file StartJobRunRequest.h.

◆ SetJobName() [2/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobName ( Aws::String &&  value)
inline

The name of the job definition to use.

Definition at line 58 of file StartJobRunRequest.h.

◆ SetJobName() [3/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobName ( const char *  value)
inline

The name of the job definition to use.

Definition at line 63 of file StartJobRunRequest.h.

◆ SetJobRunId() [1/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobRunId ( const Aws::String value)
inline

The ID of a previous JobRun to retry.

Definition at line 94 of file StartJobRunRequest.h.

◆ SetJobRunId() [2/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobRunId ( Aws::String &&  value)
inline

The ID of a previous JobRun to retry.

Definition at line 99 of file StartJobRunRequest.h.

◆ SetJobRunId() [3/3]

void Aws::Glue::Model::StartJobRunRequest::SetJobRunId ( const char *  value)
inline

The ID of a previous JobRun to retry.

Definition at line 104 of file StartJobRunRequest.h.

◆ SetMaxCapacity()

void Aws::Glue::Model::StartJobRunRequest::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"), 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 393 of file StartJobRunRequest.h.

◆ SetNotificationProperty() [1/2]

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

Specifies configuration properties of a job run notification.

Definition at line 477 of file StartJobRunRequest.h.

◆ SetNotificationProperty() [2/2]

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

Specifies configuration properties of a job run notification.

Definition at line 482 of file StartJobRunRequest.h.

◆ SetNumberOfWorkers()

void Aws::Glue::Model::StartJobRunRequest::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 587 of file StartJobRunRequest.h.

◆ SetSecurityConfiguration() [1/3]

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

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

Definition at line 431 of file StartJobRunRequest.h.

◆ SetSecurityConfiguration() [2/3]

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

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

Definition at line 437 of file StartJobRunRequest.h.

◆ SetSecurityConfiguration() [3/3]

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

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

Definition at line 443 of file StartJobRunRequest.h.

◆ SetTimeout()

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

The JobRun 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). This overrides the timeout value set in the parent job.

Definition at line 327 of file StartJobRunRequest.h.

◆ SetWorkerType() [1/2]

void Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 529 of file StartJobRunRequest.h.

◆ SetWorkerType() [2/2]

void Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 541 of file StartJobRunRequest.h.

◆ TimeoutHasBeenSet()

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

The JobRun 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). This overrides the timeout value set in the parent job.

Definition at line 319 of file StartJobRunRequest.h.

◆ WithArguments() [1/2]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 190 of file StartJobRunRequest.h.

◆ WithArguments() [2/2]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

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 204 of file StartJobRunRequest.h.

◆ WithJobName() [1/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobName ( const Aws::String value)
inline

The name of the job definition to use.

Definition at line 68 of file StartJobRunRequest.h.

◆ WithJobName() [2/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobName ( Aws::String &&  value)
inline

The name of the job definition to use.

Definition at line 73 of file StartJobRunRequest.h.

◆ WithJobName() [3/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobName ( const char *  value)
inline

The name of the job definition to use.

Definition at line 78 of file StartJobRunRequest.h.

◆ WithJobRunId() [1/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobRunId ( const Aws::String value)
inline

The ID of a previous JobRun to retry.

Definition at line 109 of file StartJobRunRequest.h.

◆ WithJobRunId() [2/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobRunId ( Aws::String &&  value)
inline

The ID of a previous JobRun to retry.

Definition at line 114 of file StartJobRunRequest.h.

◆ WithJobRunId() [3/3]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::WithJobRunId ( const char *  value)
inline

The ID of a previous JobRun to retry.

Definition at line 119 of file StartJobRunRequest.h.

◆ WithMaxCapacity()

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::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"), 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 412 of file StartJobRunRequest.h.

◆ WithNotificationProperty() [1/2]

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

Specifies configuration properties of a job run notification.

Definition at line 487 of file StartJobRunRequest.h.

◆ WithNotificationProperty() [2/2]

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

Specifies configuration properties of a job run notification.

Definition at line 492 of file StartJobRunRequest.h.

◆ WithNumberOfWorkers()

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::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 594 of file StartJobRunRequest.h.

◆ WithSecurityConfiguration() [1/3]

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

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

Definition at line 449 of file StartJobRunRequest.h.

◆ WithSecurityConfiguration() [2/3]

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

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

Definition at line 455 of file StartJobRunRequest.h.

◆ WithSecurityConfiguration() [3/3]

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

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

Definition at line 461 of file StartJobRunRequest.h.

◆ WithTimeout()

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

The JobRun 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). This overrides the timeout value set in the parent job.

Definition at line 335 of file StartJobRunRequest.h.

◆ WithWorkerType() [1/2]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 553 of file StartJobRunRequest.h.

◆ WithWorkerType() [2/2]

StartJobRunRequest& Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 565 of file StartJobRunRequest.h.

◆ WorkerTypeHasBeenSet()

bool Aws::Glue::Model::StartJobRunRequest::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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Definition at line 517 of file StartJobRunRequest.h.


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