AmazonECSClient.StopServiceDeployment Method (StopServiceDeploymentRequest)

Stops an ongoing service deployment.

The following stop types are avaiable:

ROLLBACK - This option rolls back the service deployment to the previous service revision.
You can use this option even if you didn't configure the service deployment for the rollback option.

For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.

Note:

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

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

Syntax

public virtual StopServiceDeploymentResponse StopServiceDeployment(
         StopServiceDeploymentRequest request
)

Parameters

request: Type: Amazon.ECS.Model.StopServiceDeploymentRequest

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

Return Value

Type: StopServiceDeploymentResponse

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

Exceptions

Exception	Condition
AccessDeniedException	You don't have authorization to perform the requested action.
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.
ConflictException	The request could not be processed because of conflict in the current state of the resource.
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.
ServiceDeploymentNotFoundException	The service deploy ARN that you specified in the StopServiceDeployment doesn't exist. You can use ListServiceDeployments to retrieve the service deployment ARNs.
UnsupportedFeatureException	The specified task isn't supported in this Region.

Examples

This example stops the service deployment using the ROLLBACK option.

To stop a service deployment


var client = new AmazonECSClient();
var response = client.StopServiceDeployment(new StopServiceDeploymentRequest 
{
    ServiceDeploymentArn = "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r",
    StopType = "ROLLBACK"
});

string serviceDeploymentArn = response.ServiceDeploymentArn;

Version Information

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

AmazonECSClient.StopServiceDeployment (StopServiceDeploymentRequest)

Method