AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon WorkSpaces ImportCustomWorkspaceImage API operation.

Syntax

Import-WKSCustomWorkspaceImage
-ImageName <String>
-ComputeType <ImageComputeType>
-ImageSource_Ec2ImageId <String>
-ImageSource_Ec2ImportTaskId <String>
-ImageSource_ImageBuildVersionArn <String>
-ImageDescription <String>
-InfrastructureConfigurationArn <String>
-OsVersion <OSVersion>
-Platform <Platform>
-Protocol <CustomImageProtocol>
-Tag <Tag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonWorkSpacesConfig>

Description

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

-ClientConfig <AmazonWorkSpacesConfig>
Amazon.PowerShell.Cmdlets.WKS.AmazonWorkSpacesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeType <ImageComputeType>
The supported compute type for the WorkSpace image.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageDescription <String>
The description of the WorkSpace image.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageName <String>
The name of the WorkSpace image.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ImageSource_Ec2ImageId <String>
The identifier of the EC2 image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageSource_Ec2ImportTaskId <String>
The EC2 import task ID to import the image from the Amazon EC2 VM import process.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageSource_ImageBuildVersionArn <String>
The ARN of the EC2 Image Builder image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InfrastructureConfigurationArn <String>
The infrastructure configuration ARN that specifies how the WorkSpace image is built.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OsVersion <OSVersion>
The OS version for the WorkSpace image source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Platform <Platform>
The platform for the WorkSpace image source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <CustomImageProtocol>
The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpaces.Model.ImportCustomWorkspaceImageResponse). Specifying the name of a property of type Amazon.WorkSpaces.Model.ImportCustomWorkspaceImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The resource tags. Each WorkSpaces resource can have a maximum of 50 tags. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.WorkSpaces.Model.ImportCustomWorkspaceImageResponse
This cmdlet returns an Amazon.WorkSpaces.Model.ImportCustomWorkspaceImageResponse object containing multiple properties.
Administration Guide
Developer Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z