stream_sessions

Creates, updates, deletes, gets or lists a stream_sessions resource.

Overview

Name	stream_sessions
Type	Resource
Id	aws.ivs.stream_sessions

Fields

The following fields are returned by SELECT queries:

get_stream_session

Name	Datatype	Description
channel	object	Object specifying a channel.
end_time	string (date-time)	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.
ingest_configuration	object	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.
ingest_configurations	object	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).
recording_configuration	object	An object representing a configuration to record a channel stream.
start_time	string (date-time)	Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
stream_id	string	Unique identifier for a live or previously live stream in the specified channel. (pattern: <code>st-[a-zA-Z0-9]+</code>)
truncated_events	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_stream_session	select	region		Gets metadata on a specified stream.
list_stream_sessions	exec	region, channelArn		Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_stream_session

Gets metadata on a specified stream.

SELECT
channel,
end_time,
ingest_configuration,
ingest_configurations,
recording_configuration,
start_time,
stream_id,
truncated_events
FROM aws.ivs.stream_sessions
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

list_stream_sessions

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

EXEC aws.ivs.stream_sessions.list_stream_sessions 
@region='{{ region }}' --required 
@@json=
'{
"channelArn": "{{ channelArn }}", 
"nextToken": "{{ nextToken }}", 
"maxResults": {{ maxResults }}
}'
;