BatchSubmitJobProps

class aws_cdk.aws_stepfunctions_tasks.BatchSubmitJobProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, job_definition, job_name, job_queue, array_size=None, attempts=None, container_overrides=None, depends_on=None, payload=None)

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

__init__(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, job_definition, job_name, job_queue, array_size=None, attempts=None, container_overrides=None, depends_on=None, payload=None)

Properties for RunBatchJob.

Parameters
  • comment (Optional[str]) – An optional description for this state. Default: - No comment

  • heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None

  • input_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

  • 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 ‘$’)

  • timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

  • job_definition (IJobDefinition) – 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 (IJobQueue) – 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 size

  • attempts (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: 1

  • container_overrides (Optional[BatchContainerOverrides]) – 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

  • depends_on (Optional[List[BatchJobDependency]]) – A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependencies

  • payload (Optional[TaskInput]) – The payload to be passed as parameters to the batch job. Default: - No parameters are passed

stability :stability: experimental

Return type

None

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 :default: - No array size

stability :stability: experimental

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 :default: 1

stability :stability: experimental

Return type

Union[int, float, None]

comment

An optional description for this state.

default :default: - No comment

stability :stability: experimental

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 :default: - No container overrides

see :see: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides stability :stability: experimental

Return type

Optional[BatchContainerOverrides]

depends_on

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

default :default: - No dependencies

see :see: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn stability :stability: experimental

Return type

Optional[List[BatchJobDependency]]

heartbeat

Timeout for the heartbeat.

default :default: - None

stability :stability: experimental

Return type

Optional[Duration]

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 :default: - The entire task input (JSON path ‘$’)

stability :stability: experimental

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 :default: IntegrationPattern.REQUEST_RESPONSE

see :see: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token stability :stability: experimental

Return type

Optional[IntegrationPattern]

job_definition

The job definition used by this job.

stability :stability: experimental

Return type

IJobDefinition

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.

stability :stability: experimental

Return type

str

job_queue

The job queue into which the job is submitted.

stability :stability: experimental

Return type

IJobQueue

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 :default:

  • The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)

stability :stability: experimental

Return type

Optional[str]

payload

The payload to be passed as parameters to the batch job.

default :default: - No parameters are passed

stability :stability: experimental

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 :default: - Replaces the entire input with the result (JSON path ‘$’)

stability :stability: experimental

Return type

Optional[str]

timeout

Timeout for the state machine.

default :default: - None

stability :stability: experimental

Return type

Optional[Duration]