Ivs Batch Start Viewer Session Revocation Error Structure

Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.

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

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

Properties

channelArn code message viewerId

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-batch-start-viewer-session-revocation-error-structure.json",
  "name": "BatchStartViewerSessionRevocationError",
  "description": "Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.",
  "type": "object",
  "properties": {
    "channelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelArn"
        },
        {
          "description": "Channel ARN."
        }
      ]
    },
    "code": {
      "allOf": [
        {
          "$ref": "#/components/schemas/errorCode"
        },
        {
          "description": "Error code."
        }
      ]
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/errorMessage"
        },
        {
          "description": "Error message, determined by the application."
        }
      ]
    },
    "viewerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ViewerId"
        },
        {
          "description": "The ID of the viewer session to revoke."
        }
      ]
    }
  },
  "required": [
    "channelArn",
    "viewerId"
  ]
}