RemoteBatchSubmit
✖
RemoteBatchSubmit
submits expr for evaluation using the remote batch submission environment env.
submits expr for evaluation using $DefaultRemoteBatchSubmissionEnvironment.
Details and Options


- RemoteBatchSubmit is used to submit batch jobs for asynchronous evaluation on batch computation providers.
- The currently supported batch computation providers are "AWSBatch", "AzureBatch" and "CharityEngine".
- RemoteBatchSubmit returns a RemoteBatchJobObject representing the resulting batch job on the batch computation provider.
- The environment env should be a RemoteBatchSubmissionEnvironment expression.
- 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["CharityEngine",expr], which is equivalent to RemoteBatchSubmit[RemoteBatchSubmissionEnvironment["CharityEngine"],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 session IncludeDefinitions True whether to automatically include dependencies of the expression LicensingSettings Automatic licensing settings to use RemoteInputFiles < > association of local files to be uploaded to the provider RemoteProviderSettings < > association of provider-specific settings for the job TimeConstraint Automatic a timeout for the job to be supplied to the 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.
- 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.
- Supported RemoteProviderSettings keys 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.
Examples
open allclose allBasic Examples (2)Summary of the most common use cases
Submit a batch job to a batch computation provider:

https://wolfram.com/xid/0cf2zeyvogftzna-pd47rn

Retrieve the result of the job:

https://wolfram.com/xid/0cf2zeyvogftzna-dr01nn

Submit a batch job including a local input file, uploaded under the name "MyFile.jpg":

https://wolfram.com/xid/0cf2zeyvogftzna-nn3gj4


https://wolfram.com/xid/0cf2zeyvogftzna-flc9v1

Scope (1)Survey of the scope of standard use cases
Options (6)Common values & functionality for each option
ForwardCloudCredentials (1)
Submit a job using the "AWSBatch" provider, for which the default setting of the ForwardCloudCredentials option is True:

https://wolfram.com/xid/0cf2zeyvogftzna-jnou3f


https://wolfram.com/xid/0cf2zeyvogftzna-dbk4he

Override the default and disable credential forwarding:

https://wolfram.com/xid/0cf2zeyvogftzna-bqutt2


https://wolfram.com/xid/0cf2zeyvogftzna-en4fz8

IncludeDefinitions (1)
By default, definitions of symbols lexically relevant for the evaluation of the job expression are copied into the remote session:

https://wolfram.com/xid/0cf2zeyvogftzna-ratt


https://wolfram.com/xid/0cf2zeyvogftzna-ddo1w3

Disable the automatic inclusion of definitions:

https://wolfram.com/xid/0cf2zeyvogftzna-dbxfj5


https://wolfram.com/xid/0cf2zeyvogftzna-bavbkf

LicensingSettings (1)
RemoteInputFiles (1)
Submit a batch job using a local file and a byte array as input files:

https://wolfram.com/xid/0cf2zeyvogftzna-e3izi1


https://wolfram.com/xid/0cf2zeyvogftzna-fdeymb


https://wolfram.com/xid/0cf2zeyvogftzna-duw2u9

The two input files were automatically downloaded into the remote session's working directory (along with the system-generated file containing the job code):

https://wolfram.com/xid/0cf2zeyvogftzna-kawg82

RemoteProviderSettings (1)
Submit a job with settings for the "AWSBatch" provider specifying how many vCPUs (processor cores) to allocate to the job container:

https://wolfram.com/xid/0cf2zeyvogftzna-n1omla


https://wolfram.com/xid/0cf2zeyvogftzna-cyblsp

TimeConstraint (1)

https://wolfram.com/xid/0cf2zeyvogftzna-b1jl20


https://wolfram.com/xid/0cf2zeyvogftzna-fq9gzi

The "AWSBatch" provider supplies an additional "JobStatusReason" job property indicating the reason for the job's failure:

https://wolfram.com/xid/0cf2zeyvogftzna-pjcqmg

Possible Issues (1)Common pitfalls and unexpected behavior
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:

https://wolfram.com/xid/0cf2zeyvogftzna-g4lqg0


Reduce the number of processor cores and/or the TimeConstraint:

https://wolfram.com/xid/0cf2zeyvogftzna-4bgv4

Alternatively, you may override the balance check by supplying the "CheckCreditsBalance"False entitlement setting to the LicensingSettings option:

https://wolfram.com/xid/0cf2zeyvogftzna-jyvi6w

Wolfram Research (2020), RemoteBatchSubmit, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html.
Text
Wolfram Research (2020), RemoteBatchSubmit, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html.
Wolfram Research (2020), RemoteBatchSubmit, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html.
CMS
Wolfram Language. 2020. "RemoteBatchSubmit." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html.
Wolfram Language. 2020. "RemoteBatchSubmit." Wolfram Language & System Documentation Center. Wolfram Research. 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
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="2020", howpublished="\url{https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html}", note=[Accessed: 29-March-2025
]}
BibLaTeX
@online{reference.wolfram_2025_remotebatchsubmit, organization={Wolfram Research}, title={RemoteBatchSubmit}, year={2020}, url={https://reference.wolfram.com/language/ref/RemoteBatchSubmit.html}, note=[Accessed: 29-March-2025
]}