updateWorkspaceImagePermission method

Future<void> updateWorkspaceImagePermission({ required bool allowCopyImage, required String imageId, required String sharedAccountId, })

Shares or unshares an image with one account in the same AWS 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 AWS Regions as needed.

In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS 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 AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.

May throw ResourceNotFoundException. May throw ResourceUnavailableException. May throw AccessDeniedException. May throw InvalidParameterValuesException. May throw OperationNotSupportedException.

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

Parameter imageId : The identifier of the image.

Parameter sharedAccountId : The identifier of the AWS account to share or unshare the image with.

Implementation

Future<void> updateWorkspaceImagePermission({
  required bool allowCopyImage,
  required String imageId,
  required String sharedAccountId,
}) async {
  ArgumentError.checkNotNull(allowCopyImage, 'allowCopyImage');
  ArgumentError.checkNotNull(imageId, 'imageId');
  ArgumentError.checkNotNull(sharedAccountId, 'sharedAccountId');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkspacesService.UpdateWorkspaceImagePermission'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AllowCopyImage': allowCopyImage,
      'ImageId': imageId,
      'SharedAccountId': sharedAccountId,
    },
  );
}