BatchStartViewerSessionRevocationViewerSessionList

BatchStartViewerSessionRevocationViewerSessionList schema

Live StreamingMediaVideoReal-Time
View JSON Schema on GitHub

JSON Schema

ivs-batch-start-viewer-session-revocation-viewer-session-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-batch-start-viewer-session-revocation-viewer-session-list-schema.json",
  "title": "BatchStartViewerSessionRevocationViewerSessionList",
  "description": "BatchStartViewerSessionRevocationViewerSessionList schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "channelArn",
      "viewerId"
    ],
    "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."
          }
        ]
      }
    },
    "description": "A viewer session to revoke in the call to <a>BatchStartViewerSessionRevocation</a>."
  }
}