ModifyWorkspaceState
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to
ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to
reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not
stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
Request Syntax
{
"WorkspaceId": "string",
"WorkspaceState": "string"
}Request Parameters
The request accepts the following data in JSON format.
- WorkspaceId
-
The identifier of the WorkSpace.
Type: String
Pattern:
^ws-[0-9a-z]{8,63}$Required: Yes
- WorkspaceState
-
The WorkSpace state.
Type: String
Valid Values:
AVAILABLE | ADMIN_MAINTENANCERequired: 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.
- 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
- OperationNotSupportedException
-
This operation is not supported.
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:
