Amazon Interactive Video Service · JSON Structure

Ivs Get Stream Session Request Structure

GetStreamSessionRequest schema

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

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

Properties

channelArn streamId

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-get-stream-session-request-structure.json",
  "name": "GetStreamSessionRequest",
  "description": "GetStreamSessionRequest schema",
  "type": "object",
  "properties": {
    "channelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelArn"
        },
        {
          "description": "ARN of the channel resource"
        }
      ]
    },
    "streamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamId"
        },
        {
          "description": "Unique identifier for a live or previously live stream in the specified channel. If no <code>streamId</code> is provided, this returns the most recent stream session for the channel, if it exists."
        }
      ]
    }
  },
  "required": [
    "channelArn"
  ]
}