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

ModifyWorkspaceProperties

Modifies the WorkSpace properties, including the running mode and AutoStop time.

Request Syntax

{
   "WorkspaceId": "string",
   "WorkspaceProperties": { 
      "RunningMode": "string",
      "RunningModeAutoStopTimeoutInMinutes": number
   }
}

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

WorkspaceProperties

The WorkSpace properties of the request.

Type: WorkspaceProperties object

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.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

InvalidResourceStateException

The state of the WorkSpace is not valid for this operation.

HTTP Status Code: 400

OperationInProgressException

The properties of this WorkSpace are currently being modified. Try again in a moment.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400

UnsupportedWorkspaceConfigurationException

The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: