AWS SDK Version 4 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 pool.

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StopWorkspacesPoolAsync.

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

Syntax

C#
public virtual StopWorkspacesPoolResponse StopWorkspacesPool(
         StopWorkspacesPoolRequest request
)

Parameters

request
Type: Amazon.WorkSpaces.Model.StopWorkspacesPoolRequest

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

Return Value


The response from the StopWorkspacesPool service method, as returned by WorkSpaces.

Exceptions

ExceptionCondition
AccessDeniedException The user is not authorized to access a resource.
InvalidParameterValuesException One or more parameter values are not valid.
InvalidResourceStateException The state of the resource is not valid for this operation.
OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
ResourceNotFoundException The resource could not be found.

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

See Also