Get Channel

ivs_get_channel

R Documentation

Gets the channel configuration for the specified channel ARN

Description

Gets the channel configuration for the specified channel ARN. See also batch_get_channel.

Usage

ivs_get_channel(arn)

Arguments

arn

[required] ARN of the channel for which the configuration is to be retrieved.

Value

A list with the following syntax:

list(
  channel = list(
    arn = "string",
    name = "string",
    latencyMode = "NORMAL"|"LOW",
    type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD",
    recordingConfigurationArn = "string",
    ingestEndpoint = "string",
    playbackUrl = "string",
    authorized = TRUE|FALSE,
    tags = list(
      "string"
    ),
    insecureIngest = TRUE|FALSE,
    preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
    srt = list(
      endpoint = "string",
      passphrase = "string"
    ),
    playbackRestrictionPolicyArn = "string"
  )
)

Request syntax

svc$get_channel(
  arn = "string"
)