#[non_exhaustive]pub struct GetStreamSessionOutput {Show 20 fields
pub arn: Option<String>,
pub description: Option<String>,
pub stream_group_id: Option<String>,
pub user_id: Option<String>,
pub status: Option<StreamSessionStatus>,
pub status_reason: Option<StreamSessionStatusReason>,
pub protocol: Option<Protocol>,
pub location: Option<String>,
pub signal_request: Option<String>,
pub signal_response: Option<String>,
pub connection_timeout_seconds: Option<i32>,
pub session_length_seconds: Option<i32>,
pub additional_launch_args: Option<Vec<String>>,
pub additional_environment_variables: Option<HashMap<String, String>>,
pub log_file_location_uri: Option<String>,
pub web_sdk_protocol_url: Option<String>,
pub last_updated_at: Option<DateTime>,
pub created_at: Option<DateTime>,
pub application_arn: Option<String>,
pub export_files_metadata: Option<ExportFilesMetadata>,
/* private fields */
}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.arn: Option<String>The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:\[AWS Region\]:\[AWS account\]:streamsession/\[stream group resource ID\]/\[stream session resource ID\].
description: Option<String>A human-readable label for the stream session. You can update this value at any time.
stream_group_id: Option<String>The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
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. A stream session is ready for a client to connect when in ACTIVE status.
-
ACTIVATING: The stream session is starting and preparing to stream. -
ACTIVE: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds(specified inStartStreamSession) from when the session reachesACTIVEstate 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 bySessionLengthSecondsinStartStreamSessionis 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 hasConnectionTimeoutSeconds(specified inStartStreamSession) from when the session reachesPENDING_CLIENT_RECONNECTIONstate 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 inPENDING_CLIENT_RECONNECTIONstate. -
TERMINATING: The stream session is ending. -
TERMINATED: The stream session has ended.
status_reason: Option<StreamSessionStatusReason>A short description of the reason the stream session is in ERROR status.
protocol: Option<Protocol>The data transfer protocol in use with the stream session.
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.
signal_request: Option<String>The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
signal_response: Option<String>The WebRTC answer string that the stream server generates in response to the SignalRequest.
connection_timeout_seconds: Option<i32>The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
session_length_seconds: Option<i32>The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
additional_launch_args: Option<Vec<String>>A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
additional_environment_variables: Option<HashMap<String, String>>A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
log_file_location_uri: Option<String>Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
web_sdk_protocol_url: Option<String>The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
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>The application streaming in this session.
This value is 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.
Implementations§
Source§impl GetStreamSessionOutput
impl GetStreamSessionOutput
Sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:\[AWS Region\]:\[AWS account\]:streamsession/\[stream group resource ID\]/\[stream session resource ID\].
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A human-readable label for the stream session. You can update this value at any time.
Sourcepub fn stream_group_id(&self) -> Option<&str>
pub fn stream_group_id(&self) -> Option<&str>
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
Sourcepub fn user_id(&self) -> Option<&str>
pub fn user_id(&self) -> Option<&str>
An opaque, unique identifier for an end-user, defined by the developer.
Sourcepub fn status(&self) -> Option<&StreamSessionStatus>
pub fn status(&self) -> Option<&StreamSessionStatus>
The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.
-
ACTIVATING: The stream session is starting and preparing to stream. -
ACTIVE: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds(specified inStartStreamSession) from when the session reachesACTIVEstate 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 bySessionLengthSecondsinStartStreamSessionis 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 hasConnectionTimeoutSeconds(specified inStartStreamSession) from when the session reachesPENDING_CLIENT_RECONNECTIONstate 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 inPENDING_CLIENT_RECONNECTIONstate. -
TERMINATING: The stream session is ending. -
TERMINATED: The stream session has ended.
Sourcepub fn status_reason(&self) -> Option<&StreamSessionStatusReason>
pub fn status_reason(&self) -> Option<&StreamSessionStatusReason>
A short description of the reason the stream session is in ERROR status.
Sourcepub fn protocol(&self) -> Option<&Protocol>
pub fn protocol(&self) -> Option<&Protocol>
The data transfer protocol in use with the stream session.
Sourcepub fn location(&self) -> Option<&str>
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.
Sourcepub fn signal_request(&self) -> Option<&str>
pub fn signal_request(&self) -> Option<&str>
The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
Sourcepub fn signal_response(&self) -> Option<&str>
pub fn signal_response(&self) -> Option<&str>
The WebRTC answer string that the stream server generates in response to the SignalRequest.
Sourcepub fn connection_timeout_seconds(&self) -> Option<i32>
pub fn connection_timeout_seconds(&self) -> Option<i32>
The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
Sourcepub fn session_length_seconds(&self) -> Option<i32>
pub fn session_length_seconds(&self) -> Option<i32>
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
Sourcepub fn additional_launch_args(&self) -> &[String]
pub fn additional_launch_args(&self) -> &[String]
A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_launch_args.is_none().
Sourcepub fn additional_environment_variables(
&self,
) -> Option<&HashMap<String, String>>
pub fn additional_environment_variables( &self, ) -> Option<&HashMap<String, String>>
A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
Sourcepub fn log_file_location_uri(&self) -> Option<&str>
pub fn log_file_location_uri(&self) -> Option<&str>
Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
Sourcepub fn web_sdk_protocol_url(&self) -> Option<&str>
pub fn web_sdk_protocol_url(&self) -> Option<&str>
The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
Sourcepub fn last_updated_at(&self) -> Option<&DateTime>
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).
Sourcepub fn created_at(&self) -> Option<&DateTime>
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).
Sourcepub fn application_arn(&self) -> Option<&str>
pub fn application_arn(&self) -> Option<&str>
The application streaming in this session.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Sourcepub fn export_files_metadata(&self) -> Option<&ExportFilesMetadata>
pub fn export_files_metadata(&self) -> Option<&ExportFilesMetadata>
Provides details about the stream session's exported files.
Source§impl GetStreamSessionOutput
impl GetStreamSessionOutput
Sourcepub fn builder() -> GetStreamSessionOutputBuilder
pub fn builder() -> GetStreamSessionOutputBuilder
Creates a new builder-style object to manufacture GetStreamSessionOutput.
Trait Implementations§
Source§impl Clone for GetStreamSessionOutput
impl Clone for GetStreamSessionOutput
Source§fn clone(&self) -> GetStreamSessionOutput
fn clone(&self) -> GetStreamSessionOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetStreamSessionOutput
impl Debug for GetStreamSessionOutput
Source§impl PartialEq for GetStreamSessionOutput
impl PartialEq for GetStreamSessionOutput
Source§impl RequestId for GetStreamSessionOutput
impl RequestId for GetStreamSessionOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for GetStreamSessionOutput
Auto Trait Implementations§
impl Freeze for GetStreamSessionOutput
impl RefUnwindSafe for GetStreamSessionOutput
impl Send for GetStreamSessionOutput
impl Sync for GetStreamSessionOutput
impl Unpin for GetStreamSessionOutput
impl UnwindSafe for GetStreamSessionOutput
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);