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

************
put_metadata
************



.. py:method:: IVS.Client.put_metadata(**kwargs)

  

  Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see `Embedding Metadata within a Video Stream <https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html>`__ in the *Amazon IVS User Guide*.

  

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


  **Request Syntax**
  ::

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

    ARN of the channel into which metadata is inserted. This channel must have an active stream.

    

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

    Metadata to insert into the stream. Maximum: 1 KB per request.

    

  
  
  :returns: None
  **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.ThrottlingException`

  