Struct aws_sdk_appstream::client::fluent_builders::DescribeSessions

pub struct DescribeSessions { /* private fields */ }

Fluent builder constructing a request to DescribeSessions.

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Implementations

impl DescribeSessions

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeSessions, AwsResponseRetryClassifier>, SdkError<DescribeSessionsError>>

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<DescribeSessionsOutput, SdkError<DescribeSessionsError>>

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 stack_name(self, input: impl Into<String>) -> Self

The name of the stack. This value is case-sensitive.

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

The name of the stack. This value is case-sensitive.

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

The name of the fleet. This value is case-sensitive.

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

The name of the fleet. This value is case-sensitive.

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

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

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

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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

The size of each page of results. The default value is 20 and the maximum value is 50.

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

The size of each page of results. The default value is 20 and the maximum value is 50.

pub fn authentication_type(self, input: AuthenticationType) -> Self

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

Trait Implementations

impl Clone for DescribeSessions

fn clone(&self) -> DescribeSessions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSessions

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

Formats the value using the given formatter.