Class: Aws::GameLiftStreams::Types::StreamSessionSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLiftStreams::Types::StreamSessionSummary
- Defined in:
- gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb
Overview
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_arn ⇒ String
An [Amazon Resource Name (ARN)][1] that uniquely identifies the application resource.
-
#arn ⇒ String
An [Amazon Resource Name (ARN)][1] that uniquely identifies the stream session resource.
-
#created_at ⇒ Time
A timestamp that indicates when this resource was created.
-
#export_files_metadata ⇒ Types::ExportFilesMetadata
Provides details about the stream session's exported files.
-
#last_updated_at ⇒ Time
A timestamp that indicates when this resource was last updated.
-
#location ⇒ String
The location where Amazon GameLift Streams hosts and streams your application.
-
#protocol ⇒ String
The data transfer protocol in use with the stream session.
-
#status ⇒ String
The current status of the stream session resource.
-
#user_id ⇒ String
An opaque, unique identifier for an end-user, defined by the developer.
Instance Attribute Details
#application_arn ⇒ String
An Amazon Resource Name (ARN) that uniquely identifies the
application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ 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
.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
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).
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#export_files_metadata ⇒ Types::ExportFilesMetadata
Provides details about the stream session's exported files.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#last_updated_at ⇒ Time
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).
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#location ⇒ 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.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#protocol ⇒ String
The data transfer protocol in use with the stream session.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
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 hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
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 bySessionLengthSeconds
inStartStreamSession
is exceeded.ERROR
: The stream session failed to activate. SeeStatusReason
(returned byGetStreamSession
andStartStreamSession
) for more information.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_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 inPENDING_CLIENT_RECONNECTION
state.TERMINATING
: The stream session is ending.TERMINATED
: The stream session has ended.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |
#user_id ⇒ String
An opaque, unique identifier for an end-user, defined by the developer.
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 |
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 3046 class StreamSessionSummary < Struct.new( :arn, :user_id, :status, :protocol, :last_updated_at, :created_at, :application_arn, :export_files_metadata, :location) SENSITIVE = [] include Aws::Structure end |