:doc:`KinesisVideo <../../kinesisvideo>` / Client / update_signaling_channel

************************
update_signaling_channel
************************



.. py:method:: KinesisVideo.Client.update_signaling_channel(**kwargs)

  

  Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

   

  If the ``MessageTtlSeconds`` value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous ``MessageTtlSeconds`` value.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannel>`_  


  **Request Syntax**
  ::

    response = client.update_signaling_channel(
        ChannelARN='string',
        CurrentVersion='string',
        SingleMasterConfiguration={
            'MessageTtlSeconds': 123
        }
    )
    
  :type ChannelARN: string
  :param ChannelARN: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the signaling channel that you want to update.

    

  
  :type CurrentVersion: string
  :param CurrentVersion: **[REQUIRED]** 

    The current version of the signaling channel that you want to update.

    

  
  :type SingleMasterConfiguration: dict
  :param SingleMasterConfiguration: 

    The structure containing the configuration for the ``SINGLE_MASTER`` type of the signaling channel that you want to update. This parameter and the channel message's time-to-live are required for channels with the ``SINGLE_MASTER`` channel type.

    

  
    - **MessageTtlSeconds** *(integer) --* 

      The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded. Use to update this value.

      

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`KinesisVideo.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.ClientLimitExceededException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.ResourceInUseException`

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

  
  *   :py:class:`KinesisVideo.Client.exceptions.VersionMismatchException`

  