Struct aws_sdk_athena::client::fluent_builders::ListSessions

pub struct ListSessions { /* private fields */ }

Fluent builder constructing a request to ListSessions.

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Implementations

impl ListSessions

pub async fn customize( self ) -> Result<CustomizableOperation<ListSessions, AwsResponseRetryClassifier>, SdkError<ListSessionsError>>

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<ListSessionsOutput, SdkError<ListSessionsError>>

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 into_paginator(self) -> ListSessionsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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 state_filter(self, input: SessionState) -> Self

A filter for a specific session state. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

pub fn set_state_filter(self, input: Option<SessionState>) -> Self

A filter for a specific session state. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

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

The maximum number of sessions to return.

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

The maximum number of sessions to return.

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

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Trait Implementations

impl Clone for ListSessions

fn clone(&self) -> ListSessions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListSessions

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

Formats the value using the given formatter.