pub struct DescribeSessions { /* private fields */ }
Expand description

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

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.

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

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

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

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

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

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

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.

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.

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

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

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.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more