List Stream Sessions

ivs_list_stream_sessions

R Documentation

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed¶

Description¶

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Usage¶

ivs_list_stream_sessions(channelArn, nextToken, maxResults)

Arguments¶

channelArn: [required] Channel ARN used to filter the list.
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(
  streamSessions = list(
    list(
      streamId = "string",
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      hasErrorEvent = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_stream_sessions(
  channelArn = "string",
  nextToken = "string",
  maxResults = 123
)