Skip to content

Create Stream Key

ivs_create_stream_key R Documentation

Creates a stream key, used to initiate a stream, for the specified channel ARN

Description

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that create_channel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use delete_stream_key and then CreateStreamKey.

Usage

ivs_create_stream_key(channelArn, tags)

Arguments

channelArn

[required] ARN of the channel for which to create the stream key.

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.

Value

A list with the following syntax:

list(
  streamKey = list(
    arn = "string",
    value = "string",
    channelArn = "string",
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$create_stream_key(
  channelArn = "string",
  tags = list(
    "string"
  )
)