Package software.amazon.awscdk.services.stepfunctions.tasks

Class BatchSubmitJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJob

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-13T09:19:47.207Z")
@Stability(Stable)
public class BatchSubmitJob
extends TaskStateBase

Task to submits an AWS Batch job from a job definition.

Example:

 import software.amazon.awscdk.services.batch.*;
 EcsJobDefinition batchJobDefinition;
 JobQueue batchQueue;
 BatchSubmitJob task = BatchSubmitJob.Builder.create(this, "Submit Job")
         .jobDefinitionArn(batchJobDefinition.getJobDefinitionArn())
         .jobName("MyJob")
         .jobQueueArn(batchQueue.getJobQueueArn())
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-batch.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BatchSubmitJob.Builder	A fluent builder for BatchSubmitJob.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BatchSubmitJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BatchSubmitJob(software.amazon.jsii.JsiiObjectRef objRef)
	BatchSubmitJob(software.constructs.Construct scope, String id, BatchSubmitJobProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static BatchSubmitJob	jsonata(software.constructs.Construct scope, String id, BatchSubmitJobJsonataProps props)	Task to submits an AWS Batch job from a job definition using JSONata.
static BatchSubmitJob	jsonPath(software.constructs.Construct scope, String id, BatchSubmitJobJsonPathProps props)	Task to submits an AWS Batch job from a job definition using JSONPath.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BatchSubmitJob

protected BatchSubmitJob(software.amazon.jsii.JsiiObjectRef objRef)

BatchSubmitJob

protected BatchSubmitJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BatchSubmitJob

@Stability(Stable)
public BatchSubmitJob(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BatchSubmitJobProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static BatchSubmitJob jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BatchSubmitJobJsonataProps props)

Task to submits an AWS Batch job from a job definition using JSONata.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-batch.html

jsonPath

@Stability(Stable)
@NotNull
public static BatchSubmitJob jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BatchSubmitJobJsonPathProps props)

Task to submits an AWS Batch job from a job definition using JSONPath.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-batch.html

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase