aws_sdk_athena/operation/start_session/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_session::_start_session_output::StartSessionOutputBuilder;
3
4pub use crate::operation::start_session::_start_session_input::StartSessionInputBuilder;
5
6impl crate::operation::start_session::builders::StartSessionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::start_session::StartSessionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_session::StartSessionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_session();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartSession`.
24///
25/// <p>Creates a session for running calculations within a workgroup. The session is ready when it reaches an <code>IDLE</code> state.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct StartSessionFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::start_session::builders::StartSessionInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::start_session::StartSessionOutput,
35        crate::operation::start_session::StartSessionError,
36    > for StartSessionFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::start_session::StartSessionOutput,
44            crate::operation::start_session::StartSessionError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl StartSessionFluentBuilder {
51    /// Creates a new `StartSessionFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the StartSession as a reference.
60    pub fn as_input(&self) -> &crate::operation::start_session::builders::StartSessionInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::start_session::StartSessionOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::start_session::StartSessionError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::start_session::StartSession::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::start_session::StartSession::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::start_session::StartSessionOutput,
97        crate::operation::start_session::StartSessionError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The session description.</p>
112    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.description(input.into());
114        self
115    }
116    /// <p>The session description.</p>
117    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_description(input);
119        self
120    }
121    /// <p>The session description.</p>
122    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_description()
124    }
125    /// <p>The workgroup to which the session belongs.</p>
126    pub fn work_group(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.work_group(input.into());
128        self
129    }
130    /// <p>The workgroup to which the session belongs.</p>
131    pub fn set_work_group(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_work_group(input);
133        self
134    }
135    /// <p>The workgroup to which the session belongs.</p>
136    pub fn get_work_group(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_work_group()
138    }
139    /// <p>Contains engine data processing unit (DPU) configuration settings and parameter mappings.</p>
140    pub fn engine_configuration(mut self, input: crate::types::EngineConfiguration) -> Self {
141        self.inner = self.inner.engine_configuration(input);
142        self
143    }
144    /// <p>Contains engine data processing unit (DPU) configuration settings and parameter mappings.</p>
145    pub fn set_engine_configuration(mut self, input: ::std::option::Option<crate::types::EngineConfiguration>) -> Self {
146        self.inner = self.inner.set_engine_configuration(input);
147        self
148    }
149    /// <p>Contains engine data processing unit (DPU) configuration settings and parameter mappings.</p>
150    pub fn get_engine_configuration(&self) -> &::std::option::Option<crate::types::EngineConfiguration> {
151        self.inner.get_engine_configuration()
152    }
153    /// <p>The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is <code>Athena notebook version 1</code>. If you specify a value for <code>NotebookVersion</code>, you must also specify a value for <code>NotebookId</code>. See <code>EngineConfiguration$AdditionalConfigs</code>.</p>
154    pub fn notebook_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.notebook_version(input.into());
156        self
157    }
158    /// <p>The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is <code>Athena notebook version 1</code>. If you specify a value for <code>NotebookVersion</code>, you must also specify a value for <code>NotebookId</code>. See <code>EngineConfiguration$AdditionalConfigs</code>.</p>
159    pub fn set_notebook_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_notebook_version(input);
161        self
162    }
163    /// <p>The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is <code>Athena notebook version 1</code>. If you specify a value for <code>NotebookVersion</code>, you must also specify a value for <code>NotebookId</code>. See <code>EngineConfiguration$AdditionalConfigs</code>.</p>
164    pub fn get_notebook_version(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_notebook_version()
166    }
167    /// <p>The idle timeout in minutes for the session.</p>
168    pub fn session_idle_timeout_in_minutes(mut self, input: i32) -> Self {
169        self.inner = self.inner.session_idle_timeout_in_minutes(input);
170        self
171    }
172    /// <p>The idle timeout in minutes for the session.</p>
173    pub fn set_session_idle_timeout_in_minutes(mut self, input: ::std::option::Option<i32>) -> Self {
174        self.inner = self.inner.set_session_idle_timeout_in_minutes(input);
175        self
176    }
177    /// <p>The idle timeout in minutes for the session.</p>
178    pub fn get_session_idle_timeout_in_minutes(&self) -> &::std::option::Option<i32> {
179        self.inner.get_session_idle_timeout_in_minutes()
180    }
181    /// <p>A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another <code>StartSessionRequest</code> is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.</p><important>
182    /// <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p>
183    /// </important>
184    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185        self.inner = self.inner.client_request_token(input.into());
186        self
187    }
188    /// <p>A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another <code>StartSessionRequest</code> is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.</p><important>
189    /// <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p>
190    /// </important>
191    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
192        self.inner = self.inner.set_client_request_token(input);
193        self
194    }
195    /// <p>A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another <code>StartSessionRequest</code> is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.</p><important>
196    /// <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p>
197    /// </important>
198    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
199        self.inner.get_client_request_token()
200    }
201}
aws_sdk_athena/operation/start_session/builders.rs

aws_sdk_athena/operation/start_session/
builders.rs
