AmazonECSClient.StartTask Method (StartTaskRequest)

Starts a new task from the specified task definition on the specified container instance or instances.

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.

Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more information, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartTaskAsync.

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

Syntax

public virtual StartTaskResponse StartTask(
         StartTaskRequest request
)

Parameters

request: Type: Amazon.ECS.Model.StartTaskRequest

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

Return Value

Type: StartTaskResponse

The response from the StartTask service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.
UnsupportedFeatureException	The specified task isn't supported in this Region.

Examples

This example starts a new task in the cluster "MyCluster" on the specified container instance using the latest revision of the "hello-world" task definition.

To start a new task


var client = new AmazonECSClient();
var response = client.StartTask(new StartTaskRequest 
{
    Cluster = "MyCluster",
    ContainerInstances = new List<string> {
        "4c543eed-f83f-47da-b1d8-3d23f1da4c64"
    },
    TaskDefinition = "hello-world"
});

List<Failure> failures = response.Failures;
List<Task> tasks = response.Tasks;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.StartTask (StartTaskRequest)

Method