Cette page n'est pas encore disponible en français, sa traduction est en cours. Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.
Get the full description of your ECS tasks.
Inputs
Champ
Type
Description
region [required]
enum
default: us-east-1
cluster
string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
tasks [required]
[string]
A list of up to 100 task IDs or full ARN entries.
includeTags
boolean
Specifies whether you want to see the resource tags for the task.
default: true
Outputs
Expand All
Champ
Type
Description
tasks [required]
[object]
attachments
[object]
The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.
id
string
The unique identifier for the attachment.
type
string
The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.
status
string
The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.
details
[object]
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address. For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride. For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName, volumeId, and statusReason (only when the attachment fails to create or attach).
name
string
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
string
The value of the key-value pair. For environment variables, this is the value of the environment variable.
attributes
[object]
The attributes of the task
name [required]
string
The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).
value
string
The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can't start or end with a space.
targetType
string
The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
targetId
string
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
availabilityZone
string
The Availability Zone for the task.
capacityProviderName
string
The capacity provider that's associated with the task.
clusterArn
string
The ARN of the cluster that hosts the task.
connectivity
string
The connectivity status of a task.
connectivityAt
date-time
The Unix timestamp for the time when the task last went into CONNECTED status.
containerInstanceArn
string
The ARN of the container instances that host the task.
containers
[object]
The containers that's associated with the task.
containerArn
string
The Amazon Resource Name (ARN) of the container.
taskArn
string
The ARN of the task.
name
string
The name of the container.
image
string
The image used for the container.
imageDigest
string
The container image manifest digest.
runtimeId
string
The ID of the Docker container.
lastStatus
string
The last known status of the container.
exitCode
number
The exit code returned from the container.
reason
string
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
networkBindings
[object]
The network bindings associated with the container.
bindIP
string
The IP address that the container is bound to on the container instance.
containerPort
number
The port number on the container that's used with the network binding.
hostPort
number
The port number on the host that's used with the network binding.
protocol
string
The protocol used for the network binding.
containerPortRange
string
The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a containerPortRange: You must use either the bridge network mode or the awsvpc network mode. This parameter is available for both the EC2 and Fargate launch types. This parameter is available for both the Linux and Windows operating systems. The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package You can specify a maximum of 100 port ranges per container. You do not specify a hostPortRange. The value of the hostPortRange is set as follows: For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy. For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. The containerPortRange valid values are between 1 and 65535. A port can only be included in one port mapping per container. You cannot specify overlapping port ranges. The first port in the range must be less than last port in the range. Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.
hostPortRange
string
The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.
networkInterfaces
[object]
The network interfaces associated with the container.
attachmentId
string
The attachment ID for the network interface.
privateIpv4Address
string
The private IPv4 address for the network interface.
ipv6Address
string
The private IPv6 address for the network interface.
healthStatus
string
The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.
managedAgents
[object]
The details of any Amazon ECS managed agents associated with the container.
lastStartedAt
date-time
The Unix timestamp for the time when the managed agent was last started.
name
string
The name of the managed agent. When the execute command feature is turned on, the managed agent name is ExecuteCommandAgent.
reason
string
The reason for why the managed agent is in the state it is in.
lastStatus
string
The last known status of the managed agent.
cpu
string
The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.
memory
string
The hard limit (in MiB) of memory set for the container.
memoryReservation
string
The soft limit (in MiB) of memory set for the container.
gpuIds
[string]
The IDs of each GPU assigned to the container.
cpu
string
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 use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter: The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform 1.4.0 or later. 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments This option requires Linux platform 1.4.0 or later.
createdAt
date-time
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.
desiredStatus
string
The desired status of the task. For more information, see Task Lifecycle.
enableExecuteCommand
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.
executionStoppedAt
date-time
The Unix timestamp for the time when the task execution stopped.
group
string
The name of the task group that's associated with the task.
healthStatus
string
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. 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.
inferenceAccelerators
[object]
The Elastic Inference accelerator that's associated with the task.
deviceName [required]
string
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
deviceType [required]
string
The Elastic Inference accelerator type to use.
lastStatus
string
The last known status for the task. For more information, see Task Lifecycle.
launchType
string
The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
memory
string
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
object
One or more container overrides.
containerOverrides
[object]
One or more container overrides that are sent to a task.
name
string
The name of the container that receives the override. This parameter is required if any override is specified.
command
[string]
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
environment
[object]
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. You must also specify a container name.
name
string
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value
string
The value of the key-value pair. For environment variables, this is the value of the environment variable.
environmentFiles
[object]
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
value [required]
string
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type [required]
string
The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.
cpu
number
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
memory
number
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
memoryReservation
number
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
resourceRequirements
[object]
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
value [required]
string
The value for the specified resource type. If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
type [required]
string
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.
cpu
string
The CPU override for the task.
inferenceAcceleratorOverrides
[object]
The Elastic Inference accelerator override for the task.
deviceName
string
The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
deviceType
string
The Elastic Inference accelerator type to use.
executionRoleArn
string
The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
memory
string
The memory override for the task.
taskRoleArn
string
The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
ephemeralStorage
object
The ephemeral storage setting override for the task. This parameter is only supported for tasks hosted on Fargate that use the following platform versions: Linux platform version 1.4.0 or later. Windows platform version 1.0.0 or later.
sizeInGiB [required]
number
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 20 GiB and the maximum supported value is 200 GiB.
platformVersion
string
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.
platformFamily
string
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.).
pullStartedAt
date-time
The Unix timestamp for the time when the container image pull began.
pullStoppedAt
date-time
The Unix timestamp for the time when the container image pull completed.
startedAt
date-time
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.
startedBy
string
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.
stopCode
string
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.
stoppedAt
date-time
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.
stoppedReason
string
The reason that the task was stopped.
stoppingAt
date-time
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
[object]
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.
key
string
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value
string
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
taskArn
string
The Amazon Resource Name (ARN) of the task.
taskDefinitionArn
string
The ARN of the task definition that creates the task.
version
number
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.
ephemeralStorage
object
The ephemeral storage settings for the task.
sizeInGiB [required]
number
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 20 GiB and the maximum supported value is 200 GiB.
failures [required]
[object]
arn
string
The Amazon Resource Name (ARN) of the failed resource.
