List Participant Replicas

ivsrealtime_list_participant_replicas

R Documentation

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

Description¶

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

Usage¶

ivsrealtime_list_participant_replicas(sourceStageArn, participantId,
  nextToken, maxResults)

Arguments¶

sourceStageArn

[required] ARN of the stage where the participant is publishing.

participantId

[required] Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by create_participant_token or the jti (JWT ID) used to create a self signed token.

nextToken

The first participant to retrieve. This is used for pagination; see the nextToken response field.

maxResults

Maximum number of results to return. Default: 50.

Value¶

A list with the following syntax:

list(
  replicas = list(
    list(
      sourceStageArn = "string",
      participantId = "string",
      sourceSessionId = "string",
      destinationStageArn = "string",
      destinationSessionId = "string",
      replicationState = "ACTIVE"|"STOPPED"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_participant_replicas(
  sourceStageArn = "string",
  participantId = "string",
  nextToken = "string",
  maxResults = 123
)