Skip to content

Sets the state of the specified WorkSpace

Description

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.

Usage

workspaces_modify_workspace_state(WorkspaceId, WorkspaceState)

Arguments

  • WorkspaceId

    [required] The identifier of the WorkSpace.

  • WorkspaceState

    [required] The WorkSpace state.

Value

An empty list.

Request syntax

svc$modify_workspace_state(
  WorkspaceId = "string",
  WorkspaceState = "AVAILABLE"|"ADMIN_MAINTENANCE"
)