List Compositions

ivsrealtime_list_compositions

R Documentation

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed¶

Description¶

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Usage¶

ivsrealtime_list_compositions(filterByStageArn,
  filterByEncoderConfigurationArn, nextToken, maxResults)

Arguments¶

filterByStageArn

Filters the Composition list to match the specified Stage ARN.

filterByEncoderConfigurationArn

Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

nextToken

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

maxResults

Maximum number of results to return. Default: 100.

Value¶

A list with the following syntax:

list(
  compositions = list(
    list(
      arn = "string",
      stageArn = "string",
      destinations = list(
        list(
          id = "string",
          state = "STARTING"|"ACTIVE"|"STOPPING"|"RECONNECTING"|"FAILED"|"STOPPED",
          startTime = as.POSIXct(
            "2015-01-01"
          ),
          endTime = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      state = "STARTING"|"ACTIVE"|"STOPPING"|"FAILED"|"STOPPED",
      tags = list(
        "string"
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      endTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_compositions(
  filterByStageArn = "string",
  filterByEncoderConfigurationArn = "string",
  nextToken = "string",
  maxResults = 123
)