Struct aws_sdk_athena::client::fluent_builders::StartSession

pub struct StartSession { /* private fields */ }

Fluent builder constructing a request to StartSession.

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Implementations

impl StartSession

pub async fn customize( self ) -> Result<CustomizableOperation<StartSession, AwsResponseRetryClassifier>, SdkError<StartSessionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send( self ) -> Result<StartSessionOutput, SdkError<StartSessionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn description(self, input: impl Into<String>) -> Self

The session description.

pub fn set_description(self, input: Option<String>) -> Self

The session description.

pub fn work_group(self, input: impl Into<String>) -> Self

The workgroup to which the session belongs.

pub fn set_work_group(self, input: Option<String>) -> Self

The workgroup to which the session belongs.

pub fn engine_configuration(self, input: EngineConfiguration) -> Self

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

pub fn set_engine_configuration(self, input: Option<EngineConfiguration>) -> Self

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

pub fn notebook_version(self, input: impl Into<String>) -> Self

The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

pub fn set_notebook_version(self, input: Option<String>) -> Self

The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

pub fn session_idle_timeout_in_minutes(self, input: i32) -> Self

The idle timeout in minutes for the session.

pub fn set_session_idle_timeout_in_minutes(self, input: Option<i32>) -> Self

The idle timeout in minutes for the session.

pub fn client_request_token(self, input: impl Into<String>) -> Self

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

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.

pub fn set_client_request_token(self, input: Option<String>) -> Self

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

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.

Trait Implementations

impl Clone for StartSession

fn clone(&self) -> StartSession

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.