Stream

An Amazon Kinesis Video Stream.

IoTMachine LearningMediaVideo Streaming

Properties

Name Type Description
StreamName string The name of the stream.
StreamARN string The Amazon Resource Name (ARN) of the stream.
Status string The status of the stream.
DataRetentionInHours integer How long the channel retains data (in hours).
CreationTime string When the stream was created.
View JSON Schema on GitHub

JSON Schema

amazon-kinesis-video-streams-stream-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-kinesis-video-streams/refs/heads/main/json-schema/amazon-kinesis-video-streams-stream-schema.json",
  "title": "Stream",
  "description": "An Amazon Kinesis Video Stream.",
  "type": "object",
  "properties": {
    "StreamName": {
      "type": "string",
      "description": "The name of the stream.",
      "example": "my-video-stream"
    },
    "StreamARN": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the stream."
    },
    "Status": {
      "type": "string",
      "description": "The status of the stream.",
      "example": "ACTIVE",
      "enum": [
        "CREATING",
        "ACTIVE",
        "UPDATING",
        "DELETING"
      ]
    },
    "DataRetentionInHours": {
      "type": "integer",
      "description": "How long the channel retains data (in hours).",
      "example": 24
    },
    "CreationTime": {
      "type": "string",
      "description": "When the stream was created.",
      "format": "date-time"
    }
  }
}