StreamSession

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

channel

The properties of the channel at the time of going live.

Type: Channel object

Required: No

endTime

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

Type: Timestamp

Required: No

ingestConfiguration

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (Track0) and ingestConfigurations contains data for all tracks.

Type: IngestConfiguration object

Required: No

ingestConfigurations

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for Track0 (the sole track).

Type: IngestConfigurations object

Required: No

recordingConfiguration

The properties of recording the live stream.

Type: RecordingConfiguration object

Required: No

startTime

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

Type: Timestamp

Required: No

streamId

Unique identifier for a live or previously live stream in the specified channel.

Type: String

Length Constraints: Fixed length of 26.

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

Required: No

truncatedEvents

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

Type: Array of StreamEvent objects

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Required: No

StreamSession

Contents

See Also