Struct StreamSessionSummary 

#[non_exhaustive]
pub struct StreamSessionSummary {
    pub arn: Option<String>,
    pub user_id: Option<String>,
    pub status: Option<StreamSessionStatus>,
    pub protocol: Option<Protocol>,
    pub last_updated_at: Option<DateTime>,
    pub created_at: Option<DateTime>,
    pub application_arn: Option<String>,
    pub export_files_metadata: Option<ExportFilesMetadata>,
    pub location: Option<String>,
}

Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567.

user_id: Option<String>

An opaque, unique identifier for an end-user, defined by the developer.

status: Option<StreamSessionStatus>

The current status of the stream session resource.

• ACTIVATING: The stream session is starting and preparing to stream.

• ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.

• CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.

• ERROR: The stream session failed to activate.

• PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.

• RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.

• TERMINATING: The stream session is ending.

• TERMINATED: The stream session has ended.

protocol: Option<Protocol>

The data transfer protocol in use with the stream session.

last_updated_at: Option<DateTime>

A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

created_at: Option<DateTime>

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

application_arn: Option<String>

An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

export_files_metadata: Option<ExportFilesMetadata>

Provides details about the stream session's exported files.

location: Option<String>

The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

Implementations

impl StreamSessionSummary

pub fn arn(&self) -> Option<&str>

An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567.

pub fn user_id(&self) -> Option<&str>

An opaque, unique identifier for an end-user, defined by the developer.

pub fn status(&self) -> Option<&StreamSessionStatus>

The current status of the stream session resource.

• ACTIVATING: The stream session is starting and preparing to stream.

• ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.

• CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.

• ERROR: The stream session failed to activate.

• PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.

• RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.

• TERMINATING: The stream session is ending.

• TERMINATED: The stream session has ended.

pub fn protocol(&self) -> Option<&Protocol>

The data transfer protocol in use with the stream session.

pub fn last_updated_at(&self) -> Option<&DateTime>

A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

pub fn created_at(&self) -> Option<&DateTime>

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

pub fn application_arn(&self) -> Option<&str>

An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

pub fn export_files_metadata(&self) -> Option<&ExportFilesMetadata>

Provides details about the stream session's exported files.

pub fn location(&self) -> Option<&str>

The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

impl StreamSessionSummary

pub fn builder() -> StreamSessionSummaryBuilder

Creates a new builder-style object to manufacture StreamSessionSummary.

Trait Implementations

impl Clone for StreamSessionSummary

fn clone(&self) -> StreamSessionSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSessionSummary

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

Formats the value using the given formatter.

impl PartialEq for StreamSessionSummary

fn eq(&self, other: &StreamSessionSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamSessionSummary