RebootWorkspaces
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
or
UNHEALTHY
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
Request Syntax
{
"RebootWorkspaceRequests": [
{
"WorkspaceId": "string
"
}
]
}
Request Parameters
The request accepts the following data in JSON format.
- RebootWorkspaceRequests
-
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
Type: Array of RebootRequest objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
Response Syntax
{
"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
-
Information about the 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.
- OperationNotSupportedException
-
This operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: