WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

RemoteBatchSubmissionEnvironment

[Experimental]

✖

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

✖

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 "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 allclose all

Basic Examples  (1)Summary of the most common use cases

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:

In[1]:=1
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-h8de9s
Out[1]=1

Submit a batch job to the environment:

In[2]:=2
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-245j1
Out[2]=2

Scope  (2)Survey of the scope of standard use cases

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

In[1]:=1
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-gpzerj
Out[1]=1

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

In[1]:=1
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-g57drg
Out[1]=1

Properties & Relations  (1)Properties of the function, and connections to other functions

Access an environment's properties using Information:

In[1]:=1
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-e7rlh6
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-c1qp6s
Out[2]=2

Possible Issues  (1)Common pitfalls and unexpected behavior

RemoteBatchSubmissionEnvironment will indicate if environment properties are missing or invalid:

In[1]:=1
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-cmnzl
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0tg1at1qnwhzldjin3u6-kgnu3p
Out[2]=2
Wolfram Research (2020), RemoteBatchSubmissionEnvironment, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html.
✖
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.

✖
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.

✖
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

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

BibTeX

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

✖
@misc{reference.wolfram_2025_remotebatchsubmissionenvironment, author="Wolfram Research", title="{RemoteBatchSubmissionEnvironment}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html}", note=[Accessed: 09-July-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_remotebatchsubmissionenvironment, organization={Wolfram Research}, title={RemoteBatchSubmissionEnvironment}, year={2020}, url={https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html}, note=[Accessed: 09-July-2025 ]}

✖
@online{reference.wolfram_2025_remotebatchsubmissionenvironment, organization={Wolfram Research}, title={RemoteBatchSubmissionEnvironment}, year={2020}, url={https://reference.wolfram.com/language/ref/RemoteBatchSubmissionEnvironment.html}, note=[Accessed: 09-July-2025 ]}