IVS / Client / put_metadata

put_metadata#

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 in the Amazon IVS User Guide.

See also: AWS API Documentation

Request Syntax

response = client.put_metadata(
    channelArn='string',
    metadata='string'
)
Parameters:

  • channelArn (string) –

    [REQUIRED]

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

  • metadata (string) –

    [REQUIRED]

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

Returns:

None

Exceptions

  • IVS.Client.exceptions.ResourceNotFoundException

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.ChannelNotBroadcasting

  • IVS.Client.exceptions.ThrottlingException