aws_sdk_workspaces/client/

import_workspace_image.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ImportWorkspaceImage`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`ec2_image_id(impl Into<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::ec2_image_id) / [`set_ec2_image_id(Option<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_ec2_image_id):<br>required: **true**<br><p>The identifier of the EC2 image.</p><br>
    ///   - [`ingestion_process(WorkspaceImageIngestionProcess)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::ingestion_process) / [`set_ingestion_process(Option<WorkspaceImageIngestionProcess>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_ingestion_process):<br>required: **true**<br><p>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, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p> <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p><note>  <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p> </note><br>
    ///   - [`image_name(impl Into<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_image_name):<br>required: **true**<br><p>The name of the WorkSpace image.</p><br>
    ///   - [`image_description(impl Into<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::image_description) / [`set_image_description(Option<String>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_image_description):<br>required: **true**<br><p>The description of the WorkSpace image.</p><br>
    ///   - [`tags(Tag)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_tags):<br>required: **false**<br><p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p><br>
    ///   - [`applications(Application)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::applications) / [`set_applications(Option<Vec::<Application>>)`](crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::set_applications):<br>required: **false**<br><p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p><note>  <ul>   <li>    <p>Although this parameter is an array, only one item is allowed at this time.</p></li>   <li>    <p>During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only <code>Microsoft_Office_2019</code>. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.</p></li>  </ul> </note><br>
    /// - On success, responds with [`ImportWorkspaceImageOutput`](crate::operation::import_workspace_image::ImportWorkspaceImageOutput) with field(s):
    ///   - [`image_id(Option<String>)`](crate::operation::import_workspace_image::ImportWorkspaceImageOutput::image_id): <p>The identifier of the WorkSpace image.</p>
    /// - On failure, responds with [`SdkError<ImportWorkspaceImageError>`](crate::operation::import_workspace_image::ImportWorkspaceImageError)
    pub fn import_workspace_image(&self) -> crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder {
        crate::operation::import_workspace_image::builders::ImportWorkspaceImageFluentBuilder::new(self.handle.clone())
    }
}