stage_sessions

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

Overview

Name	stage_sessions
Type	Resource
Id	aws.ivs_realtime.stage_sessions

Fields

The following fields are returned by SELECT queries:

get_stage_session

Name	Datatype	Description
end_time	string (date-time)	ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
session_id	string	ID of the session within the stage. (pattern: <code>st-[a-zA-Z0-9]+</code>)
start_time	string (date-time)	ISO 8601 timestamp (returned as a string) when this stage session began.

list_stage_sessions

Name	Datatype	Description
next_token	string	If there are more stage sessions than maxResults, use nextToken in the request to get the next set. (pattern: <code>[a-zA-Z0-9+/=_-]*</code>)
stage_sessions	array	List of matching stage sessions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_stage_session	select	region		Gets information for the specified stage session.
list_stage_sessions	select	region		Gets all sessions for a specified stage.

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_stage_session

Gets information for the specified stage session.

SELECT
end_time,
session_id,
start_time
FROM aws.ivs_realtime.stage_sessions
WHERE region = '{{ region }}' -- required
;

list_stage_sessions

Gets all sessions for a specified stage.

SELECT
next_token,
stage_sessions
FROM aws.ivs_realtime.stage_sessions
WHERE region = '{{ region }}' -- required
;