Amazon Kinesis Video Streams · JSON Structure

Amazon Kinesis Video Streams Channel Structure

An Amazon Kinesis Video Streams signaling channel for WebRTC.

Type: object Properties: 5
IoTMachine LearningMediaVideo Streaming

Channel is a JSON Structure definition published by Amazon Kinesis Video Streams, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ChannelName ChannelARN ChannelType ChannelStatus CreationTime

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-kinesis-video-streams/refs/heads/main/json-structure/amazon-kinesis-video-streams-channel-structure.json",
  "name": "Channel",
  "description": "An Amazon Kinesis Video Streams signaling channel for WebRTC.",
  "type": "object",
  "properties": {
    "ChannelName": {
      "type": "string",
      "description": "The name of the signaling channel.",
      "example": "my-webrtc-channel"
    },
    "ChannelARN": {
      "type": "string",
      "description": "The ARN of the signaling channel."
    },
    "ChannelType": {
      "type": "string",
      "description": "The type of the signaling channel.",
      "example": "SINGLE_MASTER",
      "enum": [
        "SINGLE_MASTER",
        "FULL_MESH"
      ]
    },
    "ChannelStatus": {
      "type": "string",
      "description": "The status of the signaling channel.",
      "example": "ACTIVE",
      "enum": [
        "CREATING",
        "ACTIVE",
        "UPDATING",
        "DELETING"
      ]
    },
    "CreationTime": {
      "type": "datetime",
      "description": "When the channel was created."
    }
  }
}