IVS / Client / stop_stream

stop_stream#

IVS.Client.stop_stream(**kwargs)#

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Note

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Request Syntax

response = client.stop_stream(
    channelArn='string'
)

Parameters:

channelArn (string) –

[REQUIRED]

ARN of the channel for which the stream is to be stopped.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException
IVS.Client.exceptions.ChannelNotBroadcasting
IVS.Client.exceptions.StreamUnavailable