Skip to content

BatchContainerOverrides

Source code in docs_src/capo_pipes/types/batch_container_overrides.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class BatchContainerOverrides(TypedDict, closed=True):
    command: NotRequired["capo_pipes.types.string_list.StringList"]
    """<p>The command to send to the container that overrides the default command from the Docker image or the task definition.</p>"""
    environment: NotRequired[
        "capo_pipes.types.batch_environment_variable_list.BatchEnvironmentVariableList"
    ]
    """<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.</p> <note> <p>Environment variables cannot start with "<code>Batch</code>". This naming convention is reserved for variables that Batch sets.</p> </note>"""
    instance_type: NotRequired["str"]
    """<p>The instance type to use for a multi-node parallel job.</p> <note> <p>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.</p> </note>"""
    resource_requirements: NotRequired[
        "capo_pipes.types.batch_resource_requirements_list.BatchResourceRequirementsList"
    ]
    """<p>The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>"""

command instance-attribute 

command: NotRequired[StringList]

The command to send to the container that overrides the default command from the Docker image or the task definition.

environment instance-attribute 

environment: NotRequired[BatchEnvironmentVariableList]

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

instance_type instance-attribute 

instance_type: NotRequired[str]

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

resource_requirements instance-attribute 

resource_requirements: NotRequired[BatchResourceRequirementsList]

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.