aws_sdk_nimble/client/stop_streaming_session.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 [`StopStreamingSession`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`client_token(impl Into<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.</p><br>
7 /// - [`session_id(impl Into<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The streaming session ID for the <code>StopStreamingSessionRequest</code>.</p><br>
8 /// - [`studio_id(impl Into<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::studio_id) / [`set_studio_id(Option<String>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::set_studio_id):<br>required: **true**<br><p>The studioId for the StopStreamingSessionRequest.</p><br>
9 /// - [`volume_retention_mode(VolumeRetentionMode)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::volume_retention_mode) / [`set_volume_retention_mode(Option<VolumeRetentionMode>)`](crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::set_volume_retention_mode):<br>required: **false**<br><p>Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.</p><br>
10 /// - On success, responds with [`StopStreamingSessionOutput`](crate::operation::stop_streaming_session::StopStreamingSessionOutput) with field(s):
11 /// - [`session(Option<StreamingSession>)`](crate::operation::stop_streaming_session::StopStreamingSessionOutput::session): <p>A streaming session is a virtual workstation created using a particular launch profile.</p>
12 /// - On failure, responds with [`SdkError<StopStreamingSessionError>`](crate::operation::stop_streaming_session::StopStreamingSessionError)
13 pub fn stop_streaming_session(&self) -> crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder {
14 crate::operation::stop_streaming_session::builders::StopStreamingSessionFluentBuilder::new(self.handle.clone())
15 }
16}