ModifyWorkspaceProperties
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
Note
The MANUAL running mode value is only supported by Amazon WorkSpaces
Core. Contact your account team to be allow-listed to use this value. For more
information, see Amazon WorkSpaces
Core
Request Syntax
{
"DataReplication": "string",
"WorkspaceId": "string",
"WorkspaceProperties": {
"ComputeTypeName": "string",
"GlobalAccelerator": {
"Mode": "string",
"PreferredProtocol": "string"
},
"OperatingSystemName": "string",
"Protocols": [ "string" ],
"RootVolumeSizeGib": number,
"RunningMode": "string",
"RunningModeAutoStopTimeoutInMinutes": number,
"UserVolumeSizeGib": number
}
}Request Parameters
The request accepts the following data in JSON format.
- DataReplication
-
Indicates the data replication status.
Type: String
Valid Values:
NO_REPLICATION | PRIMARY_AS_SOURCERequired: No
- WorkspaceId
-
The identifier of the WorkSpace.
Type: String
Pattern:
^ws-[0-9a-z]{8,63}$Required: Yes
- WorkspaceProperties
-
The properties of the WorkSpace.
Type: WorkspaceProperties object
Required: No
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 resource 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 Required Configuration and Service Components for WorkSpaces .
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
