Skip to content

List Channels

ivs_list_channels R Documentation

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed

Description

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Usage

ivs_list_channels(filterByName, filterByPlaybackRestrictionPolicyArn,
  filterByRecordingConfigurationArn, maxResults, nextToken)

Arguments

filterByName

Filters the channel list to match the specified name.
filterByPlaybackRestrictionPolicyArn

Filters the channel list to match the specified policy.
filterByRecordingConfigurationArn

Filters the channel list to match the specified recording-configuration ARN.
maxResults

Maximum number of channels to return. Default: 100.
nextToken

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

Value

A list with the following syntax:

list(
  channels = list(
    list(
      arn = "string",
      authorized = TRUE|FALSE,
      insecureIngest = TRUE|FALSE,
      latencyMode = "NORMAL"|"LOW",
      name = "string",
      playbackRestrictionPolicyArn = "string",
      preset = "HIGHER_BANDWIDTH_DELIVERY"|"CONSTRAINED_BANDWIDTH_DELIVERY",
      recordingConfigurationArn = "string",
      tags = list(
        "string"
      ),
      type = "BASIC"|"STANDARD"|"ADVANCED_SD"|"ADVANCED_HD"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_channels(
  filterByName = "string",
  filterByPlaybackRestrictionPolicyArn = "string",
  filterByRecordingConfigurationArn = "string",
  maxResults = 123,
  nextToken = "string"
)