Skip to content

Get Stage

ivsrealtime_get_stage R Documentation

Gets information for the specified stage

Description

Gets information for the specified stage.

Usage

ivsrealtime_get_stage(arn)

Arguments

arn

[required] ARN of the stage for which the information is to be retrieved.

Value

A list with the following syntax:

list(
  stage = list(
    arn = "string",
    name = "string",
    activeSessionId = "string",
    tags = list(
      "string"
    ),
    autoParticipantRecordingConfiguration = list(
      storageConfigurationArn = "string",
      mediaTypes = list(
        "AUDIO_VIDEO"|"AUDIO_ONLY"
      )
    ),
    endpoints = list(
      events = "string",
      whip = "string"
    )
  )
)

Request syntax

svc$get_stage(
  arn = "string"
)