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.

Modifies the desired count, deployment configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of

docker
            stop
is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

Note:

For PCL this operation is only available in asynchronous form. Please refer to UpdateServiceAsync.

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

Syntax

C#
public virtual UpdateServiceResponse UpdateService(
         UpdateServiceRequest request
)
Parameters
request
Type: Amazon.ECS.Model.UpdateServiceRequest

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

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

Exceptions

ExceptionCondition
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 permission 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.
ServerException These errors are usually caused by a server issue.
ServiceNotActiveException The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.
ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

Examples

This example updates the my-http-service service to use the amazon-ecs-sample task definition.

To change the task definition used in a service


var response = client.UpdateService(new UpdateServiceRequest 
{
    Service = "my-http-service",
    TaskDefinition = "amazon-ecs-sample"
});


            

This example updates the desired count of the my-http-service service to 10.

To change the number of tasks in a service


var response = client.UpdateService(new UpdateServiceRequest 
{
    DesiredCount = 10,
    Service = "my-http-service"
});


            

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