Ivs Stream Event Structure

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

Type: object Properties: 3
Live StreamingMediaVideoReal-Time

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

Properties

eventTime name type

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-event-structure.json",
  "name": "StreamEvent",
  "description": "Object specifying a stream\u2019s events. For a list of events, see <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html\">Using Amazon EventBridge with Amazon IVS</a>.",
  "type": "object",
  "properties": {
    "eventTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "Time when the event occurred. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Name that identifies the stream event within a <code>type</code>."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Logical group for certain events."
        }
      ]
    }
  }
}