Share or unshare a custom image in WorkSpaces Personal
You can share custom WorkSpaces images across Amazon accounts within the same Amazon Region. After an image has been shared, the recipient account can copy the image to other Amazon Regions as needed. For more information about copying images, see Copy a custom image in WorkSpaces Personal.
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.
There are no additional charges for sharing an image. However, the quota for the number of images in the Amazon Region applies. A shared image doesn't count against the recipient account's quota until the recipient copies the image. For more information about Amazon WorkSpaces quotas, see Amazon WorkSpaces quotas.
To delete a shared image, you must unshare the image before you can delete it.
Share Bring Your Own License images
You can share Bring Your Own License (BYOL) images only with Amazon accounts that are enabled for BYOL. The Amazon account that you want to share BYOL images with must also be part of your organization (under the same payer account).
Note
Sharing BYOL images across Amazon accounts isn't supported at this time in the Amazon GovCloud (US-West) and Amazon GovCloud (US-East) Regions. To share BYOL images across accounts in the Amazon GovCloud (US-West) and Amazon GovCloud (US-East) Regions, contact Amazon Support.
Images shared with you
If images are shared with you, you can copy them. You can then use your copies of the shared images to create bundles for launching new WorkSpaces.
Important
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon account. To programmatically determine if an image has been shared, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations or the describe-workspace-images and describe-workspace-image-permissions commands in the Amazon command line interface (CLI).
The creation date shown for an image that has been shared with you is the date that the image was originally created, not the date that the image was shared with you.
If an image has been shared with you, you can't further share that image with other accounts.
To share an image
Open the WorkSpaces console at https://console.amazonaws.cn/workspaces/
. -
In the navigation pane, choose Images.
-
Choose the image to open its details page.
-
On the image detail page, in the Shared accounts section, choose Add account.
-
On the Add account page, under Add account to share with, enter the account ID of the account that you want to share the image with.
Important
Before sharing the image, confirm that you are sharing to the correct Amazon account ID.
-
Choose Share image.
Note
To use the shared image, the recipient account must first copy the image. The recipient account can then use its copy of the shared image to create bundles for launching new WorkSpaces.
To stop sharing an image
Open the WorkSpaces console at https://console.amazonaws.cn/workspaces/
. -
In the navigation pane, choose Images.
-
Choose the image to open its details page.
-
On the image detail page, in the Shared accounts section, select the Amazon account that you want to stop sharing with, and then choose Unshare.
-
When prompted to confirm unsharing the image, choose Unshare.
Note
If you want to delete the image after unsharing it, you must first unshare it from all of the accounts that it has been shared with.
After you stop sharing an image, the recipient account can no longer make copies of the image. However, any copies of shared images that are already in the recipient account remain in that account, and new WorkSpaces can be launched from those copies.
To share or unshare images programmatically
To share or unshare images programmatically, use the UpdateWorkspaceImagePermission API operation or the update-workspace-image-permission Amazon Command Line Interface (Amazon CLI) command. To determine if an image has been shared, use the DescribeWorkspaceImagePermissions API operation or the describe-workspace-image-permissions CLI command.