List Participant Replicas

ivs_realtime.list_participant_replicas
ActionAmazon Web Servicesconnection required

Calls the AWS ivs_realtime API (SigV4).

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

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Amazon Interactive Video Service RealTime
Secret shape
{"access_key_id", "secret_access_key"}
Config it needs
region
Resolved by
config.connection_id, else node.connection_id

Configuration

3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
region
AWS region (overrides the connection).
stringNo———
source_stage_arn
ARN of the stage where the participant is publishing.
stringYes———
participant_id
Participant ID of the publisher that has been replicated. This is assigned by IVS and retu
stringYes———

Output

One shape.

result

FieldTypeExample
replicas
array—
nextToken
string—
{
  "nextToken": "",
  "replicas": []
}

Related Amazon Interactive Video Service RealTime nodes

See List Participant Replicas run in a workflow.

In a technical demo we add the Amazon Interactive Video Service RealTime connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.