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.

Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

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 BeginDeregisterInstance and EndDeregisterInstance.

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

Syntax

C#
public abstract Task<DeregisterInstanceResponse> DeregisterInstanceAsync(
         DeregisterInstanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.OpsWorks.Model.DeregisterInstanceRequest

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

Exceptions

ExceptionCondition
ResourceNotFoundException Indicates that a resource was not found.
ValidationException Indicates that a request was 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