| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.WorkSpaces.UpdateWorkspaceImagePermission
Description
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.
- 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.
Synopsis
- data UpdateWorkspaceImagePermission = UpdateWorkspaceImagePermission' {
- imageId :: Text
- allowCopyImage :: Bool
- sharedAccountId :: Text
- newUpdateWorkspaceImagePermission :: Text -> Bool -> Text -> UpdateWorkspaceImagePermission
- updateWorkspaceImagePermission_imageId :: Lens' UpdateWorkspaceImagePermission Text
- updateWorkspaceImagePermission_allowCopyImage :: Lens' UpdateWorkspaceImagePermission Bool
- updateWorkspaceImagePermission_sharedAccountId :: Lens' UpdateWorkspaceImagePermission Text
- data UpdateWorkspaceImagePermissionResponse = UpdateWorkspaceImagePermissionResponse' {
- httpStatus :: Int
- newUpdateWorkspaceImagePermissionResponse :: Int -> UpdateWorkspaceImagePermissionResponse
- updateWorkspaceImagePermissionResponse_httpStatus :: Lens' UpdateWorkspaceImagePermissionResponse Int
Creating a Request
data UpdateWorkspaceImagePermission Source #
See: newUpdateWorkspaceImagePermission smart constructor.
Constructors
| UpdateWorkspaceImagePermission' | |
Fields
| |
Instances
newUpdateWorkspaceImagePermission Source #
Arguments
| :: Text | |
| -> Bool | |
| -> Text | |
| -> UpdateWorkspaceImagePermission |
Create a value of UpdateWorkspaceImagePermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageId:UpdateWorkspaceImagePermission', updateWorkspaceImagePermission_imageId - The identifier of the image.
$sel:allowCopyImage:UpdateWorkspaceImagePermission', updateWorkspaceImagePermission_allowCopyImage - The permission to copy the image. This permission can be revoked only
after an image has been shared.
$sel:sharedAccountId:UpdateWorkspaceImagePermission', updateWorkspaceImagePermission_sharedAccountId - The identifier of the Amazon Web Services account to share or unshare
the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
Request Lenses
updateWorkspaceImagePermission_imageId :: Lens' UpdateWorkspaceImagePermission Text Source #
The identifier of the image.
updateWorkspaceImagePermission_allowCopyImage :: Lens' UpdateWorkspaceImagePermission Bool Source #
The permission to copy the image. This permission can be revoked only after an image has been shared.
updateWorkspaceImagePermission_sharedAccountId :: Lens' UpdateWorkspaceImagePermission Text Source #
The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
Destructuring the Response
data UpdateWorkspaceImagePermissionResponse Source #
See: newUpdateWorkspaceImagePermissionResponse smart constructor.
Constructors
| UpdateWorkspaceImagePermissionResponse' | |
Fields
| |
Instances
newUpdateWorkspaceImagePermissionResponse Source #
Arguments
| :: Int | |
| -> UpdateWorkspaceImagePermissionResponse |
Create a value of UpdateWorkspaceImagePermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWorkspaceImagePermissionResponse', updateWorkspaceImagePermissionResponse_httpStatus - The response's http status code.
Response Lenses
updateWorkspaceImagePermissionResponse_httpStatus :: Lens' UpdateWorkspaceImagePermissionResponse Int Source #
The response's http status code.