aws_sdk_appstream/client/
create_streaming_url.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 [`CreateStreamingURL`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_name(impl Into<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_stack_name):<br>required: **true**<br><p>The name of the stack.</p><br>
7    ///   - [`fleet_name(impl Into<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::fleet_name) / [`set_fleet_name(Option<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_fleet_name):<br>required: **true**<br><p>The name of the fleet.</p><br>
8    ///   - [`user_id(impl Into<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_user_id):<br>required: **true**<br><p>The identifier of the user.</p><br>
9    ///   - [`application_id(impl Into<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_application_id):<br>required: **false**<br><p>The name of the application to launch after the session starts. This is the name that you specified as <b>Name</b> in the Image Assistant. If your fleet is enabled for the <b>Desktop</b> stream view, you can also choose to launch directly to the operating system desktop. To do so, specify <b>Desktop</b>.</p><br>
10    ///   - [`validity(i64)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::validity) / [`set_validity(Option<i64>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_validity):<br>required: **false**<br><p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p><br>
11    ///   - [`session_context(impl Into<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::session_context) / [`set_session_context(Option<String>)`](crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::set_session_context):<br>required: **false**<br><p>The session context. For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters">Session Context</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p><br>
12    /// - On success, responds with [`CreateStreamingUrlOutput`](crate::operation::create_streaming_url::CreateStreamingUrlOutput) with field(s):
13    ///   - [`streaming_url(Option<String>)`](crate::operation::create_streaming_url::CreateStreamingUrlOutput::streaming_url): <p>The URL to start the AppStream 2.0 streaming session.</p>
14    ///   - [`expires(Option<DateTime>)`](crate::operation::create_streaming_url::CreateStreamingUrlOutput::expires): <p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>
15    /// - On failure, responds with [`SdkError<CreateStreamingURLError>`](crate::operation::create_streaming_url::CreateStreamingURLError)
16    pub fn create_streaming_url(&self) -> crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder {
17        crate::operation::create_streaming_url::builders::CreateStreamingURLFluentBuilder::new(self.handle.clone())
18    }
19}