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.

Stops an ongoing service deployment.

The following stop types are avaiable:

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStopServiceDeployment and EndStopServiceDeployment.

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

Syntax

C#
public virtual Task<StopServiceDeploymentResponse> StopServiceDeploymentAsync(
         StopServiceDeploymentRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ECS.Model.StopServiceDeploymentRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also