BatchSubmitJobProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
BatchSubmitJobProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, job_definition_arn, job_name, job_queue_arn, array_size=None, attempts=None, container_overrides=None, depends_on=None, payload=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for RunBatchJob.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: -IntegrationPattern.REQUEST_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.output_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)result_selector (
Optional
[Mapping
[str
,Any
]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - Nonetimeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonejob_definition_arn (
str
) – The arn of the job definition used by this job.job_name (
str
) – The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.job_queue_arn (
str
) – The arn of the job queue into which the job is submitted.array_size (
Union
[int
,float
,None
]) – The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide. Default: - No array sizeattempts (
Union
[int
,float
,None
]) – The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. Default: 1container_overrides (
Union
[BatchContainerOverrides
,Dict
[str
,Any
],None
]) – A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. Default: - No container overridesdepends_on (
Optional
[Sequence
[Union
[BatchJobDependency
,Dict
[str
,Any
]]]]) – A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependenciespayload (
Optional
[TaskInput
]) – The payload to be passed as parameters to the batch job. Default: - No parameters are passed
- ExampleMetadata
infused
Example:
import aws_cdk.aws_batch as batch # batch_job_definition: batch.JobDefinition # batch_queue: batch.JobQueue task = tasks.BatchSubmitJob(self, "Submit Job", job_definition_arn=batch_job_definition.job_definition_arn, job_name="MyJob", job_queue_arn=batch_queue.job_queue_arn )
Attributes
-
array_size
¶ The array size can be between 2 and 10,000.
If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
- Default
No array size
- Return type
Union
[int
,float
,None
]
-
attempts
¶ The number of times to move a job to the RUNNABLE status.
You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
- Default
1
- Return type
Union
[int
,float
,None
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
container_overrides
¶ A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
- Default
No container overrides
- See
- Return type
Optional
[BatchContainerOverrides
]
-
depends_on
¶ A list of dependencies for the job.
A job can depend upon a maximum of 20 jobs.
- Default
No dependencies
- See
- Return type
Optional
[List
[BatchJobDependency
]]
-
input_path
¶ JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
-
job_definition_arn
¶ The arn of the job definition used by this job.
- Return type
str
-
job_name
¶ The name of the job.
The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
- Return type
str
-
job_queue_arn
¶ The arn of the job queue into which the job is submitted.
- Return type
str
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
payload
¶ The payload to be passed as parameters to the batch job.
- Default
No parameters are passed
- Return type
Optional
[TaskInput
]
-
result_path
¶ JSONPath expression to indicate where to inject the state’s output.
May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
result_selector
¶ The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.
- Default
None
- See
- Return type
Optional
[Mapping
[str
,Any
]]