[ aws . workspaces ]

migrate-workspace

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  migrate-workspace
--source-workspace-id <value>
--bundle-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--source-workspace-id (string)

The identifier of the WorkSpace to migrate from.

--bundle-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To migrate a WorkSpace

The following migrate-workspace example migrates the specified WorkSpace to the Standard with Windows 10 (English) public bundle type.

aws workspaces migrate-workspace \
    --source-workspace-id ws-12345678 \
    --bundle-id wsb-8vbljg4r6

Output:

{
    "SourceWorkspaceId": "ws-12345678",
    "TargetWorkspaceId": "ws-87654321"
}

Output

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.