WorkSpaces / Client / restore_workspace

restore_workspace#

WorkSpaces.Client.restore_workspace(**kwargs)#

Restores the specified WorkSpace to its last known healthy state.

You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

This operation is asynchronous and returns before the WorkSpace is completely restored.

See also: AWS API Documentation

Request Syntax

response = client.restore_workspace(
    WorkspaceId='string'
)
Parameters:

WorkspaceId (string) –

[REQUIRED]

The identifier of the WorkSpace.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException