Skip to content

/AWS1/CL_GMZSTREAMSESSSUMMARY

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/GMZARN /AWS1/GMZARN

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.

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

iv_protocol TYPE /AWS1/GMZPROTOCOL /AWS1/GMZPROTOCOL

The data transfer protocol in use with the stream session.

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

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.

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.

Queryable Attributes

Arn

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.

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

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

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

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

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

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

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

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_STREAMSESSIONSUMMARYLIST

TYPES TT_STREAMSESSIONSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMZSTREAMSESSSUMMARY WITH DEFAULT KEY
.