Run Task
ecs_run_task | R Documentation |
Starts a new task using the specified task definition¶
Description¶
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
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 start_task
to use your own scheduler or
place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of 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.
Usage¶
ecs_run_task(capacityProviderStrategy, cluster, count,
enableECSManagedTags, enableExecuteCommand, group, launchType,
networkConfiguration, overrides, placementConstraints,
placementStrategy, platformVersion, propagateTags, referenceId,
startedBy, tags, taskDefinition, clientToken, volumeConfigurations)
Arguments¶
capacityProviderStrategy |
The capacity provider strategy to use for the task. If a When you use cluster auto scaling, you must specify
A capacity provider strategy can contain a maximum of 20 capacity providers. |
cluster |
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed. |
count |
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call. |
enableECSManagedTags |
Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. |
enableExecuteCommand |
Determines whether to use the execute command functionality for
the containers in this task. If If |
group |
The name of the task group to associate with the task. The
default value is the family name of the task definition (for example,
|
launchType |
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide. The Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide. The The A task can use either a launch type or a capacity provider strategy.
If a When you use cluster auto scaling, you must specify
|
networkConfiguration |
The network configuration for the task. This parameter is
required for task definitions that use the |
overrides |
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's specified in the task definition or Docker image) with a
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure. |
placementConstraints |
An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime). |
placementStrategy |
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task. |
platformVersion |
The platform version the task uses. A platform version is only
specified for tasks hosted on Fargate. If one isn't specified, the
|
propagateTags |
Specifies whether to propagate the tags from the task definition
to the task. If no value is specified, the tags aren't propagated. Tags
can only be propagated to the task during task creation. To add tags to
a task after task creation, use the An error will be received if you specify the |
referenceId |
This parameter is only used by Amazon ECS. It is not intended for use by customers. |
startedBy |
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
If a task is started by an Amazon ECS service, then the
|
tags |
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:
|
taskDefinition |
[required] The The full ARN value must match the value that you specified as the
When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN. To specify a specific revision, include the revision number in the
ARN. For example, to specify revision 2, use
To specify all revisions, use the wildcard (*) in the ARN. For
example, to specify all revisions, use For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide. |
clientToken |
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency. |
volumeConfigurations |
The details of the volume that was
|
Value¶
A list with the following syntax:
list(
tasks = list(
list(
attachments = list(
list(
id = "string",
type = "string",
status = "string",
details = list(
list(
name = "string",
value = "string"
)
)
)
),
attributes = list(
list(
name = "string",
value = "string",
targetType = "container-instance",
targetId = "string"
)
),
availabilityZone = "string",
capacityProviderName = "string",
clusterArn = "string",
connectivity = "CONNECTED"|"DISCONNECTED",
connectivityAt = as.POSIXct(
"2015-01-01"
),
containerInstanceArn = "string",
containers = list(
list(
containerArn = "string",
taskArn = "string",
name = "string",
image = "string",
imageDigest = "string",
runtimeId = "string",
lastStatus = "string",
exitCode = 123,
reason = "string",
networkBindings = list(
list(
bindIP = "string",
containerPort = 123,
hostPort = 123,
protocol = "tcp"|"udp",
containerPortRange = "string",
hostPortRange = "string"
)
),
networkInterfaces = list(
list(
attachmentId = "string",
privateIpv4Address = "string",
ipv6Address = "string"
)
),
healthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN",
managedAgents = list(
list(
lastStartedAt = as.POSIXct(
"2015-01-01"
),
name = "ExecuteCommandAgent",
reason = "string",
lastStatus = "string"
)
),
cpu = "string",
memory = "string",
memoryReservation = "string",
gpuIds = list(
"string"
)
)
),
cpu = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
desiredStatus = "string",
enableExecuteCommand = TRUE|FALSE,
executionStoppedAt = as.POSIXct(
"2015-01-01"
),
group = "string",
healthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN",
inferenceAccelerators = list(
list(
deviceName = "string",
deviceType = "string"
)
),
lastStatus = "string",
launchType = "EC2"|"FARGATE"|"EXTERNAL",
memory = "string",
overrides = list(
containerOverrides = list(
list(
name = "string",
command = list(
"string"
),
environment = list(
list(
name = "string",
value = "string"
)
),
environmentFiles = list(
list(
value = "string",
type = "s3"
)
),
cpu = 123,
memory = 123,
memoryReservation = 123,
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"InferenceAccelerator"
)
)
)
),
cpu = "string",
inferenceAcceleratorOverrides = list(
list(
deviceName = "string",
deviceType = "string"
)
),
executionRoleArn = "string",
memory = "string",
taskRoleArn = "string",
ephemeralStorage = list(
sizeInGiB = 123
)
),
platformVersion = "string",
platformFamily = "string",
pullStartedAt = as.POSIXct(
"2015-01-01"
),
pullStoppedAt = as.POSIXct(
"2015-01-01"
),
startedAt = as.POSIXct(
"2015-01-01"
),
startedBy = "string",
stopCode = "TaskFailedToStart"|"EssentialContainerExited"|"UserInitiated"|"ServiceSchedulerInitiated"|"SpotInterruption"|"TerminationNotice",
stoppedAt = as.POSIXct(
"2015-01-01"
),
stoppedReason = "string",
stoppingAt = as.POSIXct(
"2015-01-01"
),
tags = list(
list(
key = "string",
value = "string"
)
),
taskArn = "string",
taskDefinitionArn = "string",
version = 123,
ephemeralStorage = list(
sizeInGiB = 123
),
fargateEphemeralStorage = list(
sizeInGiB = 123,
kmsKeyId = "string"
)
)
),
failures = list(
list(
arn = "string",
reason = "string",
detail = "string"
)
)
)
Request syntax¶
svc$run_task(
capacityProviderStrategy = list(
list(
capacityProvider = "string",
weight = 123,
base = 123
)
),
cluster = "string",
count = 123,
enableECSManagedTags = TRUE|FALSE,
enableExecuteCommand = TRUE|FALSE,
group = "string",
launchType = "EC2"|"FARGATE"|"EXTERNAL",
networkConfiguration = list(
awsvpcConfiguration = list(
subnets = list(
"string"
),
securityGroups = list(
"string"
),
assignPublicIp = "ENABLED"|"DISABLED"
)
),
overrides = list(
containerOverrides = list(
list(
name = "string",
command = list(
"string"
),
environment = list(
list(
name = "string",
value = "string"
)
),
environmentFiles = list(
list(
value = "string",
type = "s3"
)
),
cpu = 123,
memory = 123,
memoryReservation = 123,
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"InferenceAccelerator"
)
)
)
),
cpu = "string",
inferenceAcceleratorOverrides = list(
list(
deviceName = "string",
deviceType = "string"
)
),
executionRoleArn = "string",
memory = "string",
taskRoleArn = "string",
ephemeralStorage = list(
sizeInGiB = 123
)
),
placementConstraints = list(
list(
type = "distinctInstance"|"memberOf",
expression = "string"
)
),
placementStrategy = list(
list(
type = "random"|"spread"|"binpack",
field = "string"
)
),
platformVersion = "string",
propagateTags = "TASK_DEFINITION"|"SERVICE"|"NONE",
referenceId = "string",
startedBy = "string",
tags = list(
list(
key = "string",
value = "string"
)
),
taskDefinition = "string",
clientToken = "string",
volumeConfigurations = list(
list(
name = "string",
managedEBSVolume = list(
encrypted = TRUE|FALSE,
kmsKeyId = "string",
volumeType = "string",
sizeInGiB = 123,
snapshotId = "string",
iops = 123,
throughput = 123,
tagSpecifications = list(
list(
resourceType = "volume",
tags = list(
list(
key = "string",
value = "string"
)
),
propagateTags = "TASK_DEFINITION"|"SERVICE"|"NONE"
)
),
roleArn = "string",
terminationPolicy = list(
deleteOnTermination = TRUE|FALSE
),
filesystemType = "ext3"|"ext4"|"xfs"|"ntfs"
)
)
)
)
Examples¶
## Not run:
# This example runs the specified task definition on your default cluster.
svc$run_task(
cluster = "default",
taskDefinition = "sleep360:1"
)
## End(Not run)