WorkSpaces / Client / modify_workspace_state

modify_workspace_state#

WorkSpaces.Client.modify_workspace_state(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_workspace_state(
    WorkspaceId='string',
    WorkspaceState='AVAILABLE'|'ADMIN_MAINTENANCE'
)
Parameters:

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the WorkSpace.

  • WorkspaceState (string) –

    [REQUIRED]

    The WorkSpace state.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.InvalidResourceStateException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException