Skip to content

TaskContainerOverrides

Source code in docs_src/capo_batch/types/task_container_overrides.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class TaskContainerOverrides(TypedDict, closed=True):
    command: NotRequired["capo_batch.types.string_list.StringList"]
    """<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p> <note> <p>This parameter can't contain an empty string.</p> </note>"""
    environment: NotRequired[
        "capo_batch.types.environment_variables.EnvironmentVariables"
    ]
    """<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 job definition.</p> <note> <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is reserved for variables that Batch sets.</p> </note>"""
    name: NotRequired["capo_batch.types.string.String"]
    """<p>A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used.</p>"""
    resource_requirements: NotRequired[
        "capo_batch.types.resource_requirements.ResourceRequirements"
    ]
    """<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 job definition.

This parameter can't contain an empty string.

environment instance-attribute 

environment: NotRequired[EnvironmentVariables]

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 job definition.

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

name instance-attribute 

name: NotRequired[String]

A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used.

resource_requirements instance-attribute 

resource_requirements: NotRequired[ResourceRequirements]

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.