:doc:`IVS <../../ivs>` / Client / stop_stream

***********
stop_stream
***********



.. py:method:: 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.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StopStream>`_  


  **Request Syntax**
  ::

    response = client.stop_stream(
        channelArn='string'
    )
    
  :type channelArn: string
  :param channelArn: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`IVS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IVS.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`IVS.Client.exceptions.ValidationException`

  
  *   :py:class:`IVS.Client.exceptions.ChannelNotBroadcasting`

  
  *   :py:class:`IVS.Client.exceptions.StreamUnavailable`

  