Skip to content

EcsTaskDetails

Source code in docs_src/capo_batch/types/ecs_task_details.py
class EcsTaskDetails(TypedDict, closed=True):
    containers: NotRequired[
        "capo_batch.types.list_task_container_details.ListTaskContainerDetails"
    ]
    """<p>A list of containers that are included in the <code>taskProperties</code> list.</p>"""
    container_instance_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the container instance that hosts the task.</p>"""
    task_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The ARN of the Amazon ECS task.</p>"""
    ephemeral_storage: NotRequired[
        "capo_batch.types.ephemeral_storage.EphemeralStorage"
    ]
    """<p>The amount of ephemeral storage allocated for the task.</p>"""
    execution_role_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a> in the <i>Batch User Guide</i>.</p>"""
    platform_version: NotRequired["capo_batch.types.string.String"]
    """<p>The Fargate platform version where the jobs are running.</p>"""
    ipc_mode: NotRequired["capo_batch.types.string.String"]
    """<p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. For more information see <code>ipcMode</code> in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_EcsTaskProperties.html">EcsTaskProperties</a>.</p>"""
    task_role_arn: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>This is object is comparable to <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html">ContainerProperties:jobRoleArn</a>.</p> </note>"""
    pid_mode: NotRequired["capo_batch.types.string.String"]
    """<p>The process namespace to use for the containers in the task. The valid values are <code>host</code>, or <code>task</code>. For more information see <code>pidMode</code> in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_EcsTaskProperties.html">EcsTaskProperties</a>.</p>"""
    network_configuration: NotRequired[
        "capo_batch.types.network_configuration.NetworkConfiguration"
    ]
    """<p>The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.</p>"""
    runtime_platform: NotRequired["capo_batch.types.runtime_platform.RuntimePlatform"]
    """<p>An object that represents the compute environment architecture for Batch jobs on Fargate or Amazon ECS Managed Instances. Contains the operating system family and CPU architecture of the task.</p>"""
    volumes: NotRequired["capo_batch.types.volumes.Volumes"]
    """<p>A list of data volumes used in a job.</p>"""
    enable_execute_command: NotRequired["capo_batch.types.boolean.Boolean"]
    """<p>Determines whether execute command functionality is turned on for this task. If <code>true</code>, execute command functionality is turned on all the containers in the task.</p>"""
    network_mode: NotRequired["capo_batch.types.string.String"]
    """<p>The network mode configured for the task. This field is populated for jobs running on Amazon ECS Managed Instances (<code>MANAGED_INSTANCES</code> platform capability) and always returns <code>host</code>.</p>"""

container_instance_arn instance-attribute

container_instance_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the container instance that hosts the task.

containers instance-attribute

containers: NotRequired[ListTaskContainerDetails]

A list of containers that are included in the taskProperties list.

enable_execute_command instance-attribute

enable_execute_command: NotRequired[Boolean]

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

ephemeral_storage instance-attribute

ephemeral_storage: NotRequired[EphemeralStorage]

The amount of ephemeral storage allocated for the task.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

ipc_mode instance-attribute

ipc_mode: NotRequired[String]

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. For more information see ipcMode in EcsTaskProperties.

network_configuration instance-attribute

network_configuration: NotRequired[NetworkConfiguration]

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

network_mode instance-attribute

network_mode: NotRequired[String]

The network mode configured for the task. This field is populated for jobs running on Amazon ECS Managed Instances (MANAGED_INSTANCES platform capability) and always returns host.

pid_mode instance-attribute

pid_mode: NotRequired[String]

The process namespace to use for the containers in the task. The valid values are host, or task. For more information see pidMode in EcsTaskProperties.

platform_version instance-attribute

platform_version: NotRequired[String]

The Fargate platform version where the jobs are running.

runtime_platform instance-attribute

runtime_platform: NotRequired[RuntimePlatform]

An object that represents the compute environment architecture for Batch jobs on Fargate or Amazon ECS Managed Instances. Contains the operating system family and CPU architecture of the task.

task_arn instance-attribute

task_arn: NotRequired[String]

The ARN of the Amazon ECS task.

task_role_arn instance-attribute

task_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

This is object is comparable to ContainerProperties:jobRoleArn.

volumes instance-attribute

volumes: NotRequired[Volumes]

A list of data volumes used in a job.