Skip to content

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

Description

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

Usage

ivs_list_streams(filterBy, nextToken, maxResults)

Arguments

  • filterBy

    Filters the stream list to match the specified criterion.

  • nextToken

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

  • maxResults

    Maximum number of streams to return. Default: 100.

Value

A list with the following syntax:

list(
  streams = list(
    list(
      channelArn = "string",
      streamId = "string",
      state = "LIVE"|"OFFLINE",
      health = "HEALTHY"|"STARVING"|"UNKNOWN",
      viewerCount = 123,
      startTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_streams(
  filterBy = list(
    health = "HEALTHY"|"STARVING"|"UNKNOWN"
  ),
  nextToken = "string",
  maxResults = 123
)