IVS / Client / delete_channel

delete_channel#

IVS.Client.delete_channel(**kwargs)#

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 StopStream, 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.)

Request Syntax

response = client.delete_channel(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

ARN of the channel to be deleted.

Returns:

None

Exceptions

IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException
IVS.Client.exceptions.PendingVerification
IVS.Client.exceptions.ConflictException