Copy a custom WorkSpaces image - Amazon WorkSpaces
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).

Copy a custom WorkSpaces image

You can copy a custom WorkSpaces image within or across Amazon Regions. Copying an image results in the creation of an identical image with its own unique identifier.

You can copy a Bring Your Own License (BYOL) image to another Region as long as the destination Region is enabled for BYOL. Ensure that BYOL is enabled for all accounts and Regions involved.

Note

In the China (Ningxia) Region, you can copy images only within the same Region.

In the Amazon GovCloud (US) Regions, to copy images to and from other Amazon Regions, contact Amazon Support.

In Opt-in Regions, to copy images to other Regions, contact Amazon Support. For more information about Opt-in Regions, see Available Regions.

You can also copy an image that has been shared with you by another Amazon account. For more information about shared images, see Share or unshare a custom WorkSpaces image.

There are no additional charges for copying an image within or across Regions. However, the quota for the number of images in the destination Region applies. For more information about Amazon WorkSpaces quotas, see Amazon WorkSpaces quotas.

IAM Permissions to copy an image

If you use an IAM user to copy an image, the user must have permissions for workspaces:DescribeWorkspaceImages and workspaces:CopyWorkspaceImage.

The following example policy allows the user to copy the specified image to the specified account in the specified Region.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "workspaces:DescribeWorkspaceImages",
        "workspaces:CopyWorkspaceImage"
      ],
      "Resource": [
          "arn:aws:workspaces:us-east-1:123456789012:workspaceimage/wsi-a1bcd2efg"
      ]
    }
  ]
}
Important

If you are creating an IAM policy for copying shared images for accounts that don't own the images, you cannot specify an account ID in the ARN. Instead, you must use * for the account ID, as shown in the following example policy.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "workspaces:DescribeWorkspaceImages",
        "workspaces:CopyWorkspaceImage"
      ],
      "Resource": [
          "arn:aws:workspaces:us-east-1:*:workspaceimage/wsi-a1bcd2efg"
      ]
    }
  ]
}

You can specify an account ID in the ARN only when that account owns the images to be copied.

For more information about working with IAM, see Identity and access management for WorkSpaces.

Bulk copy images

You can copy images one by one using the console. To bulk copy images, use the CopyWorkspaceImage API operation or the copy-workspace-image command in the Amazon Command Line Interface (Amazon CLI). For more information, see CopyWorkspaceImage in the Amazon WorkSpaces API Reference or see copy-workspace-image in the Amazon CLI Command Reference.

Important

Before copying a shared image, be sure to verify that it has been shared from the correct Amazon account. To determine if an image has been shared and to see the Amazon account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations or the describe-workspace-images and describe-workspace-image-permissions commands in the Amazon CLI.

To copy an image using the console

  1. Open the WorkSpaces console at https://console.amazonaws.cn/workspaces/.

  2. In the navigation pane, choose Images.

  3. Select the image and choose Actions, Copy image.

  4. For Select destination, select the Amazon Region that you want to copy the image to.

  5. For Name of the copy, enter the new name for the copied image, and for Description, enter a description for the copied image.

  6. (Optional) Under Tags, enter tags for the copied image. For more information, see Tag WorkSpaces resources.

  7. Choose Copy image.