Ivs Batch Start Viewer Session Revocation Errors Structure

BatchStartViewerSessionRevocationErrors schema

Type: array Properties: 0
Live StreamingMediaVideoReal-Time

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

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-errors-structure.json",
  "name": "BatchStartViewerSessionRevocationErrors",
  "description": "BatchStartViewerSessionRevocationErrors schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "channelArn",
      "viewerId"
    ],
    "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."
          }
        ]
      }
    },
    "description": "Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair."
  }
}