startJobRun method

Future<StartJobRunResponse> startJobRun({ required String jobName, int? allocatedCapacity, Map<String, String>? arguments, String? jobRunId, double? maxCapacity, NotificationProperty? notificationProperty, int? numberOfWorkers, String? securityConfiguration, int? timeout, WorkerType? workerType, })

Starts a job run using a job definition.

May throw InvalidInputException. May throw EntityNotFoundException. May throw InternalServiceException. May throw OperationTimeoutException. May throw ResourceNumberLimitExceededException. May throw ConcurrentRunsExceededException.

Parameter jobName : The name of the job definition to use.

Parameter allocatedCapacity : This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Parameter arguments : 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.

Parameter jobRunId : The ID of a previous JobRun to retry.

Parameter maxCapacity : 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.

Parameter notificationProperty : Specifies configuration properties of a job run notification.

Parameter numberOfWorkers : 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.

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

Parameter timeout : 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.

Parameter workerType : 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.

Implementation

Future<StartJobRunResponse> startJobRun({
  required String jobName,
  int? allocatedCapacity,
  Map<String, String>? arguments,
  String? jobRunId,
  double? maxCapacity,
  NotificationProperty? notificationProperty,
  int? numberOfWorkers,
  String? securityConfiguration,
  int? timeout,
  WorkerType? workerType,
}) async {
  ArgumentError.checkNotNull(jobName, 'jobName');
  _s.validateStringLength(
    'jobName',
    jobName,
    1,
    255,
    isRequired: true,
  );
  _s.validateStringLength(
    'jobRunId',
    jobRunId,
    1,
    255,
  );
  _s.validateStringLength(
    'securityConfiguration',
    securityConfiguration,
    1,
    255,
  );
  _s.validateNumRange(
    'timeout',
    timeout,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSGlue.StartJobRun'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'JobName': jobName,
      if (allocatedCapacity != null) 'AllocatedCapacity': allocatedCapacity,
      if (arguments != null) 'Arguments': arguments,
      if (jobRunId != null) 'JobRunId': jobRunId,
      if (maxCapacity != null) 'MaxCapacity': maxCapacity,
      if (notificationProperty != null)
        'NotificationProperty': notificationProperty,
      if (numberOfWorkers != null) 'NumberOfWorkers': numberOfWorkers,
      if (securityConfiguration != null)
        'SecurityConfiguration': securityConfiguration,
      if (timeout != null) 'Timeout': timeout,
      if (workerType != null) 'WorkerType': workerType.toValue(),
    },
  );

  return StartJobRunResponse.fromJson(jsonResponse.body);
}