Amazon Interactive Video Service · JSON Structure

Ivs Put Metadata Request Structure

PutMetadataRequest schema

Type: object Properties: 2 Required: 2
Live StreamingMediaVideoReal-Time

PutMetadataRequest is a JSON Structure definition published by Amazon Interactive Video Service, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

channelArn metadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-structure/ivs-put-metadata-request-structure.json",
  "name": "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"
  ]
}