Skip to content

ECS  >  Structures  >  Task

Task

Structure Class

Task dataclass

Bases: _SerdeShape

Details on a task in a cluster.

Attributes

attachments class-attribute instance-attribute
attachments: list[Attachment] | None = ...

The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

attributes class-attribute instance-attribute
attributes: list[Attribute] | None = ...

The attributes of the task

availability_zone class-attribute instance-attribute
availability_zone: str | None = ...

The Availability Zone for the task.

capacity_provider_name class-attribute instance-attribute
capacity_provider_name: str | None = ...

The capacity provider that's associated with the task.

cluster_arn class-attribute instance-attribute
cluster_arn: str | None = ...

The ARN of the cluster that hosts the task.

connectivity class-attribute instance-attribute
connectivity: str | None = ...

The connectivity status of a task.

connectivity_at class-attribute instance-attribute
connectivity_at: datetime | None = ...

The Unix timestamp for the time when the task last went into CONNECTED status.

container_instance_arn class-attribute instance-attribute
container_instance_arn: str | None = ...

The ARN of the container instances that host the task.

containers class-attribute instance-attribute
containers: list[Container] | None = ...

The containers that's associated with the task.

cpu class-attribute instance-attribute
cpu: str | None = ...

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs). If you do not specify a value, the parameter is ignored.

This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.

desired_status class-attribute instance-attribute
desired_status: str | None = ...

The desired status of the task. For more information, see Task Lifecycle.

enable_execute_command class-attribute instance-attribute
enable_execute_command: bool = ...

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 class-attribute instance-attribute
ephemeral_storage: EphemeralStorage | None = ...

The ephemeral storage settings for the task.

execution_stopped_at class-attribute instance-attribute
execution_stopped_at: datetime | None = ...

The Unix timestamp for the time when the task execution stopped.

fargate_ephemeral_storage class-attribute instance-attribute
fargate_ephemeral_storage: TaskEphemeralStorage | None = ...

The Fargate ephemeral storage settings for the task.

group class-attribute instance-attribute
group: str | None = ...

The name of the task group that's associated with the task.

health_status class-attribute instance-attribute
health_status: str | None = ...

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

Note

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

inference_accelerators class-attribute instance-attribute
inference_accelerators: list[InferenceAccelerator] | None = ...

The Elastic Inference accelerator that's associated with the task.

last_status class-attribute instance-attribute
last_status: str | None = ...

The last known status for the task. For more information, see Task Lifecycle.

launch_type class-attribute instance-attribute
launch_type: str | None = ...

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

memory class-attribute instance-attribute
memory: str | None = ...

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

  • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

This option requires Linux platform 1.4.0 or later.

  • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

This option requires Linux platform 1.4.0 or later.

overrides class-attribute instance-attribute
overrides: TaskOverride | None = ...

One or more container overrides.

platform_family class-attribute instance-attribute
platform_family: str | None = ...

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

platform_version class-attribute instance-attribute
platform_version: str | None = ...

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

pull_started_at class-attribute instance-attribute
pull_started_at: datetime | None = ...

The Unix timestamp for the time when the container image pull began.

pull_stopped_at class-attribute instance-attribute
pull_stopped_at: datetime | None = ...

The Unix timestamp for the time when the container image pull completed.

started_at class-attribute instance-attribute
started_at: datetime | None = ...

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.

started_by class-attribute instance-attribute
started_by: str | None = ...

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

stop_code class-attribute instance-attribute
stop_code: str | None = ...

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

stopped_at class-attribute instance-attribute
stopped_at: datetime | None = ...

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.

stopped_reason class-attribute instance-attribute
stopped_reason: str | None = ...

The reason that the task was stopped.

stopping_at class-attribute instance-attribute
stopping_at: datetime | None = ...

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPING.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

task_arn class-attribute instance-attribute
task_arn: str | None = ...

The Amazon Resource Name (ARN) of the task.

task_definition_arn class-attribute instance-attribute
task_definition_arn: str | None = ...

The ARN of the task definition that creates the task.

trusted_execution_summary class-attribute instance-attribute
trusted_execution_summary: TrustedExecutionSummary | None = ...

A summary of the trusted execution configuration for the task, including the isolation mode. This is a read-only view of the configuration that was set on the task definition.

Note

Trusted execution is supported only for Amazon ECS Managed Instances.

version class-attribute instance-attribute
version: int = ...

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.