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

RebootWorkspaces

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.

Note

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

RebootWorkspaceRequests

An array of structures that specify the WorkSpaces to reboot.

Type: Array of RebootRequest 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

An array of structures representing any WorkSpaces that could not be rebooted.

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: