StopWorkspacesPool
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.
Request Syntax
{
"PoolId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- PoolId
-
The identifier of the pool.
Type: String
Pattern:
^wspool-[0-9a-z]{9}$Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
- InvalidParameterValuesException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- InvalidResourceStateException
-
The state of the resource is not valid for this operation.
HTTP Status Code: 400
- OperationInProgressException
-
The properties of this WorkSpace are currently being modified. Try again in a moment.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
