import_custom_workspace_image
async
¶
import_custom_workspace_image(
image_name: WorkspaceImageName,
image_description: WorkspaceImageDescription,
compute_type: ImageComputeType,
protocol: CustomImageProtocol,
image_source: ImageSourceIdentifier,
infrastructure_configuration_arn: InfrastructureConfigurationArn,
platform: Platform,
os_version: OSVersion,
*,
config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
tags: Optional[TagList] = None,
) -> ImportCustomWorkspaceImageResult
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
Parameters:
-
image_name(WorkspaceImageName) –The name of the WorkSpace image.
-
image_description(WorkspaceImageDescription) –The description of the WorkSpace image.
-
compute_type(ImageComputeType) –The supported compute type for the WorkSpace image.
-
protocol(CustomImageProtocol) –The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.
-
image_source(ImageSourceIdentifier) –The options for image import source.
-
infrastructure_configuration_arn(InfrastructureConfigurationArn) –The infrastructure configuration ARN that specifies how the WorkSpace image is built.
-
platform(Platform) –The platform for the WorkSpace image source.
-
os_version(OSVersion) –The OS version for the WorkSpace image source.
-
tags(Optional[TagList], default:None) –The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.
Raises:
-
AccessDeniedException–The user is not authorized to access a resource.
-
InvalidParameterValuesException–One or more parameter values are not valid.
-
OperationNotSupportedException–This operation is not supported.
-
ResourceAlreadyExistsException–The specified resource already exists.
-
ResourceLimitExceededException–Your resource limits have been exceeded.
-
ResourceNotFoundException–The resource could not be found.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 | |