WOLFRAM

Wolfram Language & System Documentation Center

RemoteBatchSubmissionEnvironment["provider",assoc]

represents a remote batch job submission environment for provider with properties assoc.

RemoteBatchSubmissionEnvironment["provider"]

represents a submission environment for provider with default optional properties.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Scope  
Properties & Relations  
Possible Issues  
See Also
Related Guides
Related Workflows
History
Cite this Page

RemoteBatchSubmissionEnvironment   

Listing of Batch Computation Providers »

RemoteBatchSubmissionEnvironment["provider",assoc]

represents a remote batch job submission environment for provider with properties assoc.

RemoteBatchSubmissionEnvironment["provider"]

represents a submission environment for provider with default optional properties.

Details

  • The value of provider should be the name of a supported remote submission provider.
  • The currently supported batch computation providers are "WolframBatch", "AWSBatch", "AzureBatch" and "CharityEngine".
  • The assoc argument may be omitted if the remote submission provider provider has no required properties.
  • The required and optional environment properties for each provider are listed on the provider's reference page.
  • If a provider has a "ServiceObject" property, the setting "ServiceObject" "New" can be used to force a new service connection to be created, disregarding any saved connections or credentials.
  • RemoteBatchSubmissionEnvironment[…][prop] returns a property of the environment.
  • The available properties of a environment can be queried with RemoteBatchSubmissionEnvironment[…]["Properties"].
  • The name of the provider associated with an environment can be queried with RemoteBatchSubmissionEnvironment[…]["Provider"].
  • Information of a RemoteBatchSubmissionEnvironment expression contains all properties of the environment.

Examples

open all close all

Basic Examples  (2)

The "WolframBatch" provider is a zero-configuration provider included in the Wolfram Language:

Wolfram Language code: env = RemoteBatchSubmissionEnvironment["WolframBatch"]

Use the "WolframBatch" provider to run a computation job of any size:

Wolfram Language code: RemoteBatchSubmit[env, 1988 ^ 1988]

Create an environment object for the "AWSBatch" provider, specifying an AWS Batch job definition, job queue and S3 bucket name for storing input and output:

Wolfram Language code: env = RemoteBatchSubmissionEnvironment["AWSBatch", <| "JobQueue" -> "arn:aws:batch:us-east-1:123456789012:job-queue/MyQueue", "JobDefinition" -> "arn:aws:batch:us-east-1:123456789012:job-definition/MyDefinition:1", "IOBucket" -> "my-job-bucket" |>]

Submit a batch job to the environment:

Wolfram Language code: RemoteBatchSubmit[env, 1988 ^ 1988]

Scope  (2)

Create an environment object for the "CharityEngine" provider, which has no required properties:

Wolfram Language code: RemoteBatchSubmissionEnvironment["CharityEngine"]

Create an "AWSBatch" environment object with an explicitly specified "AWS" service object:

Wolfram Language code: RemoteBatchSubmissionEnvironment["AWSBatch", <| "JobQueue" -> "arn:aws:batch:us-east-1:123456789012:job-queue/MyQueue", "JobDefinition" -> "arn:aws:batch:us-east-1:123456789012:job-definition/MyDefinition:1", "IOBucket" -> "my-job-bucket", "ServiceObject" -> ServiceObject["AWS", "ID" -> "connection-8c1df2b7464766822da497a031877afd"] |>]

Properties & Relations  (1)

Access an environment's properties using Information:

Wolfram Language code: Information[RemoteBatchSubmissionEnvironment["AWSBatch", Association["JobQueue" -> "arn:aws:batch:us-east-1:123456789012:job-queue/MyQueue", "JobDefinition" -> "arn:aws:batch:us-east-1:123456789012:job-definition/MyDefinition:1", "IOBucket" -> "my-job-bucket", "ServiceObject" -> ServiceObject["AWS", "ID" -> "connection-91dbdee73a734091c7cbf218e20f0d4f"]], "Valid" -> True]]
Wolfram Language code: %["JobQueue"]

Possible Issues  (1)

RemoteBatchSubmissionEnvironment will indicate if environment properties are missing or invalid:

Wolfram Language code: RemoteBatchSubmissionEnvironment["AWSBatch", <||>]
Wolfram Language code: RemoteBatchSubmissionEnvironment["AWSBatch", <| "JobQueue" -> "arn:aws:batch:us-east-1:123456789012:job-queue/MyQueue", "JobDefinition" -> 123, "IOBucket" -> "my-job-bucket" |>]
Wolfram Research (2020), RemoteBatchSubmissionEnvironment, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html.

Text

Wolfram Research (2020), RemoteBatchSubmissionEnvironment, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html.

CMS

Wolfram Language. 2020. "RemoteBatchSubmissionEnvironment." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html.

APA

Wolfram Language. (2020). RemoteBatchSubmissionEnvironment. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html

BibTeX

@misc{reference.wolfram_2026_remotebatchsubmissionenvironment, author="Wolfram Research", title="{RemoteBatchSubmissionEnvironment}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html}", note=[Accessed: 12-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_remotebatchsubmissionenvironment, organization={Wolfram Research}, title={RemoteBatchSubmissionEnvironment}, year={2020}, url={https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html}, note=[Accessed: 12-June-2026]}