AWS SDK Version 3 for .NET
API Reference

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.

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. You should 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:

Inheritance Hierarchy


Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z


public class RunTaskRequest : AmazonECSRequest

The RunTaskRequest type exposes the following members


Public Method RunTaskRequest()


Public Property Cluster System.String

Gets and sets the property Cluster.

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.

Public Property 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 per call.

Public Property 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, family:my-family-name).

Public Property LaunchType Amazon.ECS.LaunchType

Gets and sets the property LaunchType.

The launch type on which to run your task.

Public Property 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 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.

Public Property 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 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 an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Public Property 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 per task (including constraints in the task definition and those specified at run time).

Public Property 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 five strategy rules per task.

Public Property PlatformVersion System.String

Gets and sets the property PlatformVersion.

The platform version on which to run your task. If one is not specified, the latest version is used by default.

Public Property 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 startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy 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.

Public Property TaskDefinition System.String

Gets and sets the property TaskDefinition.

The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.


This example runs the specified task definition on your default cluster.

To run a task on your default cluster

var response = client.RunTask(new RunTaskRequest 
    Cluster = "default",
    TaskDefinition = "sleep360:1"

List tasks = response.Tasks;


Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms