Skip to content

Deletes the specified channel and its associated stream keys

Description

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call stop_stream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Usage

ivs_delete_channel(arn)

Arguments

  • arn

    [required] ARN of the channel to be deleted.

Value

An empty list.

Request syntax

svc$delete_channel(
  arn = "string"
)