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.

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:

Note:

For .NET Core and PCL this operation is only available in asynchronous form. Please refer to RunTaskAsync.

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

Syntax

C#
public abstract RunTaskResponse RunTask(
         RunTaskRequest request
)
Parameters
request
Type: Amazon.ECS.Model.RunTaskRequest

Container for the necessary parameters to execute the RunTask service method.

Return Value
The response from the RunTask service method, as returned by ECS.

Exceptions

ExceptionCondition
AccessDeniedException You do not have authorization to perform the requested action.
BlockedException Your AWS account has been blocked. Contact AWS Support for more information.
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
PlatformTaskDefinitionIncompatibilityException The specified platform version does not satisfy the task definition's required capabilities.
PlatformUnknownException The specified platform version does not exist.
ServerException These errors are usually caused by a server issue.
UnsupportedFeatureException The specified task is not supported in this region.

Examples

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 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

See Also