Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

stop_stream

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.

See also: AWS API Documentation

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