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.

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

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 BeginDeleteServer and EndDeleteServer.

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

Syntax

C#
public abstract Task<DeleteServerResponse> DeleteServerAsync(
         DeleteServerRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.OpsWorksCM.Model.DeleteServerRequest

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

Exceptions

ExceptionCondition
InvalidStateException The resource is in a state that does not allow you to perform a specified action.
ResourceNotFoundException The requested resource does not exist, or access was denied.
ValidationException One or more of the provided request parameters are not valid.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also