Use `ModifyWorkspaceProperties` with a CLI

The following code examples show how to use ModifyWorkspaceProperties.

CLI

AWS CLI

To modify the running mode of a WorkSpace

The following modify-workspace-properties example sets the running mode of the specified WorkSpace to AUTO_STOP.


aws workspaces modify-workspace-properties \
    --workspace-id ws-dk1xzr417 \
    --workspace-properties RunningMode=AUTO_STOP

This command produces no output.

For more information, see Modify a WorkSpace in the Amazon WorkSpaces Administration Guide.

PowerShell

Tools for PowerShell V4

Example 1: This Sample changes the Workspace Running Mode Property to Auto Stop for the specified Workspace


Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP

For API details, see ModifyWorkspaceProperties in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This Sample changes the Workspace Running Mode Property to Auto Stop for the specified Workspace


Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP

For API details, see ModifyWorkspaceProperties in AWS Tools for PowerShell Cmdlet Reference (V5).

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

ModifyWorkspaceCreationProperties

ModifyWorkspaceState

Use ModifyWorkspaceProperties with a CLI