Ivs Stream Session Structure

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

Type: object Properties: 7
Live StreamingMediaVideoReal-Time

StreamSession is a JSON Structure definition published by Amazon Interactive Video Service, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

channel endTime ingestConfiguration recordingConfiguration startTime streamId truncatedEvents

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-stream-session-structure.json",
  "name": "StreamSession",
  "description": "Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.",
  "type": "object",
  "properties": {
    "channel": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Channel"
        },
        {
          "description": "The properties of the channel at the time of going live."
        }
      ]
    },
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>. For live streams, this is <code>NULL</code>."
        }
      ]
    },
    "ingestConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IngestConfiguration"
        },
        {
          "description": "The properties of the incoming RTMP stream for the stream."
        }
      ]
    },
    "recordingConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecordingConfiguration"
        },
        {
          "description": "The properties of recording the live stream."
        }
      ]
    },
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>."
        }
      ]
    },
    "streamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamId"
        },
        {
          "description": "Unique identifier for a live or previously live stream in the specified channel."
        }
      ]
    },
    "truncatedEvents": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamEvents"
        },
        {
          "description": "List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html\">Using Amazon EventBridge with Amazon IVS</a>."
        }
      ]
    }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/ivs-stream-session-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.