WorkSpaces / Client / migrate_workspace



Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.migrate_workspace(
  • SourceWorkspaceId (string) –


    The identifier of the WorkSpace to migrate from.

  • BundleId (string) –


    The identifier of the target bundle type to migrate the WorkSpace to.

Return type:



Response Syntax

    'SourceWorkspaceId': 'string',
    'TargetWorkspaceId': 'string'

Response Structure

  • (dict) –

    • SourceWorkspaceId (string) –

      The original identifier of the WorkSpace that is being migrated.

    • TargetWorkspaceId (string) –

      The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.


  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException

  • WorkSpaces.Client.exceptions.OperationInProgressException

  • WorkSpaces.Client.exceptions.ResourceUnavailableException