Skip to content

PipeTargetBatchJobParameters

Source code in docs_src/capo_pipes/types/pipe_target_batch_job_parameters.py
class PipeTargetBatchJobParameters(TypedDict, closed=True):
    job_definition: "str"
    """<p>The job definition used by this job. This value can be one of <code>name</code>, <code>name:revision</code>, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.</p>"""
    job_name: "str"
    """<p>The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>"""
    array_properties: NotRequired[
        "capo_pipes.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_pipes.types.batch_retry_strategy.BatchRetryStrategy"
    ]
    """<p>The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.</p>"""
    container_overrides: NotRequired[
        "capo_pipes.types.batch_container_overrides.BatchContainerOverrides"
    ]
    """<p>The overrides that are sent to a container.</p>"""
    depends_on: NotRequired["capo_pipes.types.batch_depends_on.BatchDependsOn"]
    """<p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.</p>"""
    parameters: NotRequired["capo_pipes.types.batch_parameters_map.BatchParametersMap"]
    """<p>Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from 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.

container_overrides instance-attribute

container_overrides: NotRequired[BatchContainerOverrides]

The overrides that are sent to a container.

depends_on instance-attribute

depends_on: NotRequired[BatchDependsOn]

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

job_definition instance-attribute

job_definition: str

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

job_name instance-attribute

job_name: str

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

parameters instance-attribute

parameters: NotRequired[BatchParametersMap]

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

retry_strategy instance-attribute

retry_strategy: NotRequired[BatchRetryStrategy]

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.