List Streams

ivs_list_streams

R Documentation

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, maxResults, nextToken)

Arguments

filterBy

Filters the stream list to match the specified criterion.

maxResults

Maximum number of streams to return. Default: 100.

nextToken

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

Value

A list with the following syntax:

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

Request syntax

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