/AWS1/CL_GMZGETSTREAMSESSOUT

GetStreamSessionOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/GMZARN /AWS1/GMZARN

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].

iv_description TYPE /AWS1/GMZDESCRIPTION /AWS1/GMZDESCRIPTION

A human-readable label for the stream session. You can update this value at any time.

iv_streamgroupid TYPE /AWS1/GMZID /AWS1/GMZID

The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.

iv_userid TYPE /AWS1/GMZUSERID /AWS1/GMZUSERID

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

iv_status TYPE /AWS1/GMZSTREAMSESSIONSTATUS /AWS1/GMZSTREAMSESSIONSTATUS

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 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. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

• 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.

iv_statusreason TYPE /AWS1/GMZSTREAMSESSSTATUSRSN /AWS1/GMZSTREAMSESSSTATUSRSN

A short description of the reason the stream session is in ERROR status or TERMINATED status.

ERROR status reasons:

• applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

• internalError: An internal service error occurred. Start a new stream session to continue streaming.

• invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

• placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

TERMINATED status reasons:

• apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

• applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

• connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

• idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

• maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

• reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

iv_protocol TYPE /AWS1/GMZPROTOCOL /AWS1/GMZPROTOCOL

The data transfer protocol in use with the stream session.

iv_location TYPE /AWS1/GMZLOCATIONNAME /AWS1/GMZLOCATIONNAME

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.

iv_signalrequest TYPE /AWS1/GMZSIGNALREQUEST /AWS1/GMZSIGNALREQUEST

The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.

iv_signalresponse TYPE /AWS1/GMZSIGNALRESPONSE /AWS1/GMZSIGNALRESPONSE

The WebRTC answer string that the stream server generates in response to the SignalRequest.

iv_connectiontimeoutseconds TYPE /AWS1/GMZCONNTIMEOUTSECONDS /AWS1/GMZCONNTIMEOUTSECONDS

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.

iv_sessionlengthseconds TYPE /AWS1/GMZSESSIONLENGTHSECONDS /AWS1/GMZSESSIONLENGTHSECONDS

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.

it_additionallaunchargs TYPE /AWS1/CL_GMZGAMELAUNCHARGLST_W=>TT_GAMELAUNCHARGLIST TT_GAMELAUNCHARGLIST

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.

it_addlenvironmentvariables TYPE /AWS1/CL_GMZENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES

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.

io_performancestatsconf TYPE REF TO /AWS1/CL_GMZPERFRMANCESTATSC00 /AWS1/CL_GMZPERFRMANCESTATSC00

The performance stats configuration for the stream session

iv_logfilelocationuri TYPE /AWS1/GMZFILELOCATIONURI /AWS1/GMZFILELOCATIONURI

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.

iv_websdkprotocolurl TYPE /AWS1/GMZWEBSDKPROTOCOLURL /AWS1/GMZWEBSDKPROTOCOLURL

The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.

iv_lastupdatedat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP

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).

iv_createdat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP

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).

iv_applicationarn TYPE /AWS1/GMZARN /AWS1/GMZARN

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.

io_exportfilesmetadata TYPE REF TO /AWS1/CL_GMZEXPORTFILESMET /AWS1/CL_GMZEXPORTFILESMET

Provides details about the stream session's exported files.

---

Queryable Attributes

Arn

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].

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

Description

A human-readable label for the stream session. You can update this value at any time.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

StreamGroupId

The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.

Accessible with the following methods

Method	Description
GET_STREAMGROUPID()	Getter for STREAMGROUPID, with configurable default
ASK_STREAMGROUPID()	Getter for STREAMGROUPID w/ exceptions if field has no value
HAS_STREAMGROUPID()	Determine if STREAMGROUPID has a value

UserId

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

Accessible with the following methods

Method	Description
GET_USERID()	Getter for USERID, with configurable default
ASK_USERID()	Getter for USERID w/ exceptions if field has no value
HAS_USERID()	Determine if USERID has a value

Status

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 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. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

• 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.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

StatusReason

A short description of the reason the stream session is in ERROR status or TERMINATED status.

ERROR status reasons:

• applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

• internalError: An internal service error occurred. Start a new stream session to continue streaming.

• invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

• placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

TERMINATED status reasons:

• apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

• applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

• connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

• idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

• maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

• reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

Accessible with the following methods

Method	Description
GET_STATUSREASON()	Getter for STATUSREASON, with configurable default
ASK_STATUSREASON()	Getter for STATUSREASON w/ exceptions if field has no value
HAS_STATUSREASON()	Determine if STATUSREASON has a value

Protocol

The data transfer protocol in use with the stream session.

Accessible with the following methods

Method	Description
GET_PROTOCOL()	Getter for PROTOCOL, with configurable default
ASK_PROTOCOL()	Getter for PROTOCOL w/ exceptions if field has no value
HAS_PROTOCOL()	Determine if PROTOCOL has a value

Location

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.

Accessible with the following methods

Method	Description
GET_LOCATION()	Getter for LOCATION, with configurable default
ASK_LOCATION()	Getter for LOCATION w/ exceptions if field has no value
HAS_LOCATION()	Determine if LOCATION has a value

SignalRequest

The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.

Accessible with the following methods

Method	Description
GET_SIGNALREQUEST()	Getter for SIGNALREQUEST, with configurable default
ASK_SIGNALREQUEST()	Getter for SIGNALREQUEST w/ exceptions if field has no value
HAS_SIGNALREQUEST()	Determine if SIGNALREQUEST has a value

SignalResponse

The WebRTC answer string that the stream server generates in response to the SignalRequest.

Accessible with the following methods

Method	Description
GET_SIGNALRESPONSE()	Getter for SIGNALRESPONSE, with configurable default
ASK_SIGNALRESPONSE()	Getter for SIGNALRESPONSE w/ exceptions if field has no valu
HAS_SIGNALRESPONSE()	Determine if SIGNALRESPONSE has a value

ConnectionTimeoutSeconds

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.

Accessible with the following methods

Method	Description
GET_CONNECTIONTIMEOUTSECONDS()	Getter for CONNECTIONTIMEOUTSECONDS, with configurable defau
ASK_CONNECTIONTIMEOUTSECONDS()	Getter for CONNECTIONTIMEOUTSECONDS w/ exceptions if field h
HAS_CONNECTIONTIMEOUTSECONDS()	Determine if CONNECTIONTIMEOUTSECONDS has a value

SessionLengthSeconds

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.

Accessible with the following methods

Method	Description
GET_SESSIONLENGTHSECONDS()	Getter for SESSIONLENGTHSECONDS, with configurable default
ASK_SESSIONLENGTHSECONDS()	Getter for SESSIONLENGTHSECONDS w/ exceptions if field has n
HAS_SESSIONLENGTHSECONDS()	Determine if SESSIONLENGTHSECONDS has a value

AdditionalLaunchArgs

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.

Accessible with the following methods

Method	Description
GET_ADDITIONALLAUNCHARGS()	Getter for ADDITIONALLAUNCHARGS, with configurable default
ASK_ADDITIONALLAUNCHARGS()	Getter for ADDITIONALLAUNCHARGS w/ exceptions if field has n
HAS_ADDITIONALLAUNCHARGS()	Determine if ADDITIONALLAUNCHARGS has a value

AdditionalEnvironmentVariables

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.

Accessible with the following methods

Method	Description
GET_ADDLENVIRONMENTVARIABLES()	Getter for ADDLENVIRONMENTVARIABLES, with configurable defau
ASK_ADDLENVIRONMENTVARIABLES()	Getter for ADDLENVIRONMENTVARIABLES w/ exceptions if field h
HAS_ADDLENVIRONMENTVARIABLES()	Determine if ADDLENVIRONMENTVARIABLES has a value

PerformanceStatsConfiguration

The performance stats configuration for the stream session

Accessible with the following methods

Method	Description
GET_PERFORMANCESTATSCONF()	Getter for PERFORMANCESTATSCONF

LogFileLocationUri

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.

Accessible with the following methods

Method	Description
GET_LOGFILELOCATIONURI()	Getter for LOGFILELOCATIONURI, with configurable default
ASK_LOGFILELOCATIONURI()	Getter for LOGFILELOCATIONURI w/ exceptions if field has no
HAS_LOGFILELOCATIONURI()	Determine if LOGFILELOCATIONURI has a value

WebSdkProtocolUrl

The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.

Accessible with the following methods

Method	Description
GET_WEBSDKPROTOCOLURL()	Getter for WEBSDKPROTOCOLURL, with configurable default
ASK_WEBSDKPROTOCOLURL()	Getter for WEBSDKPROTOCOLURL w/ exceptions if field has no v
HAS_WEBSDKPROTOCOLURL()	Determine if WEBSDKPROTOCOLURL has a value

LastUpdatedAt

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).

Accessible with the following methods

Method	Description
GET_LASTUPDATEDAT()	Getter for LASTUPDATEDAT, with configurable default
ASK_LASTUPDATEDAT()	Getter for LASTUPDATEDAT w/ exceptions if field has no value
HAS_LASTUPDATEDAT()	Determine if LASTUPDATEDAT has a value

CreatedAt

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).

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

ApplicationArn

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.

Accessible with the following methods

Method	Description
GET_APPLICATIONARN()	Getter for APPLICATIONARN, with configurable default
ASK_APPLICATIONARN()	Getter for APPLICATIONARN w/ exceptions if field has no valu
HAS_APPLICATIONARN()	Determine if APPLICATIONARN has a value

ExportFilesMetadata

Provides details about the stream session's exported files.

Accessible with the following methods

Method	Description
GET_EXPORTFILESMETADATA()	Getter for EXPORTFILESMETADATA