PutMetadataRequest

PutMetadataRequest schema

Live StreamingMediaVideoReal-Time

Properties

Name Type Description
channelArn object
metadata object
View JSON Schema on GitHub

JSON Schema

ivs-put-metadata-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-put-metadata-request-schema.json",
  "title": "PutMetadataRequest",
  "description": "PutMetadataRequest schema",
  "type": "object",
  "properties": {
    "channelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelArn"
        },
        {
          "description": "ARN of the channel into which metadata is inserted. This channel must have an active stream."
        }
      ]
    },
    "metadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamMetadata"
        },
        {
          "description": "Metadata to insert into the stream. Maximum: 1 KB per request."
        }
      ]
    }
  },
  "required": [
    "channelArn",
    "metadata"
  ]
}