Create Recording Configuration

ivs_create_recording_configuration

R Documentation

Creates a new recording configuration, used to enable recording to Amazon S3

Description

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Usage

ivs_create_recording_configuration(name, destinationConfiguration, tags,
  thumbnailConfiguration, recordingReconnectWindowSeconds,
  renditionConfiguration)

Arguments

name

Recording-configuration name. The value does not need to be unique.

destinationConfiguration

[required] A complex type that contains a destination configuration for where recorded video will be stored.

tags

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

thumbnailConfiguration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

recordingReconnectWindowSeconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

renditionConfiguration

Object that describes which renditions should be recorded for a stream.

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$create_recording_configuration(
  name = "string",
  destinationConfiguration = list(
    s3 = list(
      bucketName = "string"
    )
  ),
  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"
    )
  )
)