WorkSpaces / Client / update_workspace_image_permission

update_workspace_image_permission#

WorkSpaces.Client.update_workspace_image_permission(**kwargs)#

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

After an image has been shared, the recipient account can copy the image to other Regions as needed.

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

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

For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

Note

  • To delete an image that has been shared, you must unshare the image before you delete it.

  • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn’t supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

See also: AWS API Documentation

Request Syntax

response = client.update_workspace_image_permission(
    ImageId='string',
    AllowCopyImage=True|False,
    SharedAccountId='string'
)
Parameters:

  • ImageId (string) –

    [REQUIRED]

    The identifier of the image.

  • AllowCopyImage (boolean) –

    [REQUIRED]

    The permission to copy the image. This permission can be revoked only after an image has been shared.

  • SharedAccountId (string) –

    [REQUIRED]

    The identifier of the Amazon Web Services account to share or unshare the image with.

    Warning

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.ResourceUnavailableException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException