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

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, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can 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 ID of the WorkSpace.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: Yes

WorkspaceState

The WorkSpace state.

Type: String

Valid Values: AVAILABLE | ADMIN_MAINTENANCE

Required: 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

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: