1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeSessions`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stack_name(impl Into<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_stack_name):<br>required: **true**<br><p>The name of the stack. This value is case-sensitive.</p><br>
    ///   - [`fleet_name(impl Into<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::fleet_name) / [`set_fleet_name(Option<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_fleet_name):<br>required: **true**<br><p>The name of the fleet. This value is case-sensitive.</p><br>
    ///   - [`user_id(impl Into<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_user_id):<br>required: **false**<br><p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    ///   - [`limit(i32)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_limit):<br>required: **false**<br><p>The size of each page of results. The default value is 20 and the maximum value is 50.</p><br>
    ///   - [`authentication_type(AuthenticationType)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::authentication_type) / [`set_authentication_type(Option<AuthenticationType>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_authentication_type):<br>required: **false**<br><p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::set_instance_id):<br>required: **false**<br><p>The identifier for the instance hosting the session.</p><br>
    /// - On success, responds with [`DescribeSessionsOutput`](crate::operation::describe_sessions::DescribeSessionsOutput) with field(s):
    ///   - [`sessions(Option<Vec::<Session>>)`](crate::operation::describe_sessions::DescribeSessionsOutput::sessions): <p>Information about the streaming sessions.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_sessions::DescribeSessionsOutput::next_token): <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
    /// - On failure, responds with [`SdkError<DescribeSessionsError>`](crate::operation::describe_sessions::DescribeSessionsError)
    pub fn describe_sessions(&self) -> crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder {
        crate::operation::describe_sessions::builders::DescribeSessionsFluentBuilder::new(self.handle.clone())
    }
}