Skip to content

Get Recording Configuration

ivs_get_recording_configuration R Documentation

Gets the recording configuration for the specified ARN

Description

Gets the recording configuration for the specified ARN.

Usage

ivs_get_recording_configuration(arn)

Arguments

arn

[required] ARN of the recording configuration to be retrieved.

Value

A list with the following syntax:

list(
  recordingConfiguration = list(
    arn = "string",
    name = "string",
    destinationConfiguration = list(
      s3 = list(
        bucketName = "string"
      )
    ),
    state = "CREATING"|"CREATE_FAILED"|"ACTIVE",
    tags = list(
      "string"
    ),
    thumbnailConfiguration = list(
      recordingMode = "DISABLED"|"INTERVAL",
      targetIntervalSeconds = 123,
      resolution = "SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION",
      storage = list(
        "SEQUENTIAL"|"LATEST"
      )
    ),
    recordingReconnectWindowSeconds = 123,
    renditionConfiguration = list(
      renditionSelection = "ALL"|"NONE"|"CUSTOM",
      renditions = list(
        "SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION"
      )
    )
  )
)

Request syntax

svc$get_recording_configuration(
  arn = "string"
)