libZSservicesZSamazonka-workspacesZSamazonka-workspaces
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkSpaces.ImportWorkspaceImage

Description

Imports the specified Windows 10 Bring Your Own License (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

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 or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP.

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

  • imageName :: Text

    The name of the WorkSpace image.

  • imageDescription :: Text

    The description of the WorkSpace image.

Instances

Instances details
Eq ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Read ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Show ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Generic ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Associated Types

type Rep ImportWorkspaceImage :: Type -> Type #

NFData ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Methods

rnf :: ImportWorkspaceImage -> () #

Hashable ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

ToJSON ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

AWSRequest ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Associated Types

type AWSResponse ImportWorkspaceImage #

ToHeaders ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

ToPath ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

ToQuery ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

type Rep ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

type Rep ImportWorkspaceImage = D1 ('MetaData "ImportWorkspaceImage" "Amazonka.WorkSpaces.ImportWorkspaceImage" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" '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)))))
type AWSResponse ImportWorkspaceImage Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

newImportWorkspaceImage Source #

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.

$sel:tags: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 or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP.

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

$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_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 or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP.

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

Destructuring the Response

data ImportWorkspaceImageResponse Source #

See: newImportWorkspaceImageResponse smart constructor.

Constructors

ImportWorkspaceImageResponse' 

Fields

Instances

Instances details
Eq ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Read ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Show ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Generic ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

Associated Types

type Rep ImportWorkspaceImageResponse :: Type -> Type #

NFData ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

type Rep ImportWorkspaceImageResponse Source # 
Instance details

Defined in Amazonka.WorkSpaces.ImportWorkspaceImage

type Rep ImportWorkspaceImageResponse = D1 ('MetaData "ImportWorkspaceImageResponse" "Amazonka.WorkSpaces.ImportWorkspaceImage" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" '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 #

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:

$sel:imageId:ImportWorkspaceImageResponse', importWorkspaceImageResponse_imageId - The identifier of the WorkSpace image.

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

Response Lenses