Amazon Interactive Video Service · JSON Structure

Ivs Start Viewer Session Revocation Request Structure

StartViewerSessionRevocationRequest schema

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

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

Properties

channelArn viewerId viewerSessionVersionsLessThanOrEqualTo

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-start-viewer-session-revocation-request-structure.json",
  "name": "StartViewerSessionRevocationRequest",
  "description": "StartViewerSessionRevocationRequest schema",
  "type": "object",
  "properties": {
    "channelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelArn"
        },
        {
          "description": "The ARN of the channel associated with the viewer session to revoke."
        }
      ]
    },
    "viewerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ViewerId"
        },
        {
          "description": "The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information."
        }
      ]
    },
    "viewerSessionVersionsLessThanOrEqualTo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ViewerSessionVersion"
        },
        {
          "description": "An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0."
        }
      ]
    }
  },
  "required": [
    "channelArn",
    "viewerId"
  ]
}