Skip to content

BatchParameters

Source code in docs_src/capo_eventbridge/types/batch_parameters.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class BatchParameters(TypedDict, closed=True):
    job_definition: "capo_eventbridge.types.string.String"
    """<p>The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.</p>"""
    job_name: "capo_eventbridge.types.string.String"
    """<p>The name to use for this execution of the job, if the target is an Batch job.</p>"""
    array_properties: NotRequired[
        "capo_eventbridge.types.batch_array_properties.BatchArrayProperties"
    ]
    """<p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.</p>"""
    retry_strategy: NotRequired[
        "capo_eventbridge.types.batch_retry_strategy.BatchRetryStrategy"
    ]
    """<p>The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.</p>"""

array_properties instance-attribute 

array_properties: NotRequired[BatchArrayProperties]

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

job_definition instance-attribute 

job_definition: String

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

job_name instance-attribute 

job_name: String

The name to use for this execution of the job, if the target is an Batch job.

retry_strategy instance-attribute 

retry_strategy: NotRequired[BatchRetryStrategy]

The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.