parallel.cluster.generic.awsbatch.submitBatchJob

Submit job to AWS Batch

Syntax

schedulerID = parallel.cluster.generic.awsbatch.submitBatchJob(arraySize,jobName,jobQueue,jobDefinition,command,environmentVariableNames,environmentVariableValues)

Description

schedulerID = parallel.cluster.generic.awsbatch.submitBatchJob(arraySize,jobName,jobQueue,jobDefinition,command,environmentVariableNames,environmentVariableValues) submits a job of size arraySize to the AWS Batch job queue jobQueue. The job has the name jobName, job definition jobDefinition. The container that runs the AWS Batch job receives and processes the command command. The job runs with the environment variables environmentVariableNames and values environmentVariableValues. This function returns an AWS Batch job ID.

For information about AWS Batch job queues, job definitions, and the command passed to the container that runs the AWS Batch job, see the AWS Batch documentation.

Note

This function requires the Parallel Computing Toolbox™ plugin for MATLAB^® Parallel Server™ with AWS^® Batch. For an example of how to use the function, see the plugin scripts.

Input Arguments

arraySize — Size of job

positive integer

Size of the job, specified as a positive integer. If arraySize is greater than 1, then submitBatchJob submits an array job. Otherwise, submitBatchJob submits a nonarray job.

jobName — Job name

character vector | string scalar

Job name for the AWS Batch job, specified as a character vector or string scalar. For more information, see the AWS Batch documentation.

Data Types: char | string

jobQueue — AWS Batch job queue

character vector | string scalar

AWS Batch job queue to submit the AWS Batch job to, specified as a character vector or string scalar. For more information, see the AWS Batch documentation.

Data Types: char | string

jobDefinition — AWS Batch job definition

character vector | string scalar

AWS Batch job definition for the AWS Batch job, specified as a character vector or string scalar. For more information, see the AWS Batch documentation.

Data Types: char | string

command — Command to pass

character vector | string scalar

Command to pass to the container that runs the AWS Batch job, specified as a character vector or string scalar. For more information, see the AWS Batch documentation.

Data Types: char | string

environmentVariableNames — Names of environment variables

cell array of character vectors | string array

Names of the environment variables to create on the AWS Batch job, specified as a cell array of character vectors or string array. Each variable must have a corresponding value in environmentVariableValues.

Data Types: cell | string

environmentVariableValues — Values of environment variables

cell array of character vectors | string array

Values of the environment variables to create on the AWS Batch job, specified as a cell array of character vectors or string array. Each value must have a corresponding variable in environmentVariableValues.

Data Types: cell | string

Output Arguments

schedulerID — Scheduler ID

string scalar

Scheduler ID of the AWS Batch job, returned as a string scalar.

Data Types: char

Version History

Introduced in R2019b