MigrateWorkspace - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

MigrateWorkspace

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.

Request Syntax

{ "BundleId": "string", "SourceWorkspaceId": "string" }

Request Parameters

The request accepts the following data in JSON format.

BundleId

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

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: Yes

SourceWorkspaceId

The identifier of the WorkSpace to migrate from.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: Yes

Response Syntax

{ "SourceWorkspaceId": "string", "TargetWorkspaceId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SourceWorkspaceId

The original identifier of the WorkSpace that is being migrated.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

TargetWorkspaceId

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.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

OperationInProgressException

The properties of this WorkSpace are currently being modified. Try again in a moment.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: