-
See Also
- RemoteBatchSubmissionEnvironment
- RemoteBatchJobObject
- RemoteBatchMapSubmit
- RemoteBatchJobs
- $DefaultRemoteBatchSubmissionEnvironment
- RemoteBatchJobAbort
- CreditConstraint
- ForwardCloudCredentials
- IncludeDefinitions
- LicensingSettings
- RemoteInputFiles
- RemoteJobName
- RemoteJobNotifications
- RemoteProviderSettings
- TimeConstraint
-
- Remote Batch Computation Providers
- WolframBatch
- AWSBatch
- AzureBatch
- CharityEngine
- Related Guides
- Workflows
-
-
See Also
- RemoteBatchSubmissionEnvironment
- RemoteBatchJobObject
- RemoteBatchMapSubmit
- RemoteBatchJobs
- $DefaultRemoteBatchSubmissionEnvironment
- RemoteBatchJobAbort
- CreditConstraint
- ForwardCloudCredentials
- IncludeDefinitions
- LicensingSettings
- RemoteInputFiles
- RemoteJobName
- RemoteJobNotifications
- RemoteProviderSettings
- TimeConstraint
-
- Remote Batch Computation Providers
- WolframBatch
- AWSBatch
- AzureBatch
- CharityEngine
- Related Guides
- Workflows
-
See Also
RemoteBatchSubmit [expr]
submits expr for evaluation using $DefaultRemoteBatchSubmissionEnvironment .
RemoteBatchSubmit [env,expr]
submits expr for evaluation using the remote batch submission environment env.
RemoteBatchSubmit
Listing of Batch Computation Providers »RemoteBatchSubmit [expr]
submits expr for evaluation using $DefaultRemoteBatchSubmissionEnvironment .
RemoteBatchSubmit [env,expr]
submits expr for evaluation using the remote batch submission environment env.
Details and Options
- RemoteBatchSubmit is used to submit batch jobs for asynchronous evaluation on batch computation providers.
- The currently supported batch computation providers are "WolframBatch" , "AWSBatch" , "AzureBatch" and "CharityEngine" .
- RemoteBatchSubmit [expr] submits a job using $DefaultRemoteBatchSubmissionEnvironment , which defaults to the "WolframBatch" provider environment.
- RemoteBatchSubmit returns a RemoteBatchJobObject representing the resulting batch job on the batch computation provider.
- The environment env can be a RemoteBatchSubmissionEnvironment expression or "WolframBatch" .
- If the batch computation provider being used has no required environment settings, then env may also be the name of the provider as a string, such as in RemoteBatchSubmit ["WolframBatch" ,expr], which is equivalent to RemoteBatchSubmit [RemoteBatchSubmissionEnvironment ["WolframBatch" ],expr].
- The RemoteBatchJobObject returned by RemoteBatchSubmit will have "Single" as the value of its "JobType" property.
- The following options are supported by RemoteBatchSubmit :
-
ForwardCloudCredentials Automatic whether to copy the local session's Wolfram Cloud credentials into the remote sessionRemoteMachineClass "Basic1x8" a machine class to use with the "WolframBatch" provider
- The default value Automatic of the ForwardCloudCredentials option corresponds to True if the provider being used supports forwarding of cloud credentials, or False if the provider does not.
- For providers other than the "WolframBatch" provider, the default value Automatic of the LicensingSettings option creates a new on-demand license entitlement with kernel count and expiration limits based on the job's configuration.
- When running jobs using the default on-demand licensing configuration, Wolfram Engine license usage is charged against your Wolfram Service Credits balance on a pay-as-you-go basis. On-demand licensing is not used by the "WolframBatch" provider.
- Supported RemoteProviderSettings keys are listed on each remote submission provider's documentation page.
- When using the "WolframBatch" provider, RemoteMachineClass class is equivalent to setting RemoteProviderSettings <|"RemoteMachineClass" class|>. Possible values of class are listed on the "WolframBatch" documentation page.
- Supported RemoteJobNotifications events and actions are listed on each remote submission provider's documentation page.
- The value of the TimeConstraint option can be an integer number of seconds or a "TimeUnit" quantity. The default value Automatic indicates to use the default timeout defined by the provider.
- The value of the CreditConstraint option can be an integer number of Wolfram Service Credits or a "Credits" quantity. In the case of the "WolframBatch" provider, the default value Automatic indicates to use unlimited credits.
Examples
open all close allBasic Examples (3)
Submit a batch job to the default "WolframBatch" provider:
Check the job's status:
Eventually the status will indicate that the job has finished running:
Retrieve the result of the job and display the first result:
Submit a batch job including a local input file, uploaded under the name "photo.jpg":
Submit a batch job to the "AWSBatch" batch computation provider:
Retrieve the result of the job:
Scope (1)
Submit a batch job using the default remote submission environment:
Options (6)
ForwardCloudCredentials (1)
Submit a job using the "AWSBatch" provider, for which the default setting of the ForwardCloudCredentials option is True :
Override the default and disable credential forwarding:
IncludeDefinitions (1)
By default, definitions of symbols lexically relevant for the evaluation of the job expression are copied into the remote session:
Disable the automatic inclusion of definitions:
LicensingSettings (1)
Activate the kernel in a remote batch job using an automatically created on-demand license entitlement with custom settings:
RemoteInputFiles (1)
Submit a batch job using a local file and a byte array as input files:
The two input files were automatically downloaded into the remote session's working directory (along with the system-generated file containing the job code):
RemoteProviderSettings (1)
Submit a job with settings for the "AWSBatch" provider specifying how many vCPUs (processor cores) to allocate to the job container:
TimeConstraint (1)
Submit a job with a timeout:
The "AWSBatch" provider supplies an additional "JobStatusReason" job property indicating the reason for the job's failure:
Possible Issues (2)
Using the default on-demand licensing settings, RemoteBatchSubmit will refuse to submit a job if your Service Credits balance is insufficient to create a license entitlement based on the job processor count and TimeConstraint :
Reduce the number of processor cores and/or the TimeConstraint :
Alternatively, you may override the balance check by supplying the "CheckCreditsBalance"False entitlement setting to the LicensingSettings option:
RemoteBatchSubmit includes all definitions for all symbols in the code you submit. In some cases this can lead to large job uploads, even when it is not desired:
You can add the IncludeDefinitions option if you do not want any local symbol definitions to be included:
See Also
RemoteBatchSubmissionEnvironment RemoteBatchJobObject RemoteBatchMapSubmit RemoteBatchJobs $DefaultRemoteBatchSubmissionEnvironment RemoteBatchJobAbort CreditConstraint ForwardCloudCredentials IncludeDefinitions LicensingSettings RemoteInputFiles RemoteJobName RemoteJobNotifications RemoteProviderSettings TimeConstraint
Remote Batch Computation Providers: WolframBatch AWSBatch AzureBatch CharityEngine
Related Guides
Related Workflows
Text
Wolfram Research (2020), RemoteBatchSubmit, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html (updated 2025).
CMS
Wolfram Language. 2020. "RemoteBatchSubmit." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2025. https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html.
APA
Wolfram Language. (2020). RemoteBatchSubmit. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html
BibTeX
@misc{reference.wolfram_2025_remotebatchsubmit, author="Wolfram Research", title="{RemoteBatchSubmit}", year="2025", howpublished="\url{https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html}", note=[Accessed: 11-January-2026]}
BibLaTeX
@online{reference.wolfram_2025_remotebatchsubmit, organization={Wolfram Research}, title={RemoteBatchSubmit}, year={2025}, url={https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html}, note=[Accessed: 11-January-2026]}