AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the RunTask operation.
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.
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.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
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.
Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public class RunTaskRequest : AmazonECSRequest IAmazonWebServiceRequest
The RunTaskRequest type exposes the following members
Name | Description | |
---|---|---|
RunTaskRequest() |
Name | Type | Description | |
---|---|---|---|
CapacityProviderStrategy | System.Collections.Generic.List<Amazon.ECS.Model.CapacityProviderStrategyItem> |
Gets and sets the property 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 may contain a maximum of 6 capacity providers. |
|
ClientToken | System.String |
Gets and sets the property 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. |
|
Cluster | System.String |
Gets and sets the property 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 | System.Int32 |
Gets and sets the property 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 | System.Boolean |
Gets and sets the property 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 | System.Boolean |
Gets and sets the property EnableExecuteCommand.
Determines whether to use the execute command functionality for the containers in
this task. If
If |
|
Group | System.String |
Gets and sets the property 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 | Amazon.ECS.LaunchType |
Gets and sets the property 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 | Amazon.ECS.Model.NetworkConfiguration |
Gets and sets the property NetworkConfiguration.
The network configuration for the task. This parameter is required for task definitions
that use the |
|
Overrides | Amazon.ECS.Model.TaskOverride |
Gets and sets the property 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 | System.Collections.Generic.List<Amazon.ECS.Model.PlacementConstraint> |
Gets and sets the property 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 | System.Collections.Generic.List<Amazon.ECS.Model.PlacementStrategy> |
Gets and sets the property PlacementStrategy. The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task. |
|
PlatformVersion | System.String |
Gets and sets the property 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 | Amazon.ECS.PropagateTags |
Gets and sets the property 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 theTagResource API action.
An error will be received if you specify the |
|
ReferenceId | System.String |
Gets and sets the property ReferenceId. The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters. |
|
StartedBy | System.String |
Gets and sets the property 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 | System.Collections.Generic.List<Amazon.ECS.Model.Tag> |
Gets and sets the property 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 | System.String |
Gets and sets the property TaskDefinition.
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. |
|
VolumeConfigurations | System.Collections.Generic.List<Amazon.ECS.Model.TaskVolumeConfiguration> |
Gets and sets the property VolumeConfigurations.
The details of the volume that was |
This example runs the specified task definition on your default cluster.
var client = new AmazonECSClient(); var response = client.RunTask(new RunTaskRequest { Cluster = "default", TaskDefinition = "sleep360:1" }); List<Task> tasks = response.Tasks;
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5