List Ingest Configurations

ivsrealtime_list_ingest_configurations

R Documentation

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed¶

Description¶

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

Usage¶

ivsrealtime_list_ingest_configurations(filterByStageArn, filterByState,
  nextToken, maxResults)

Arguments¶

filterByStageArn: Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
filterByState: Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
nextToken: The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.
maxResults: Maximum number of results to return. Default: 50.

Value¶

A list with the following syntax:

list(
  ingestConfigurations = list(
    list(
      name = "string",
      arn = "string",
      ingestProtocol = "RTMP"|"RTMPS",
      stageArn = "string",
      participantId = "string",
      state = "ACTIVE"|"INACTIVE",
      userId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_ingest_configurations(
  filterByStageArn = "string",
  filterByState = "ACTIVE"|"INACTIVE",
  nextToken = "string",
  maxResults = 123
)