Menu
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

StopWorkspaces

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Request Syntax

Copy
{ "StopWorkspaceRequests": [ { "WorkspaceId": "string" } ] }

Request Parameters

The request accepts the following data in JSON format.

StopWorkspaceRequests

The requests.

Type: Array of StopRequest objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax

Copy
{ "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedRequests

The failed requests.

Type: Array of FailedWorkspaceChangeRequest objects

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: