participant_replicas

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

Overview

Name	participant_replicas
Type	Resource
Id	aws.ivs_realtime.participant_replicas

Fields

The following fields are returned by SELECT queries:

list_participant_replicas

Name	Datatype	Description
destination_session_id	string	ID of the session within the destination stage. (pattern: <code>st-[a-zA-Z0-9]+</code>)
destination_stage_arn	string	ARN of the stage where the participant is replicated. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+</code>)
participant_id	string	Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token. (pattern: <code>[a-zA-Z0-9-]*</code>)
replication_state	string	Replica’s current replication state. (ACTIVE, STOPPED)
source_session_id	string	ID of the session within the source stage. (pattern: <code>st-[a-zA-Z0-9]+</code>)
source_stage_arn	string	ARN of the stage from which this participant is replicated. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_participant_replicas	select	region		Lists all the replicas for a participant from a source 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

list_participant_replicas

Lists all the replicas for a participant from a source stage.

SELECT
destination_session_id,
destination_stage_arn,
participant_id,
replication_state,
source_session_id,
source_stage_arn
FROM aws.ivs_realtime.participant_replicas
WHERE region = '{{ region }}' -- required
;