RebuildWorkspaces
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
,
ERROR
, UNHEALTHY
, STOPPED
, or
REBOOTING
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
Request Syntax
{
"RebuildWorkspaceRequests": [
{
"WorkspaceId": "string
"
}
]
}
Request Parameters
The request accepts the following data in JSON format.
- RebuildWorkspaceRequests
-
The WorkSpace to rebuild. You can specify a single WorkSpace.
Type: Array of RebuildRequest objects
Array Members: Fixed number of 1 item.
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 WorkSpace that could not be rebuilt.
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: