RunTaskRequest Class | AWS SDK for .NET V3

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.RunTaskRequest

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

Syntax

public class RunTaskRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The RunTaskRequest type exposes the following members

Constructors

	Name	Description
	RunTaskRequest()

Properties

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 `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used. When you use cluster auto scaling, you must specify `capacityProviderStrategy` and not `launchType`. 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 `true`, this enables execute command functionality on all containers in the task. If `true`, then the task definition must have a task role, or you must provide one as an override.
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`).
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` launch type runs your tasks on Fargate On-Demand infrastructure. 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 `EC2` launch type runs your tasks on Amazon EC2 instances registered to your cluster. The `EXTERNAL` launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster. A task can use either a launch type or a capacity provider strategy. If a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted. When you use cluster auto scaling, you must specify `capacityProviderStrategy` and not `launchType`.
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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
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 `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.
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 `LATEST` platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
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 the TagResource API action. An error will be received if you specify the `SERVICE` option when running a task.
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 `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 128 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	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: 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.
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` isn't specified, the latest `ACTIVE` revision is used. The full ARN value must match the value that you specified as the `Resource` of the principal's permissions policy. 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 `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2`. To specify all revisions, use the wildcard () in the ARN. For example, to specify all revisions, use `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:`. 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 `configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The `name` of the volume must match the `name` from the task definition.

Examples

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

To run a task on your default cluster


var client = new AmazonECSClient();
var response = client.RunTask(new RunTaskRequest 
{
    Cluster = "default",
    TaskDefinition = "sleep360:1"
});

List<Task> tasks = response.Tasks;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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