Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpaces.ImportWorkspaceImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports the specified Windows 10 Bring Your Own License (BYOL) or Windows Server 2016 BYOL image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 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.

Synopsis

data ImportWorkspaceImage = ImportWorkspaceImage' {
- applications :: Maybe (NonEmpty Application)
- tags :: Maybe [Tag]
- ec2ImageId :: Text
- ingestionProcess :: WorkspaceImageIngestionProcess
- imageName :: Text
- imageDescription :: Text
}
newImportWorkspaceImage :: Text -> WorkspaceImageIngestionProcess -> Text -> Text -> ImportWorkspaceImage
importWorkspaceImage_applications :: Lens' ImportWorkspaceImage (Maybe (NonEmpty Application))
importWorkspaceImage_tags :: Lens' ImportWorkspaceImage (Maybe [Tag])
importWorkspaceImage_ec2ImageId :: Lens' ImportWorkspaceImage Text
importWorkspaceImage_ingestionProcess :: Lens' ImportWorkspaceImage WorkspaceImageIngestionProcess
importWorkspaceImage_imageName :: Lens' ImportWorkspaceImage Text
importWorkspaceImage_imageDescription :: Lens' ImportWorkspaceImage Text
data ImportWorkspaceImageResponse = ImportWorkspaceImageResponse' {
- imageId :: Maybe Text
- httpStatus :: Int
}
newImportWorkspaceImageResponse :: Int -> ImportWorkspaceImageResponse
importWorkspaceImageResponse_imageId :: Lens' ImportWorkspaceImageResponse (Maybe Text)
importWorkspaceImageResponse_httpStatus :: Lens' ImportWorkspaceImageResponse Int

Creating a Request

data ImportWorkspaceImage Source #

See: newImportWorkspaceImage smart constructor.

Constructors

ImportWorkspaceImage'

Fields

applications :: Maybe (NonEmpty Application)
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
tags :: Maybe [Tag]
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
ec2ImageId :: Text
The identifier of the EC2 image.
ingestionProcess :: WorkspaceImageIngestionProcess
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
imageName :: Text
The name of the WorkSpace image.
imageDescription :: Text
The description of the WorkSpace image.

Instances

Instances details

ToJSON ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods toJSON :: ImportWorkspaceImage -> Value # toEncoding :: ImportWorkspaceImage -> Encoding # toJSONList :: [ImportWorkspaceImage] -> Value # toEncodingList :: [ImportWorkspaceImage] -> Encoding #
ToHeaders ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods toHeaders :: ImportWorkspaceImage -> [Header] #
ToPath ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods toPath :: ImportWorkspaceImage -> ByteString #
ToQuery ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods toQuery :: ImportWorkspaceImage -> QueryString #
AWSRequest ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Associated Types type AWSResponse ImportWorkspaceImage # Methods request :: (Service -> Service) -> ImportWorkspaceImage -> Request ImportWorkspaceImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportWorkspaceImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportWorkspaceImage))) #
Generic ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Associated Types type Rep ImportWorkspaceImage :: Type -> Type # Methods from :: ImportWorkspaceImage -> Rep ImportWorkspaceImage x # to :: Rep ImportWorkspaceImage x -> ImportWorkspaceImage #
Read ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods readsPrec :: Int -> ReadS ImportWorkspaceImage # readList :: ReadS [ImportWorkspaceImage] # readPrec :: ReadPrec ImportWorkspaceImage # readListPrec :: ReadPrec [ImportWorkspaceImage] #
Show ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods showsPrec :: Int -> ImportWorkspaceImage -> ShowS # show :: ImportWorkspaceImage -> String # showList :: [ImportWorkspaceImage] -> ShowS #
NFData ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods rnf :: ImportWorkspaceImage -> () #
Eq ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods (==) :: ImportWorkspaceImage -> ImportWorkspaceImage -> Bool # (/=) :: ImportWorkspaceImage -> ImportWorkspaceImage -> Bool #
Hashable ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods hashWithSalt :: Int -> ImportWorkspaceImage -> Int # hash :: ImportWorkspaceImage -> Int #
type AWSResponse ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage type AWSResponse ImportWorkspaceImage = ImportWorkspaceImageResponse
type Rep ImportWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage type Rep ImportWorkspaceImage = D1 ('MetaData "ImportWorkspaceImage" "Amazonka.WorkSpaces.ImportWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ImportWorkspaceImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Application))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "ec2ImageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "ingestionProcess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkspaceImageIngestionProcess) :: (S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "imageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newImportWorkspaceImage Source #

Arguments

:: Text	`$sel:ec2ImageId:ImportWorkspaceImage'`
-> WorkspaceImageIngestionProcess	`$sel:ingestionProcess:ImportWorkspaceImage'`
-> Text	`$sel:imageName:ImportWorkspaceImage'`
-> Text	`$sel:imageDescription:ImportWorkspaceImage'`
-> ImportWorkspaceImage

Create a value of ImportWorkspaceImage 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:applications:ImportWorkspaceImage', importWorkspaceImage_applications - If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

Although this parameter is an array, only one item is allowed at this time.

ImportWorkspaceImage, importWorkspaceImage_tags - The tags. Each WorkSpaces resource can have a maximum of 50 tags.

$sel:ec2ImageId:ImportWorkspaceImage', importWorkspaceImage_ec2ImageId - The identifier of the EC2 image.

$sel:ingestionProcess:ImportWorkspaceImage', importWorkspaceImage_ingestionProcess - The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

$sel:imageName:ImportWorkspaceImage', importWorkspaceImage_imageName - The name of the WorkSpace image.

$sel:imageDescription:ImportWorkspaceImage', importWorkspaceImage_imageDescription - The description of the WorkSpace image.

Request Lenses

importWorkspaceImage_applications :: Lens' ImportWorkspaceImage (Maybe (NonEmpty Application)) Source #

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

Although this parameter is an array, only one item is allowed at this time.

importWorkspaceImage_tags :: Lens' ImportWorkspaceImage (Maybe [Tag]) Source #

The tags. Each WorkSpaces resource can have a maximum of 50 tags.

importWorkspaceImage_ec2ImageId :: Lens' ImportWorkspaceImage Text Source #

The identifier of the EC2 image.

importWorkspaceImage_ingestionProcess :: Lens' ImportWorkspaceImage WorkspaceImageIngestionProcess Source #

The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

importWorkspaceImage_imageName :: Lens' ImportWorkspaceImage Text Source #

The name of the WorkSpace image.

importWorkspaceImage_imageDescription :: Lens' ImportWorkspaceImage Text Source #

The description of the WorkSpace image.

Destructuring the Response

data ImportWorkspaceImageResponse Source #

See: newImportWorkspaceImageResponse smart constructor.

Constructors

ImportWorkspaceImageResponse'
Fields imageId :: Maybe Text The identifier of the WorkSpace image. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Associated Types type Rep ImportWorkspaceImageResponse :: Type -> Type # Methods from :: ImportWorkspaceImageResponse -> Rep ImportWorkspaceImageResponse x # to :: Rep ImportWorkspaceImageResponse x -> ImportWorkspaceImageResponse #
Read ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods readsPrec :: Int -> ReadS ImportWorkspaceImageResponse # readList :: ReadS [ImportWorkspaceImageResponse] # readPrec :: ReadPrec ImportWorkspaceImageResponse # readListPrec :: ReadPrec [ImportWorkspaceImageResponse] #
Show ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods showsPrec :: Int -> ImportWorkspaceImageResponse -> ShowS # show :: ImportWorkspaceImageResponse -> String # showList :: [ImportWorkspaceImageResponse] -> ShowS #
NFData ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods rnf :: ImportWorkspaceImageResponse -> () #
Eq ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage Methods (==) :: ImportWorkspaceImageResponse -> ImportWorkspaceImageResponse -> Bool # (/=) :: ImportWorkspaceImageResponse -> ImportWorkspaceImageResponse -> Bool #
type Rep ImportWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.ImportWorkspaceImage type Rep ImportWorkspaceImageResponse = D1 ('MetaData "ImportWorkspaceImageResponse" "Amazonka.WorkSpaces.ImportWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ImportWorkspaceImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newImportWorkspaceImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportWorkspaceImageResponse'`
-> ImportWorkspaceImageResponse

Create a value of ImportWorkspaceImageResponse 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:

ImportWorkspaceImageResponse, importWorkspaceImageResponse_imageId - The identifier of the WorkSpace image.

$sel:httpStatus:ImportWorkspaceImageResponse', importWorkspaceImageResponse_httpStatus - The response's http status code.

Response Lenses

importWorkspaceImageResponse_imageId :: Lens' ImportWorkspaceImageResponse (Maybe Text) Source #

The identifier of the WorkSpace image.

importWorkspaceImageResponse_httpStatus :: Lens' ImportWorkspaceImageResponse Int Source #

The response's http status code.