StreamSessionSummary - Amazon GameLift Streams
ContentsSee Also

StreamSessionSummary

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

Contents

Note

In the following list, the required parameters are described first.

ApplicationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)

Required: No

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

Type: Timestamp

Required: No

ExportFilesMetadata

Provides details about the stream session's exported files.

Type: ExportFilesMetadata object

Required: No

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

Type: Timestamp

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: [a-zA-Z0-9-]+

Required: No

Protocol

The data transfer protocol in use with the stream session.

Type: String

Valid Values: WebRTC

Required: No

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

Type: String

Valid Values: ACTIVATING | ACTIVE | CONNECTED | PENDING_CLIENT_RECONNECTION | RECONNECTING | TERMINATING | TERMINATED | ERROR

Required: No

UserId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [-_a-zA-Z0-9/=+]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: