Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide .
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
run-task
[--capacity-provider-strategy <value>]
[--cluster <value>]
[--count <value>]
[--enable-ecs-managed-tags | --no-enable-ecs-managed-tags]
[--group <value>]
[--launch-type <value>]
[--network-configuration <value>]
[--overrides <value>]
[--placement-constraints <value>]
[--placement-strategy <value>]
[--platform-version <value>]
[--propagate-tags <value>]
[--reference-id <value>]
[--started-by <value>]
[--tags <value>]
--task-definition <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--capacity-provider-strategy
(list)
The capacity provider strategy to use for the task.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
(structure)
The details of a capacity provider strategy.
capacityProvider -> (string)
The short name of the capacity provider.
weight -> (integer)
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .base -> (integer)
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
Shorthand Syntax:
capacityProvider=string,weight=integer,base=integer ...
JSON Syntax:
[
{
"capacityProvider": "string",
"weight": integer,
"base": integer
}
...
]
--cluster
(string)
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
--count
(integer)
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
--enable-ecs-managed-tags
| --no-enable-ecs-managed-tags
(boolean)
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide .
--group
(string)
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
--launch-type
(string)
The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
If a
launchType
is specified, thecapacityProviderStrategy
parameter must be omitted.Possible values:
EC2
FARGATE
--network-configuration
(structure)
The network configuration for the task. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .awsvpcConfiguration -> (structure)
The VPC subnets and security groups associated with a task.
Note
All specified subnets and security groups must be from the same VPC.
subnets -> (list)
The IDs of the subnets associated with the task or service. There is a limit of 16 subnets that can be specified per
AwsVpcConfiguration
.Note
All specified subnets must be from the same VPC.
(string)
securityGroups -> (list)
The IDs of the security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per
AwsVpcConfiguration
.Note
All specified security groups must be from the same VPC.
(string)
assignPublicIp -> (string)
Whether the task’s elastic network interface receives a public IP address. The default value is
DISABLED
.
Shorthand Syntax:
awsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}
JSON Syntax:
{
"awsvpcConfiguration": {
"subnets": ["string", ...],
"securityGroups": ["string", ...],
"assignPublicIp": "ENABLED"|"DISABLED"
}
}
--overrides
(structure)
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a
command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with anenvironment
override.Note
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
containerOverrides -> (list)
One or more container overrides sent to a task.
(structure)
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be
{"containerOverrides": [ ] }
. If a non-empty container override is specified, thename
parameter must be included.name -> (string)
The name of the container that receives the override. This parameter is required if any override is specified.
command -> (list)
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.
(string)
environment -> (list)
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.
(structure)
A key-value pair object.
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 -> (list)
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
(structure)
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file should contain an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file .If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide .This field is not valid for containers in tasks using the Fargate launch type.
value -> (string)
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type -> (string)
The file type to use. The only supported value is
s3
.cpu -> (integer)
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 -> (integer)
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 -> (integer)
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 -> (list)
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.
(structure)
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value -> (string)
The value for the specified resource type.
If the
GPU
type is used, the value is the number of physicalGPUs
the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.If the
InferenceAccelerator
type is used, thevalue
should match thedeviceName
for an InferenceAccelerator specified in a task definition.type -> (string)
The type of resource to assign to a container. The supported values are
GPU
orInferenceAccelerator
.cpu -> (string)
The cpu override for the task.
inferenceAcceleratorOverrides -> (list)
The Elastic Inference accelerator override for the task.
(structure)
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
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 IAM role override for the task.
memory -> (string)
The memory override for the task.
taskRoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
JSON Syntax:
{
"containerOverrides": [
{
"name": "string",
"command": ["string", ...],
"environment": [
{
"name": "string",
"value": "string"
}
...
],
"environmentFiles": [
{
"value": "string",
"type": "s3"
}
...
],
"cpu": integer,
"memory": integer,
"memoryReservation": integer,
"resourceRequirements": [
{
"value": "string",
"type": "GPU"|"InferenceAccelerator"
}
...
]
}
...
],
"cpu": "string",
"inferenceAcceleratorOverrides": [
{
"deviceName": "string",
"deviceType": "string"
}
...
],
"executionRoleArn": "string",
"memory": "string",
"taskRoleArn": "string"
}
--placement-constraints
(list)
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
(structure)
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide .
Note
If you are using the Fargate launch type, task placement constraints are not supported.
type -> (string)
The type of constraint. Use
distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates.expression -> (string)
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
Shorthand Syntax:
type=string,expression=string ...
JSON Syntax:
[
{
"type": "distinctInstance"|"memberOf",
"expression": "string"
}
...
]
--placement-strategy
(list)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
(structure)
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
type -> (string)
The type of placement strategy. The
random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that is specified with thefield
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).field -> (string)
The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that is applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used.
Shorthand Syntax:
type=string,field=string ...
JSON Syntax:
[
{
"type": "random"|"spread"|"binpack",
"field": "string"
}
...
]
--platform-version
(string)
The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .
--propagate-tags
(string)
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
Note
An error will be received if you specify the
SERVICE
option when running a task.Possible values:
TASK_DEFINITION
SERVICE
--reference-id
(string)
The reference ID to use for the task.
--started-by
(string)
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the
startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with thestartedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.If a task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it.
--tags
(list)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.(structure)
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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).
Shorthand Syntax:
key=string,value=string ...
JSON Syntax:
[
{
"key": "string",
"value": "string"
}
...
]
--task-definition
(string)
The
family
andrevision
(family:revision
) or full ARN of the task definition to run. If arevision
is not specified, the latestACTIVE
revision is used.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To run a task on your default cluster
The following run-task
example runs a task on the default cluster.
aws ecs run-task --cluster default --task-definition sleep360:1
Output:
{
"tasks": [
{
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE",
"overrides": {
"containerOverrides": [
{
"name": "sleep"
}
]
},
"lastStatus": "PENDING",
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-ccdef-22222EXAMPLE",
"desiredStatus": "RUNNING",
"taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1",
"containers": [
{
"containerArn": "arn:aws:ecs:us-west-2:123456789012:container/a1b2c3d4-5678-90ab-ccdef-33333EXAMPLE",
"taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE",
"lastStatus": "PENDING",
"name": "sleep"
}
]
}
]
}
For more information, see Running Tasks in the Amazon ECS Developer Guide.
tasks -> (list)
A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
(structure)
Details on a task in a cluster.
attachments -> (list)
The Elastic Network Adapter associated with the task if the task uses the
awsvpc
network mode.(structure)
An object representing a container instance or task attachment.
id -> (string)
The unique identifier for the attachment.
type -> (string)
The type of the attachment, such as
ElasticNetworkInterface
.status -> (string)
The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
, andDELETED
.details -> (list)
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.
(structure)
A key-value pair object.
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 -> (list)
The attributes of the task
(structure)
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide .
name -> (string)
The name of the attribute. The
name
must contain between 1 and 128 characters and 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 and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces. The value cannot contain any leading or trailing whitespace.targetType -> (string)
The type of the target with which to attach the attribute. 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 of the task.
capacityProviderName -> (string)
The capacity provider associated with the task.
clusterArn -> (string)
The ARN of the cluster that hosts the task.
connectivity -> (string)
The connectivity status of a task.
connectivityAt -> (timestamp)
The Unix timestamp for when the task last went into
CONNECTED
status.containerInstanceArn -> (string)
The ARN of the container instances that host the task.
containers -> (list)
The containers associated with the task.
(structure)
A Docker container that is part of a 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.
Note
The
imageDigest
is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.runtimeId -> (string)
The ID of the Docker container.
lastStatus -> (string)
The last known status of the container.
exitCode -> (integer)
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 -> (list)
The network bindings associated with the container.
(structure)
Details on the network bindings between a container and its host container instance. After a task reaches the
RUNNING
status, manual and automatic host and container port assignments are visible in thenetworkBindings
section of DescribeTasks API responses.bindIP -> (string)
The IP address that the container is bound to on the container instance.
containerPort -> (integer)
The port number on the container that is used with the network binding.
hostPort -> (integer)
The port number on the host that is used with the network binding.
protocol -> (string)
The protocol used for the network binding.
networkInterfaces -> (list)
The network interfaces associated with the container.
(structure)
An object representing the elastic network interface for tasks that use the
awsvpc
network mode.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 are not configured for this container in its task definition, then it reports the health status as
UNKNOWN
.cpu -> (string)
The number of CPU units set for the container. The value will be
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 -> (list)
The IDs of each GPU assigned to the container.
(string)
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 example1 vCPU
or1 vcpu
. String values are converted to an integer indicating the CPU units when the task definition is registered.If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the
memory
parameter:
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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)createdAt -> (timestamp)
The Unix timestamp for when the task was created (the task entered the
PENDING
state).desiredStatus -> (string)
The desired status of the task. For more information, see Task Lifecycle .
executionStoppedAt -> (timestamp)
The Unix timestamp for when the task execution stopped.
group -> (string)
The name of the task group associated with the task.
healthStatus -> (string)
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as
HEALTHY
, then the task status also reports asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, then the task status also reports asUNHEALTHY
orUNKNOWN
, accordingly.Note
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image’s Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
inferenceAccelerators -> (list)
The Elastic Inference accelerator associated with the task.
(structure)
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
deviceName -> (string)
The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement .deviceType -> (string)
The Elastic Inference accelerator type to use.
lastStatus -> (string)
The last known status of the task. For more information, see Task Lifecycle .
launchType -> (string)
The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
memory -> (string)
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example
1024
. It can also be expressed as a string using GB, for example1GB
or1 GB
. String values are converted to an integer indicating the MiB when the task definition is registered.If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your 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)overrides -> (structure)
One or more container overrides.
containerOverrides -> (list)
One or more container overrides sent to a task.
(structure)
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be
{"containerOverrides": [ ] }
. If a non-empty container override is specified, thename
parameter must be included.name -> (string)
The name of the container that receives the override. This parameter is required if any override is specified.
command -> (list)
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.
(string)
environment -> (list)
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.
(structure)
A key-value pair object.
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 -> (list)
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
(structure)
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file should contain an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file .If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide .This field is not valid for containers in tasks using the Fargate launch type.
value -> (string)
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
type -> (string)
The file type to use. The only supported value is
s3
.cpu -> (integer)
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 -> (integer)
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 -> (integer)
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 -> (list)
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.
(structure)
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
value -> (string)
The value for the specified resource type.
If the
GPU
type is used, the value is the number of physicalGPUs
the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.If the
InferenceAccelerator
type is used, thevalue
should match thedeviceName
for an InferenceAccelerator specified in a task definition.type -> (string)
The type of resource to assign to a container. The supported values are
GPU
orInferenceAccelerator
.cpu -> (string)
The cpu override for the task.
inferenceAcceleratorOverrides -> (list)
The Elastic Inference accelerator override for the task.
(structure)
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide .
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 IAM role override for the task.
memory -> (string)
The memory override for the task.
taskRoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
platformVersion -> (string)
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .pullStartedAt -> (timestamp)
The Unix timestamp for when the container image pull began.
pullStoppedAt -> (timestamp)
The Unix timestamp for when the container image pull completed.
startedAt -> (timestamp)
The Unix timestamp for when the task started (the task transitioned from the
PENDING
state to theRUNNING
state).startedBy -> (string)
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it.stopCode -> (string)
The stop code indicating why a task was stopped. The
stoppedReason
may contain additional details.stoppedAt -> (timestamp)
The Unix timestamp for when the task was stopped (the task transitioned from the
RUNNING
state to theSTOPPED
state).stoppedReason -> (string)
The reason that the task was stopped.
stoppingAt -> (timestamp)
The Unix timestamp for when the task stops (transitions from the
RUNNING
state toSTOPPED
).tags -> (list)
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.(structure)
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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 -> (long)
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating 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.
failures -> (list)
Any failures associated with the call.
(structure)
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide .
arn -> (string)
The Amazon Resource Name (ARN) of the failed resource.
reason -> (string)
The reason for the failure.
detail -> (string)
The details of the failure.