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.

Attempts to stop an ongoing deployment.

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 BeginStopDeployment and EndStopDeployment.

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

Syntax

C#
public abstract Task<StopDeploymentResponse> StopDeploymentAsync(
         StopDeploymentRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeDeploy.Model.StopDeploymentRequest

Container for the necessary parameters to execute the StopDeployment 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 StopDeployment service method, as returned by CodeDeploy.

Exceptions

ExceptionCondition
DeploymentAlreadyCompletedException The deployment is already complete.
DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
DeploymentIdRequiredException At least one deployment ID must be specified.
InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also