Struct aws_sdk_appstream::types::Session
source · #[non_exhaustive]pub struct Session {
pub id: Option<String>,
pub user_id: Option<String>,
pub stack_name: Option<String>,
pub fleet_name: Option<String>,
pub state: Option<SessionState>,
pub connection_state: Option<SessionConnectionState>,
pub start_time: Option<DateTime>,
pub max_expiration_time: Option<DateTime>,
pub authentication_type: Option<AuthenticationType>,
pub network_access_configuration: Option<NetworkAccessConfiguration>,
pub instance_id: Option<String>,
}
Expand description
Describes a streaming session.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<String>
The identifier of the streaming session.
user_id: Option<String>
The identifier of the user for whom the session was created.
stack_name: Option<String>
The name of the stack for the streaming session.
fleet_name: Option<String>
The name of the fleet for the streaming session.
state: Option<SessionState>
The current state of the streaming session.
connection_state: Option<SessionConnectionState>
Specifies whether a user is connected to the streaming session.
start_time: Option<DateTime>
The time when a streaming instance is dedicated for the user.
max_expiration_time: Option<DateTime>
The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds
value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime
, when the DisconnectTimeOutInSeconds
elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds
elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
authentication_type: Option<AuthenticationType>
The authentication method. The user is authenticated using a streaming URL (API
) or SAML 2.0 federation (SAML
).
network_access_configuration: Option<NetworkAccessConfiguration>
The network details for the streaming session.
instance_id: Option<String>
The identifier for the instance hosting the session.
Implementations§
source§impl Session
impl Session
sourcepub fn user_id(&self) -> Option<&str>
pub fn user_id(&self) -> Option<&str>
The identifier of the user for whom the session was created.
sourcepub fn stack_name(&self) -> Option<&str>
pub fn stack_name(&self) -> Option<&str>
The name of the stack for the streaming session.
sourcepub fn fleet_name(&self) -> Option<&str>
pub fn fleet_name(&self) -> Option<&str>
The name of the fleet for the streaming session.
sourcepub fn state(&self) -> Option<&SessionState>
pub fn state(&self) -> Option<&SessionState>
The current state of the streaming session.
sourcepub fn connection_state(&self) -> Option<&SessionConnectionState>
pub fn connection_state(&self) -> Option<&SessionConnectionState>
Specifies whether a user is connected to the streaming session.
sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The time when a streaming instance is dedicated for the user.
sourcepub fn max_expiration_time(&self) -> Option<&DateTime>
pub fn max_expiration_time(&self) -> Option<&DateTime>
The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds
value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime
, when the DisconnectTimeOutInSeconds
elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds
elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
sourcepub fn authentication_type(&self) -> Option<&AuthenticationType>
pub fn authentication_type(&self) -> Option<&AuthenticationType>
The authentication method. The user is authenticated using a streaming URL (API
) or SAML 2.0 federation (SAML
).
sourcepub fn network_access_configuration(
&self
) -> Option<&NetworkAccessConfiguration>
pub fn network_access_configuration( &self ) -> Option<&NetworkAccessConfiguration>
The network details for the streaming session.
sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The identifier for the instance hosting the session.
Trait Implementations§
source§impl PartialEq for Session
impl PartialEq for Session
impl StructuralPartialEq for Session
Auto Trait Implementations§
impl Freeze for Session
impl RefUnwindSafe for Session
impl Send for Session
impl Sync for Session
impl Unpin for Session
impl UnwindSafe for Session
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more