aws_sdk_appstream/client/create_updated_image.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateUpdatedImage`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`existing_image_name(impl Into<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::existing_image_name) / [`set_existing_image_name(Option<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_existing_image_name):<br>required: **true**<br><p>The name of the image to update.</p><br>
7 /// - [`new_image_name(impl Into<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::new_image_name) / [`set_new_image_name(Option<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_new_image_name):<br>required: **true**<br><p>The name of the new image. The name must be unique within the AWS account and Region.</p><br>
8 /// - [`new_image_description(impl Into<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::new_image_description) / [`set_new_image_description(Option<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_new_image_description):<br>required: **false**<br><p>The description to display for the new image.</p><br>
9 /// - [`new_image_display_name(impl Into<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::new_image_display_name) / [`set_new_image_display_name(Option<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_new_image_display_name):<br>required: **false**<br><p>The name to display for the new image.</p><br>
10 /// - [`new_image_tags(impl Into<String>, impl Into<String>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::new_image_tags) / [`set_new_image_tags(Option<HashMap::<String, String>>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_new_image_tags):<br>required: **false**<br><p>The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:</p> <p>_ . : / = + \ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p><br>
11 /// - [`dry_run(bool)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::set_dry_run):<br>required: **false**<br><p>Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to <code>true</code>, AppStream 2.0 displays whether image updates are available. If this value is set to <code>false</code>, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.</p><br>
12 /// - On success, responds with [`CreateUpdatedImageOutput`](crate::operation::create_updated_image::CreateUpdatedImageOutput) with field(s):
13 /// - [`image(Option<Image>)`](crate::operation::create_updated_image::CreateUpdatedImageOutput::image): <p>Describes an image.</p>
14 /// - [`can_update_image(Option<bool>)`](crate::operation::create_updated_image::CreateUpdatedImageOutput::can_update_image): <p>Indicates whether a new image can be created.</p>
15 /// - On failure, responds with [`SdkError<CreateUpdatedImageError>`](crate::operation::create_updated_image::CreateUpdatedImageError)
16 pub fn create_updated_image(&self) -> crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder {
17 crate::operation::create_updated_image::builders::CreateUpdatedImageFluentBuilder::new(self.handle.clone())
18 }
19}