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 the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

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 BeginStopWorkspaces and EndStopWorkspaces.

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

Syntax

C#
public virtual Task<StopWorkspacesResponse> StopWorkspacesAsync(
         StopWorkspacesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.WorkSpaces.Model.StopWorkspacesRequest

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also